org.opennms.netmgt.ticketer.rt

Class RtTicketerPlugin

java.lang.Object

org.opennms.netmgt.ticketer.rt.RtTicketerPlugin

All Implemented Interfaces:

Plugin

public class RtTicketerPlugin
extends Object
implements Plugin

OpenNMS Trouble Ticket Plugin API implementation for RT

Author:

Jonathan Sartin, Benjamin Reed

Constructor Summary

Constructors

Constructor and Description
RtTicketerPlugin() Constructor for RtTicketerPlugin.

Method Summary

Modifier and Type	Method and Description
Ticket	get(String ticketId) DAO like get method to be implemented by HelpDesk specific plugin.
String	openNMSToRTState(Ticket.State state) Convenience method for converting OpenNMS enumerated ticket states to RT status.
Ticket.State	rtToOpenNMSState(String rtStatus) Convenience method for converting RT ticket Status to OpenNMS enumerated ticket states.
void	saveOrUpdate(Ticket newTicket) DAO like saveOrUpdate method to be implemented by HelpDesk specific plugin.
void	setPassword(String password) setPassword
void	setUser(String user) setUser

Methods inherited from class java.lang.Object

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

Constructor Detail

RtTicketerPlugin

public RtTicketerPlugin()

Constructor for RtTicketerPlugin.

Method Detail

get

public Ticket get(String ticketId)
           throws PluginException

DAO like get method to be implemented by HelpDesk specific plugin. Gets ticket details from the RT trouble ticket system

Specified by:

get in interface Plugin

Parameters:

ticketId - a String object.

Returns:

a Ticket object.

Throws:

PluginException - if any.

saveOrUpdate

public void saveOrUpdate(Ticket newTicket)
                  throws PluginException

DAO like saveOrUpdate method to be implemented by HelpDesk specific plugin. Creates a new ticket (if none exists) or updates an existing ticket in the RT trouble ticket system. Ticket updates are currently limited to updating the ticket status only.

Specified by:

saveOrUpdate in interface Plugin

Parameters:

newTicket - a Ticket object.

Throws:

PluginException - if any.

openNMSToRTState

public String openNMSToRTState(Ticket.State state)

Convenience method for converting OpenNMS enumerated ticket states to RT status.

Parameters:

state - a valid org.opennms.netmgt.ticketd.Ticket.State.

Returns:

a String representing the RT Status of the ticket.

rtToOpenNMSState

public Ticket.State rtToOpenNMSState(String rtStatus)

Convenience method for converting RT ticket Status to OpenNMS enumerated ticket states.

Parameters:

rtStatus - a valid RT status string

Returns:

the converted org.opennms.netmgt.ticketd.Ticket.State

setUser

public void setUser(String user)

setUser

Parameters:

user - a String object.

setPassword

public void setPassword(String password)

setPassword

Parameters:

password - a String object.