com.egurkha.tt
Class EgTTIntegration

java.lang.Object
  |
  +--com.egurkha.tt.EgTTUtils
        |
        +--com.egurkha.tt.EgTTIntegration

public abstract class EgTTIntegration

extends com.egurkha.tt.EgTTUtils

This class should be subclassed by the classes that will act as interface between eGurkha and other trouble ticket System.

Since:

eGurkha 2.2

Author:

Baddrinath M

Fields inherited from class com.egurkha.tt.EgTTUtils

ALARM_ID_INDEX, alarm_pref, allCurrAlarms, allPrevAlarms, COMPONENT_NAME_INDEX, COMPONENT_TYPE_INDEX, confInfo, confPropNames, confPropValues, deleteInvalidAlarm, DESC_INDEX, egSystemNameProps, idMappings, isConnected, PRIORITY_INDEX, SHORT_DESC_INDEX, statusMapping, SUBMITTED_BY_INDEX

Constructor Summary

EgTTIntegration()

Method Summary

abstract boolean	egConnect() This method implementation should set the isConnected flag to true if it does a connect to the thrid party application
abstract void	egCreateTroubleTicket(java.util.ArrayList[] alarm, java.util.ArrayList alarmFields) This method should use the alarm and third party application configuration properties that it gets to create trouble tickets in the third party system.
abstract void	egDeleteTroubleTicket(java.lang.String[] ttId)
abstract boolean	egDisconnect() This method should check the isConnected flag and if the flag is set to true then it should do a disconnect from the third party application
abstract java.lang.String[]	egGetTroubleTicketStatus(java.lang.String[] ttID) This method gets one or more trouble ticket ids for which it should find the status and return.
abstract boolean	egNotifyTTCreated(java.lang.String[] tt_id) This method should be implemented to send notification to the trouble ticketing system when a new trouble ticket is created.
abstract boolean	egNotifyTTUpdated(java.lang.String[] tt_id) This method should be implemented to send notification to the trouble ticketing system when a trouble ticket is updated.
abstract void	egUpdateTroubleTicket(java.util.ArrayList[] alarm, java.util.ArrayList alarmFields) This method should use the one or more alarm and third party application configuration properties that it gets to update trouble tickets in the third party system.
void	logToErrorFile(java.lang.String entity, java.lang.String message) Errors will be logged in error_log file which will be in egurkhahome/manager/logs directory

Methods inherited from class com.egurkha.tt.EgTTUtils

egGetAllNewAlarms, egGetEgFieldNames, egGetSystemStatusValue, egGetTroubleTicketId, egGetTTFieldNames, egInit, egRemoveAlarms, egSaveIdMapps, egSetAllCurrAlarms, egTerminate, egUpdateIdMappings, getModifiedPriorAlarms, reloadIdMappings

Methods inherited from class java.lang.Object

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

Constructor Detail

EgTTIntegration

public EgTTIntegration()

Method Detail

egConnect

public abstract boolean egConnect()

This method implementation should set the isConnected flag to true if it does a connect to the thrid party application

egDisconnect

public abstract boolean egDisconnect()

This method should check the isConnected flag and if the flag is set to true then it should do a disconnect from the third party application

egCreateTroubleTicket

public abstract void egCreateTroubleTicket(java.util.ArrayList[] alarm,
                                           java.util.ArrayList alarmFields)

This method should use the alarm and third party application configuration properties that it gets to create trouble tickets in the third party system. Each element in the array of alarm comprises of an alarm and each alarm contains values of the alarm fields. The argument alarmFields contains the field names. The first field is always the alarm id generated in the eGurkha system. The subsequent fields are the fields that are in the trouble ticketing system. The argument confPropNames contains the properties needed by the trouble tickeing system and the argument confPropValues contains the values of the corresponding properties. After creating the trouble ticket, this method must call egUpdateIdMappings(String alarm_id,String tt_id) with the alarm id and the corresponding trouble ticket id.

egUpdateTroubleTicket

public abstract void egUpdateTroubleTicket(java.util.ArrayList[] alarm,
                                           java.util.ArrayList alarmFields)

This method should use the one or more alarm and third party application configuration properties that it gets to update trouble tickets in the third party system. Each element in the array of alarm comprises of an alarm and each alarm contains values of the alarm fields. The argument alarmFields contains the field names. The first field is always the alarm id generated in the eGurkha system. The subsequent fields are the fields that are in the trouble ticketing system. The argument confPropNames contains the properties needed by the trouble tickeing system and the argument confPropValues contains the values of the corresponding properties.

egGetTroubleTicketStatus

public abstract java.lang.String[] egGetTroubleTicketStatus(java.lang.String[] ttID)

This method gets one or more trouble ticket ids for which it should find the status and return.

egDeleteTroubleTicket

public abstract void egDeleteTroubleTicket(java.lang.String[] ttId)

egNotifyTTCreated

public abstract boolean egNotifyTTCreated(java.lang.String[] tt_id)

This method should be implemented to send notification to the trouble ticketing system when a new trouble ticket is created. tt_id[] array will contain one or more trouble ticket ids which were created.

egNotifyTTUpdated

public abstract boolean egNotifyTTUpdated(java.lang.String[] tt_id)

This method should be implemented to send notification to the trouble ticketing system when a trouble ticket is updated. tt_id[] array will contain one or more trouble ticket ids which were updated.

logToErrorFile

public void logToErrorFile(java.lang.String entity,
                           java.lang.String message)

Errors will be logged in error_log file which will be in egurkhahome/manager/logs directory