Package org.opennms.netmgt.ticketd
Class DefaultTicketerServiceLayer
- java.lang.Object
-
- org.opennms.netmgt.ticketd.DefaultTicketerServiceLayer
-
- All Implemented Interfaces:
TicketerServiceLayer
,org.springframework.beans.factory.InitializingBean
- Direct Known Subclasses:
DroolsTicketerServiceLayer
public class DefaultTicketerServiceLayer extends java.lang.Object implements TicketerServiceLayer, org.springframework.beans.factory.InitializingBean
OpenNMS Trouble Ticket API implementation.- Author:
- Mathew Brozowski, David Hustace
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.String
COMMS_ERROR_UEI
static java.lang.String
SKIP_CLOSE_WHEN_NOT_CLEARED_SYS_PROP
static java.lang.String
SKIP_CREATE_WHEN_CLEARED_SYS_PROP
-
Constructor Summary
Constructors Constructor Description DefaultTicketerServiceLayer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
afterPropertiesSet()
Spring functionality implemented to validate the state of the trouble ticket plugin API.void
cancelTicketForAlarm(int alarmId, java.lang.String ticketId)
Implement to manage canceling of tickets through registered plugin.void
closeTicketForAlarm(int alarmId, java.lang.String ticketId)
Implement to manage closing of tickets through registered plugin.void
createTicketForAlarm(int alarmId, java.util.Map<java.lang.String,java.lang.String> attributes)
Implement to manage creation of tickets through registered plugin.protected Ticket
createTicketFromAlarm(OnmsAlarm alarm, java.util.Map<java.lang.String,java.lang.String> attributes)
Called from API implemented method after successful retrieval of Alarm.EventIpcManager
getEventIpcManager()
getEventIpcManagervoid
reloadTicketer()
Implement to reload ticketer when requested.void
setAlarmDao(AlarmDao alarmDao)
Needs access to the AlarmDao.void
setAlarmEntityNotifier(AlarmEntityNotifier alarmEntityNotifier)
void
setEventIpcManager(EventIpcManager ipcManager)
setEventIpcManagervoid
setTicketerPlugin(Plugin plugin)
Set the ticketer plugin.void
updateTicketForAlarm(int alarmId, java.lang.String ticketId)
Implement to manage updating of tickets through registered plugin.
-
-
-
Field Detail
-
COMMS_ERROR_UEI
protected static final java.lang.String COMMS_ERROR_UEI
- See Also:
- Constant Field Values
-
SKIP_CREATE_WHEN_CLEARED_SYS_PROP
public static final java.lang.String SKIP_CREATE_WHEN_CLEARED_SYS_PROP
- See Also:
- Constant Field Values
-
SKIP_CLOSE_WHEN_NOT_CLEARED_SYS_PROP
public static final java.lang.String SKIP_CLOSE_WHEN_NOT_CLEARED_SYS_PROP
- See Also:
- Constant Field Values
-
-
Method Detail
-
setAlarmDao
public void setAlarmDao(AlarmDao alarmDao)
Needs access to the AlarmDao.- Parameters:
alarmDao
- aAlarmDao
object.
-
afterPropertiesSet
public void afterPropertiesSet() throws java.lang.Exception
Spring functionality implemented to validate the state of the trouble ticket plugin API.- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
- Throws:
java.lang.Exception
- if any.
-
cancelTicketForAlarm
@Transactional public void cancelTicketForAlarm(int alarmId, java.lang.String ticketId)
Implement to manage canceling of tickets through registered plugin.- Specified by:
cancelTicketForAlarm
in interfaceTicketerServiceLayer
- Parameters:
alarmId
- a int.ticketId
- aString
object.
-
closeTicketForAlarm
@Transactional public void closeTicketForAlarm(int alarmId, java.lang.String ticketId)
Implement to manage closing of tickets through registered plugin.- Specified by:
closeTicketForAlarm
in interfaceTicketerServiceLayer
- Parameters:
alarmId
- a int.ticketId
- aString
object.
-
createTicketForAlarm
@Transactional public void createTicketForAlarm(int alarmId, java.util.Map<java.lang.String,java.lang.String> attributes)
Implement to manage creation of tickets through registered plugin.- Specified by:
createTicketForAlarm
in interfaceTicketerServiceLayer
- Parameters:
alarmId
- a int.
-
createTicketFromAlarm
protected Ticket createTicketFromAlarm(OnmsAlarm alarm, java.util.Map<java.lang.String,java.lang.String> attributes)
Called from API implemented method after successful retrieval of Alarm.- Parameters:
alarm
- OpenNMS Model class alarmattributes
-- Returns:
- OpenNMS Ticket with contents of alarm. TODO: Add alarm attributes to Ticket. TODO: Add alarmid to Ticket class for ability to reference back to Alarm (waffling on this since ticket isn't a persisted object and other reasons)
-
updateTicketForAlarm
@Transactional public void updateTicketForAlarm(int alarmId, java.lang.String ticketId)
Implement to manage updating of tickets through registered plugin.- Specified by:
updateTicketForAlarm
in interfaceTicketerServiceLayer
- Parameters:
alarmId
- a int.ticketId
- aString
object.
-
reloadTicketer
public void reloadTicketer()
Implement to reload ticketer when requested.- Specified by:
reloadTicketer
in interfaceTicketerServiceLayer
-
getEventIpcManager
public EventIpcManager getEventIpcManager()
getEventIpcManager
- Returns:
- a
EventIpcManager
object.
-
setEventIpcManager
public void setEventIpcManager(EventIpcManager ipcManager)
setEventIpcManager
- Parameters:
ipcManager
- aEventIpcManager
object.
-
setTicketerPlugin
public void setTicketerPlugin(Plugin plugin)
Set the ticketer plugin.- Specified by:
setTicketerPlugin
in interfaceTicketerServiceLayer
-
setAlarmEntityNotifier
public void setAlarmEntityNotifier(AlarmEntityNotifier alarmEntityNotifier)
-
-