Interface NodeReconciliationAlarmMBean
- All Known Implementing Classes:
NodeReconciliationAlarm
public interface NodeReconciliationAlarmMBean
NodeReconciliationAlarmMBean is the generic interface for
providing alarm services by maintaning the alarm object.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
clearAlarm
(String alarmName, String additionalText, String source) This method is called to clear the raised alarm with the specified alarm name.This method is called to retrieve the list of the alarm objects to be cleared.This method is called to retrieve the list of alarm objects which are to be raised.void
raiseAlarm
(String alarmName, String additionalText, String source) This method is called to raise the alarm with the specified alarm name.void
setClearAlarmObject
(List<String> clearAlarmObject) This method is called to set the list of alarm objects to be cleared.void
setRaiseAlarmObject
(List<String> raiseAlarmObject) This method is called to set the list of raiseAlarmObjets.
-
Method Details
-
setRaiseAlarmObject
This method is called to set the list of raiseAlarmObjets. This includes the alarm objects which are to be raised- Parameters:
raiseAlarmObject
- holds the list of alarm objects
-
getRaiseAlarmObject
This method is called to retrieve the list of alarm objects which are to be raised.- Returns:
- List of string containing the alarm objects
-
setClearAlarmObject
This method is called to set the list of alarm objects to be cleared.- Parameters:
clearAlarmObject
- maintains the list of clearable alarm objects
-
getClearAlarmObject
This method is called to retrieve the list of the alarm objects to be cleared.- Returns:
- List of clearable alarm objects
-
raiseAlarm
This method is called to raise the alarm with the specified alarm name.- Parameters:
alarmName
- name of the alarm to be raisedadditionalText
- description of alarm eventsource
- source of alarm
-
clearAlarm
This method is called to clear the raised alarm with the specified alarm name.- Parameters:
alarmName
- name of the alarm to be clearedadditionalText
- description of alarm eventsource
- source of alarm
-