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 :

• a create/delete/modify operation by an application that expliciltly changes the state of the MO.
• a change in the SS7 Network that implicitly changes the state of it's associated MO.
• a timer within a Timer MO expiring.

This Event should be sent to all applications that have registered with the Protocol Layer MO 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 Indicates that an attribute value changed.
static int	ALARM_MO_CREATED Indicates that an instance of a Managed Object has been created.
static int	ALARM_MO_DELETED Indicates that an instance of a Managed Object has been deleted.
static int	ALARM_MO_STATE_CHANGED Indicates that the state attributes have changed.
static int	ALARM_TIMER_EXPIRED Indicates that a timer has expired.
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.
java.util.Date	getTimestamp()
void	setAlarmType(int alarmType) Sets the Type of this Alarm
void	setPriority(int priority) Sets the Priority of this Alarm.

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

Indicates that a timer has expired.

ALARM_MO_CREATED

public static final int ALARM_MO_CREATED

Indicates that an instance of a Managed Object has been created. "ITU-T Rec. M.3100 (1992)" createDeleteNotificationPackage (I,C)

ALARM_MO_DELETED

public static final int ALARM_MO_DELETED

Indicates that an instance of a Managed Object has been deleted. "ITU-T Rec. M.3100 (1992)" createDeleteNotificationPackage (I,C)

ALARM_MO_ATTRIBUTE_VALUE_CHANGED

public static final int ALARM_MO_ATTRIBUTE_VALUE_CHANGED

Indicates that an attribute value changed. "ITU-T Rec. M.3100 (1992)" attributeValueChangeNotificationPackage (I,C)

ALARM_MO_STATE_CHANGED

public static final int ALARM_MO_STATE_CHANGED

Indicates that the state attributes have changed. "ITU-T Rec. M.3100 (1992)": stateChangeNotificationPackage (I,M)

Constructor Detail

OamAlarmEvent

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

Method Detail

setPriority

public void setPriority(int priority)

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.

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 void setAlarmType(int alarmType)

Sets the Type of this Alarm

Parameters:

alarmType - one of the defined Alarm Types.

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()