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 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 and Description
protected static String	COMMS_ERROR_UEI
static String	SKIP_CLOSE_WHEN_NOT_CLEARED_SYS_PROP
static String	SKIP_CREATE_WHEN_CLEARED_SYS_PROP

Constructor Summary

Constructors

Constructor and Description
DefaultTicketerServiceLayer()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Spring functionality implemented to validate the state of the trouble ticket plugin API.
void	cancelTicketForAlarm(int alarmId, String ticketId) Implement to manage canceling of tickets through registered plugin.
void	closeTicketForAlarm(int alarmId, String ticketId) Implement to manage closing of tickets through registered plugin.
void	createTicketForAlarm(int alarmId, Map<String,String> attributes) Implement to manage creation of tickets through registered plugin.
protected Ticket	createTicketFromAlarm(OnmsAlarm alarm, Map<String,String> attributes) Called from API implemented method after successful retrieval of Alarm.
EventIpcManager	getEventIpcManager() getEventIpcManager
void	reloadTicketer() Implement to reload ticketer when requested.
void	setAlarmDao(AlarmDao alarmDao) Needs access to the AlarmDao.
void	setEventIpcManager(EventIpcManager ipcManager) setEventIpcManager
void	setTicketerPlugin(Plugin plugin) Set the ticketer plugin.
void	updateTicketForAlarm(int alarmId, String ticketId) Implement to manage updating of tickets through registered plugin.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMMS_ERROR_UEI

protected static final String COMMS_ERROR_UEI

See Also:

Constant Field Values

SKIP_CREATE_WHEN_CLEARED_SYS_PROP

public static final String SKIP_CREATE_WHEN_CLEARED_SYS_PROP

See Also:

Constant Field Values

SKIP_CLOSE_WHEN_NOT_CLEARED_SYS_PROP

public static final String SKIP_CLOSE_WHEN_NOT_CLEARED_SYS_PROP

See Also:

Constant Field Values

Constructor Detail

DefaultTicketerServiceLayer

public DefaultTicketerServiceLayer()

Method Detail

setAlarmDao

public void setAlarmDao(AlarmDao alarmDao)

Needs access to the AlarmDao.

Parameters:

alarmDao - a AlarmDao object.

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Spring functionality implemented to validate the state of the trouble ticket plugin API.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception - if any.

cancelTicketForAlarm

public void cancelTicketForAlarm(int alarmId,
                                 String ticketId)

Implement to manage canceling of tickets through registered plugin.

Specified by:

cancelTicketForAlarm in interface TicketerServiceLayer

Parameters:

alarmId - a int.

ticketId - a String object.

closeTicketForAlarm

public void closeTicketForAlarm(int alarmId,
                                String ticketId)

Implement to manage closing of tickets through registered plugin.

Specified by:

closeTicketForAlarm in interface TicketerServiceLayer

Parameters:

alarmId - a int.

ticketId - a String object.

createTicketForAlarm

public void createTicketForAlarm(int alarmId,
                                 Map<String,String> attributes)

Implement to manage creation of tickets through registered plugin.

Specified by:

createTicketForAlarm in interface TicketerServiceLayer

Parameters:

alarmId - a int.

createTicketFromAlarm

protected Ticket createTicketFromAlarm(OnmsAlarm alarm,
                                       Map<String,String> attributes)

Called from API implemented method after successful retrieval of Alarm.

Parameters:

alarm - OpenNMS Model class alarm

attributes -

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

public void updateTicketForAlarm(int alarmId,
                                 String ticketId)

Implement to manage updating of tickets through registered plugin.

Specified by:

updateTicketForAlarm in interface TicketerServiceLayer

Parameters:

alarmId - a int.

ticketId - a String object.

reloadTicketer

public void reloadTicketer()

Implement to reload ticketer when requested.

Specified by:

reloadTicketer in interface TicketerServiceLayer

getEventIpcManager

public EventIpcManager getEventIpcManager()

getEventIpcManager

Returns:

a EventIpcManager object.

setEventIpcManager

public void setEventIpcManager(EventIpcManager ipcManager)

setEventIpcManager

Parameters:

ipcManager - a EventIpcManager object.

setTicketerPlugin

public void setTicketerPlugin(Plugin plugin)

Set the ticketer plugin.

Specified by:

setTicketerPlugin in interface TicketerServiceLayer