jain.protocol.ss7.oam
Class OamAlarmEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ss7.oam.OamAlarmEvent
Direct Known Subclasses:
Mtp2AlarmEvent, Mtp3AlarmEvent, SccpAlarmEvent, TcapAlarmEvent

public abstract class OamAlarmEvent
extends java.util.EventObject
implements java.io.Serializable, java.lang.Cloneable

A OamAlarmEvent is an Event emitted by a JAIN OAM Managed Object(MO) to indicate a change in status of the MO.

This state change may result from :

This Event should be sent to all applications that have registered with the JAIN OAM Managed Object as an Alarm Listener.

The Alarm Events are be categorised according to the following priorites (in increasing order of priority):

  1. PRIORITY_INFORMATIONAL - The cause of this OamAlarmEvent does not affect the functional state of the system and may be ignored.
    This OamAlarmEvent is for purely informational purposes only.
  2. PRIORITY_LOW - Indicates that the state of the MO that emitted this OamAlarmEvent has changed as a result of an operation explicitly invoked by an application.
  3. PRIORITY_HIGH - Indicates that the physical network element associated with the MO that emitted this OamAlarmEvent has gone out of service.
    Without corrective action, service reliability can be severely affected.
  4. PRIORITY_CRITICAL Indicates the complete failure of the physical netwrok element associated with the MO that emitted this AlarmEvent.
    Immediate recovery action is required.
  5. PRIORITY_VENDOR_DEFINED - Indicates that this alarm has a severity that is defined by the SS7 stack vendor. An alarm of this priority may have either none or very severe ramifications and it is the responsibilty of a Stack vendor to inform JAIN OAM application developers the severity of this alarm.

IMPORTANT:
This API does not define the action required upon receiving an alarm of a particular priority, nor does the API define what priority is associated with each alarm type. The assignment of an alarm prioritiy (or range of alarm priorities) to each alarm type is implementation dependant,and it the responsibility of the Stack Vendor to make the implementation dependent assignments known.

See Also:
Serialized Form

Field Summary
static int ALARM_MO_ATTRIBUTE_VALUE_CHANGED
          Alarm Type Constant: Indicates that an attribute value changed.
static int ALARM_MO_CREATED
          Alarm Type Constant: Indicates that an instance of a Managed Object has been created.
static int ALARM_MO_DELETED
          Alarm Type Constant: Indicates that an instance of a Managed Object has been deleted.
static int ALARM_TIMER_EXPIRED
          Alarm Type Constant: Indicates that a timer has expired.
IMPORTANTIf an Alarm of this type is sent then the Timer Id of the Timer that caused this event should be set so that the application receiving the Event can determine which Timer caused the Alarm.
protected  int alarmType
           
static int PRIORITY_CRITICAL
          Indicates that this is a Critical Alarm.
static int PRIORITY_HIGH
          Indicates that this is a High Priority Alarm.
static int PRIORITY_INFORMATIONAL
          Indicates that this is an Informational Alarm.
static int PRIORITY_LOW
          Indicates that this is a Low Priority Alarm.
static int PRIORITY_VENDOR_DEFINED
          Indicates that this alarm has a severity that is defined by the SS7 stack vendor.
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
protected OamAlarmEvent(java.lang.Object source, int priority, int alarmType)
           
 
Method Summary
 int getAlarmType()
          Returns the Type of this Alarm
 int getPriority()
          Returns the Priority of this OamAlarmEvent.
 int getTimerId()
          Returns the Timer Id of the Timer that caused the Timer Expired Alarm [when ALARM_TIMER_EXPIRED == getAlarmType()].
 java.util.Date getTimestamp()
          Returns the timestamp indicating the time at which this alarm was emitted.
abstract  void setAlarmType(int alarmType)
          Sets the Type of this Alarm.
IMPORTANTIf the Alarm type is ALARM_TIMER_EXPIRED then the Timer Id of the Timer that caused this event should be set so that the application receiving the Event can determine which Timer caused the Alarm.
 void setPriority(int priority)
          Sets the Priority of this Alarm.
 void setTimerId(int timerId)
          Sets the Timer Id that indicates the Timer that caused a Timer Expired Event.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PRIORITY_INFORMATIONAL

public static final int PRIORITY_INFORMATIONAL
Indicates that this is an Informational Alarm. The cause of this OamAlarmEvent does not affect the functional state of the system and may be ignored. This OamAlarmEvent is for purely informational purposes only.

PRIORITY_LOW

public static final int PRIORITY_LOW
Indicates that this is a Low Priority Alarm. The state of the MO that emitted this OamAlarmEvent has changed as a result of an operation explicitly invoked by an application.

PRIORITY_HIGH

public static final int PRIORITY_HIGH
Indicates that this is a High Priority Alarm. The physical network element associated with the MO that emitted this OamAlarmEvent has gone out of service.
Without corrective action, service reliability can be severely affected.

PRIORITY_CRITICAL

public static final int PRIORITY_CRITICAL
Indicates that this is a Critical Alarm. An Alarm of this priority indicates the complete failure of the physical netwrok element associated with the MO that emitted this Alarm.
Immediate recovery action is required.

PRIORITY_VENDOR_DEFINED

public static final int PRIORITY_VENDOR_DEFINED
Indicates that this alarm has a severity that is defined by the SS7 stack vendor. An alarm of this priority may have either none or very severe ramifications and it is the responsibilty of a Stack vendor to inform JAIN OAM application developers the severity of this alarm.

ALARM_TIMER_EXPIRED

public static final int ALARM_TIMER_EXPIRED
Alarm Type Constant: Indicates that a timer has expired.
IMPORTANTIf an Alarm of this type is sent then the Timer Id of the Timer that caused this event should be set so that the application receiving the Event can determine which Timer caused the Alarm. Each Timer defined within this API has an associated Timer Id specified in the comment describing that Timer.
Emitted By: All OamTimerProfiles
When: A Timer contained in the timer profile expires

ALARM_MO_CREATED

public static final int ALARM_MO_CREATED
Alarm Type Constant: Indicates that an instance of a Managed Object has been created.

Reference: "ITU-T Rec. M.3100 (1992)" createDeleteNotificationPackage (I,C)
Emitted By: All OamManagedObjects
When: The creation of the MO has been sucessfully committed.


ALARM_MO_DELETED

public static final int ALARM_MO_DELETED
Alarm Type Constant: Indicates that an instance of a Managed Object has been deleted.

Reference: "ITU-T Rec. M.3100 (1992)" createDeleteNotificationPackage (I,C)
Emitted By: All OamManagedObjects
When: The deletion of the MO has been sucessfully committed.


ALARM_MO_ATTRIBUTE_VALUE_CHANGED

public static final int ALARM_MO_ATTRIBUTE_VALUE_CHANGED
Alarm Type Constant: Indicates that an attribute value changed.

Reference: "ITU-T Rec. M.3100 (1992)" attributeValueChangeNotificationPackage (I,C)
Emitted By: All OamManagedObjects
When: The modification of an attribute of the MO has been sucessfully committed. This Alarm will be fired once for every attribute whose value has changed.


alarmType

protected int alarmType
Constructor Detail

OamAlarmEvent

protected OamAlarmEvent(java.lang.Object source,
                        int priority,
                        int alarmType)
Method Detail

setPriority

public void setPriority(int priority)
                 throws java.lang.IllegalArgumentException
Sets the Priority of this Alarm.
Parameters:
priority - one of the following (in increasing order of priority):
  1. PRIORITY_INFORMATIONAL - The cause of this OamAlarmEvent does not affect the functional state of the system and may be ignored.
    This OamAlarmEvent is for purely informational purposes only.
  2. PRIORITY_LOW - Indicates that the state of the MO that emitted this OamAlarmEvent has changed as a result of an operation explicitly invoked by an application.
  3. PRIORITY_HIGH - Indicates that the physical network element associated with the MO that emitted this OamAlarmEvent has gone out of service.
    Without corrective action, service reliability can be severely affected.
  4. PRIORITY_CRITICAL Indicates the complete failure of the physical netwrok element associated with the MO that emitted this OamAlarmEvent.
    Immediate recovery action is required.
  5. PRIORITY_VENDOR_DEFINED - Indicates that this alarm has a severity that is defined by the SS7 stack vendor. An alarm of this priority may have either none or very severe ramifications and it is the responsibilty of a Stack vendor to inform JAIN OAM application developers the severity of this alarm.
Throws:
java.lang.IllegalArgumentException - - if the supplied priority is not one of the defined types

getPriority

public int getPriority()
Returns the Priority of this OamAlarmEvent.
Returns:
one of the following (in increasing order of priority):
  1. PRIORITY_INFORMATIONAL - The cause of this OamAlarmEvent does not affect the functional state of the system and may be ignored.
    This OamAlarmEvent is for purely informational purposes only.
  2. PRIORITY_LOW - Indicates that the state of the MO that emitted this OamAlarmEvent has changed as a result of an operation explicitly invoked by an application.
  3. PRIORITY_HIGH - Indicates that the physical network element associated with the MO that emitted this OamAlarmEvent has gone out of service.
    Without corrective action, service reliability can be severely affected.
  4. PRIORITY_CRITICAL Indicates the complete failure of the physical netwrok element associated with the MO that emitted this OamAlarmEvent.
    Immediate recovery action is required.
  5. PRIORITY_VENDOR_DEFINED - Indicates that this alarm has a severity that is defined by the SS7 stack vendor. An alarm of this priority may have either none or very severe ramifications and it is the responsibilty of a Stack vendor to inform JAIN OAM application developers the severity of this alarm.

setAlarmType

public abstract void setAlarmType(int alarmType)
                           throws java.lang.IllegalArgumentException
Sets the Type of this Alarm.
IMPORTANTIf the Alarm type is ALARM_TIMER_EXPIRED then the Timer Id of the Timer that caused this event should be set so that the application receiving the Event can determine which Timer caused the Alarm. Each Timer defined within this API has an associated Timer Id specified in the comment describing that Timer.
Parameters:
alarmType - one of the defined Alarm Types.
Throws:
java.lang.IllegalArgumentException - - if the supplied alarm type is not one of those defined

getAlarmType

public int getAlarmType()
Returns the Type of this Alarm
Returns:
one of the alarm type values defined in this OamAlarmEvent or any of the defined alarm types.

getTimestamp

public java.util.Date getTimestamp()
Returns the timestamp indicating the time at which this alarm was emitted.
Returns:
the time at which the alarm was emitted.

getTimerId

public int getTimerId()
Returns the Timer Id of the Timer that caused the Timer Expired Alarm [when ALARM_TIMER_EXPIRED == getAlarmType()]. Each Timer defined within this API has an associated Timer Id specified in the comment describing that Timer. This method returns that Timer Id associated with the particular timer that has expired.
If this method is invoked when the Alarm is not a Timer Expired Alarm [when ALARM_TIMER_EXPIRED != getAlarmType()] then 0 is returned.
Returns:
either
  • the Timer Id of the the Timer that caused the Timer Expired Alarm [when ALARM_TIMER_EXPIRED == getAlarmType()], or
  • 0 - [when ALARM_TIMER_EXPIRED != getAlarmType()]

setTimerId

public void setTimerId(int timerId)
                throws java.lang.IllegalArgumentException
Sets the Timer Id that indicates the Timer that caused a Timer Expired Event. Whenever a new OamAlarmEvent is sent to indicate that a timer has expired [ALARM_TIMER_EXPIRED == getAlarmType()], then this value should be set so that the application receiving the Event can determine which Timer caused the event to be sent.
Parameters:
timerId - the Id of the Timer that caused a Timer Expired Event.
Throws:
java.lang.IllegalArgumentException - - if the supplied timer ID does not represent a legal Timer ID


06 January 2000
If you have any comments or queries, please mail them to Colm Hayden [JAIN SS7 OAM Edit Lead]

Copyright - 2000 Sun Microsystems