jain.protocol.ss7.oam.mtp3
Class Mtp3AlarmEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ss7.oam.OamAlarmEvent
              |
              +--jain.protocol.ss7.oam.mtp3.Mtp3AlarmEvent

public class Mtp3AlarmEvent

extends OamAlarmEvent

A Mtp3AlarmEvent is an Event emitted by a Mtp3 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 Mtp3 Managed Object as a Mtp3 Alarm Listener.

See Also:

Serialized Form

Field Summary

static int	MTP3_ALARM_CONCERNED_SP_NETWORK_CONGESTED Alarm Type Constant: Concerned destination point code (DPC) network congested.
static int	MTP3_ALARM_CONCERNED_SP_PAUSE Alarm Type Constant: Concerned destination point code (DPC) pause.
static int	MTP3_ALARM_CONCERNED_SP_RESUME Alarm Type Constant: Concerned destination point code (DPC) resume.
static int	MTP3_ALARM_CONCERNED_SP_STOP_NET_CONG Alarm Type Constant: Concerned destination point code (DPC) stop network congestion.
static int	MTP3_ALARM_CONCERNED_SP_USER_UNAVAILABLE Alarm Type Constant: Concerned destination point code (DPC) remote user unavailable.
static int	MTP3_ALARM_LS_BROADCAST_TFA Alarm Type Constant: Signalling Linkset and Routeset Availability: Indicates the initiation of broedcast TFA due to the recovery of a measured linkset.
static int	MTP3_ALARM_LS_BROADCAST_TFP Alarm Type Constant: Signalling Linkset and Routeset Availability: Indicates the initiation of broedcast TFP due to failure of a measured linkset.
static int	MTP3_ALARM_LS_CHANGE Alarm Type Constant: Signalling Linkset and Routeset Availability: Indicates the change in linkset used to adjacent Signalling Point.
static int	MTP3_ALARM_LS_END_FAILURE Alarm Type Constant: Signalling Linkset and Routeset Availability: Indicates the end of Linkset failure.
static int	MTP3_ALARM_LS_START_FAILURE Alarm Type Constant: Signalling Linkset and Routeset Availability: Indicates the start of Linkset failure.
static int	MTP3_ALARM_RS_END_UNAVAILABILITY Alarm Type Constant: Signalling Linkset and Routeset Availability: Indicates the end of unavailability of routeset to a given destination or set of destinations.
static int	MTP3_ALARM_RS_START_UNAVAILABILITY Alarm Type Constant: Signalling Linkset and Routeset Availability: Indicates the start of unavailability of routeset to a given destination or set of destinations.
static int	MTP3_ALARM_SL_END_REMOTE_PROCESSOR_OUTAGE Alarm Type Constant: Signalling Link Availability: Indicates the end of remote processor outage.
static int	MTP3_ALARM_SL_EXCESSIVE_CONGESTION Alarm Type Constant: Signalling Link Faults & Performance: Indicates a signalling link failure due to the excessive duration of congestion of a signalling link.
static int	MTP3_ALARM_SL_EXCESSIVE_ERROR_RATE Alarm Type Constant: Signalling Link Faults & Performance: Indicates a signalling link failure due to an excessive error rate of a signalling link.
static int	MTP3_ALARM_SL_FAILURE Alarm Type Constant: Signalling Link Faults & Performance: Indicates that there has been a signalling link failure.
static int	MTP3_ALARM_SL_INHIBIT_DENIED Alarm Type Constant: Link inhibit denied.
static int	MTP3_ALARM_SL_LOCAL_AUTO_CHANGEBACK Alarm Type Constant: Signalling Link Faults & Performance: Indicates a local automatic changeback.
static int	MTP3_ALARM_SL_LOCAL_AUTO_CHANGEOVER Alarm Type Constant: Signalling Link Faults & Performance: Indicates a local automatic changeover.
static int	MTP3_ALARM_SL_LOCALLY_BLOCKED Alarm Type Constant: Link locally blocked.
static int	MTP3_ALARM_SL_LOCALLY_UNBLOCKED Alarm Type Constant: Link locally unblocked.
static int	MTP3_ALARM_SL_REMOTELY_BLOCKED Alarm Type Constant: Link remotely blocked.
static int	MTP3_ALARM_SL_REMOTELY_UNBLOCKED Alarm Type Constant: Link remotely unblocked.
static int	MTP3_ALARM_SL_RESTORATION Alarm Type Constant: Signalling Link Faults & Performance: Indicates the restoration of a signalling link.
static int	MTP3_ALARM_SL_START_LOCAL_INHIBITION Alarm Type Constant: Signalling Link Availability: Indicates the start of local inhibition.
static int	MTP3_ALARM_SL_START_REMOTE_INHIBITION Alarm Type Constant: Signalling Link Availability: Indicates the start of remote inhibition.
static int	MTP3_ALARM_SL_STOP_LOCAL_INHIBITION Alarm Type Constant: Signalling Link Availability: Indicates the stop of local inhibition.
static int	MTP3_ALARM_SL_STOP_REMOTE_INHIBITION Alarm Type Constant: Signalling Link Availability: Indicates the stop of remote inhibition.
static int	MTP3_ALARM_SL_UNINHIBIT_DENIED Alarm Type Constant: Link uninhibit denied.
static int	MTP3_ALARM_SP_ACCESSIBLE Alarm Type Constant: Mtp Signalling Point Status: Indicates that an adjacent Signalling Point is accessible.
static int	MTP3_ALARM_SP_INACCESSIBLE Alarm Type Constant: Mtp Signalling Point Status: Indicates that the adjacent Signalling Point is inaccessible.

Fields inherited from class jain.protocol.ss7.oam.OamAlarmEvent

ALARM_MO_ATTRIBUTE_VALUE_CHANGED, ALARM_MO_CREATED, ALARM_MO_DELETED, ALARM_TIMER_EXPIRED, alarmType, PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_INFORMATIONAL, PRIORITY_LOW, PRIORITY_VENDOR_DEFINED

Fields inherited from class java.util.EventObject

source

Constructor Summary

Mtp3AlarmEvent(Mtp3ManagedObject source, int priority, int alarmType)
Constructs a new Mtp3AlarmEvent.

Method Summary

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.
java.lang.String	toString() Returns a string representation (with details) of classes which extend this class.

Methods inherited from class jain.protocol.ss7.oam.OamAlarmEvent

getAlarmType, getPriority, getTimerId, getTimestamp, setPriority, setTimerId

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

MTP3_ALARM_SL_FAILURE

public static final int MTP3_ALARM_SL_FAILURE

Alarm Type Constant: Signalling Link Faults & Performance: Indicates that there has been a signalling link failure.

Emitted By: LinkMO

MTP3_ALARM_SL_EXCESSIVE_ERROR_RATE

public static final int MTP3_ALARM_SL_EXCESSIVE_ERROR_RATE

Alarm Type Constant: Signalling Link Faults & Performance: Indicates a signalling link failure due to an excessive error rate of a signalling link.

Emitted By: LinkMO Reference: (ITU Q.703, 10.2.2)

MTP3_ALARM_SL_EXCESSIVE_CONGESTION

public static final int MTP3_ALARM_SL_EXCESSIVE_CONGESTION

Alarm Type Constant: Signalling Link Faults & Performance: Indicates a signalling link failure due to the excessive duration of congestion of a signalling link.

Emitted By: LinkMO Reference: (ITU Q.703, 9.3)

MTP3_ALARM_SL_LOCAL_AUTO_CHANGEOVER

public static final int MTP3_ALARM_SL_LOCAL_AUTO_CHANGEOVER

Alarm Type Constant: Signalling Link Faults & Performance: Indicates a local automatic changeover.

Emitted By: LinkMO Reference: (ITU Q.703, Clause 5)

MTP3_ALARM_SL_LOCAL_AUTO_CHANGEBACK

public static final int MTP3_ALARM_SL_LOCAL_AUTO_CHANGEBACK

Alarm Type Constant: Signalling Link Faults & Performance: Indicates a local automatic changeback.

Emitted By: LinkMO Reference: (ITU Q.703, Clause 6)

MTP3_ALARM_SL_RESTORATION

public static final int MTP3_ALARM_SL_RESTORATION

Alarm Type Constant: Signalling Link Faults & Performance: Indicates the restoration of a signalling link.

Emitted By: LinkMO Reference: (ITU Q.704, 3.2.3)

MTP3_ALARM_SL_END_REMOTE_PROCESSOR_OUTAGE

public static final int MTP3_ALARM_SL_END_REMOTE_PROCESSOR_OUTAGE

Alarm Type Constant: Signalling Link Availability: Indicates the end of remote processor outage.

Emitted By: LinkMO Reference: (ITU Q.704, 3.2.7)

MTP3_ALARM_SL_START_LOCAL_INHIBITION

public static final int MTP3_ALARM_SL_START_LOCAL_INHIBITION

Alarm Type Constant: Signalling Link Availability: Indicates the start of local inhibition.

Emitted By: LinkMO Reference: (ITU Q.704, Clause 10)

MTP3_ALARM_SL_STOP_LOCAL_INHIBITION

public static final int MTP3_ALARM_SL_STOP_LOCAL_INHIBITION

Alarm Type Constant: Signalling Link Availability: Indicates the stop of local inhibition.

Emitted By: LinkMO

MTP3_ALARM_SL_START_REMOTE_INHIBITION

public static final int MTP3_ALARM_SL_START_REMOTE_INHIBITION

Alarm Type Constant: Signalling Link Availability: Indicates the start of remote inhibition.

Emitted By: LinkMO Reference: (ITU Q.704, Clause 10)

MTP3_ALARM_SL_STOP_REMOTE_INHIBITION

public static final int MTP3_ALARM_SL_STOP_REMOTE_INHIBITION

Alarm Type Constant: Signalling Link Availability: Indicates the stop of remote inhibition.

Emitted By: LinkMO

MTP3_ALARM_LS_START_FAILURE

public static final int MTP3_ALARM_LS_START_FAILURE

Alarm Type Constant: Signalling Linkset and Routeset Availability: Indicates the start of Linkset failure.

Emitted By: LinksetMO

MTP3_ALARM_LS_END_FAILURE

public static final int MTP3_ALARM_LS_END_FAILURE

Alarm Type Constant: Signalling Linkset and Routeset Availability: Indicates the end of Linkset failure.

Emitted By: LinksetMO

MTP3_ALARM_LS_BROADCAST_TFP

public static final int MTP3_ALARM_LS_BROADCAST_TFP

Alarm Type Constant: Signalling Linkset and Routeset Availability: Indicates the initiation of broedcast TFP due to failure of a measured linkset.

Emitted By: LinksetMO Reference: (ITU Q.704, Clause 13)

MTP3_ALARM_LS_BROADCAST_TFA

public static final int MTP3_ALARM_LS_BROADCAST_TFA

Alarm Type Constant: Signalling Linkset and Routeset Availability: Indicates the initiation of broedcast TFA due to the recovery of a measured linkset.

Emitted By: LinksetMO Reference: (ITU Q.704, Clause 13)

MTP3_ALARM_LS_CHANGE

public static final int MTP3_ALARM_LS_CHANGE

Alarm Type Constant: Signalling Linkset and Routeset Availability: Indicates the change in linkset used to adjacent Signalling Point.

Emitted By: LinksetMO

MTP3_ALARM_RS_START_UNAVAILABILITY

public static final int MTP3_ALARM_RS_START_UNAVAILABILITY

Alarm Type Constant: Signalling Linkset and Routeset Availability: Indicates the start of unavailability of routeset to a given destination or set of destinations.

Emitted By: RoutesetMO Reference: (ITU Q.704, 11.2.1)

MTP3_ALARM_RS_END_UNAVAILABILITY

public static final int MTP3_ALARM_RS_END_UNAVAILABILITY

Alarm Type Constant: Signalling Linkset and Routeset Availability: Indicates the end of unavailability of routeset to a given destination or set of destinations.

Emitted By: RoutesetMO Reference: (ITU Q.704, 11.2.2)

MTP3_ALARM_SP_INACCESSIBLE

public static final int MTP3_ALARM_SP_INACCESSIBLE

Alarm Type Constant: Mtp Signalling Point Status: Indicates that the adjacent Signalling Point is inaccessible.

Emitted By: Mtp3SapMO

MTP3_ALARM_SP_ACCESSIBLE

public static final int MTP3_ALARM_SP_ACCESSIBLE

Alarm Type Constant: Mtp Signalling Point Status: Indicates that an adjacent Signalling Point is accessible.

Emitted By: Mtp3SapMO

MTP3_ALARM_SL_INHIBIT_DENIED

public static final int MTP3_ALARM_SL_INHIBIT_DENIED

Alarm Type Constant: Link inhibit denied.

Emitted By: LinkMO

MTP3_ALARM_SL_UNINHIBIT_DENIED

public static final int MTP3_ALARM_SL_UNINHIBIT_DENIED

Alarm Type Constant: Link uninhibit denied.

Emitted By: LinkMO

MTP3_ALARM_SL_REMOTELY_BLOCKED

public static final int MTP3_ALARM_SL_REMOTELY_BLOCKED

Alarm Type Constant: Link remotely blocked.

Emitted By: LinkMO

MTP3_ALARM_SL_REMOTELY_UNBLOCKED

public static final int MTP3_ALARM_SL_REMOTELY_UNBLOCKED

Alarm Type Constant: Link remotely unblocked.

Emitted By: LinkMO

MTP3_ALARM_SL_LOCALLY_BLOCKED

public static final int MTP3_ALARM_SL_LOCALLY_BLOCKED

Alarm Type Constant: Link locally blocked.

Emitted By: LinkMO

MTP3_ALARM_SL_LOCALLY_UNBLOCKED

public static final int MTP3_ALARM_SL_LOCALLY_UNBLOCKED

Alarm Type Constant: Link locally unblocked.

Emitted By: LinkMO

MTP3_ALARM_CONCERNED_SP_PAUSE

public static final int MTP3_ALARM_CONCERNED_SP_PAUSE

Alarm Type Constant: Concerned destination point code (DPC) pause.

Emitted By: Mtp2SapMO

MTP3_ALARM_CONCERNED_SP_RESUME

public static final int MTP3_ALARM_CONCERNED_SP_RESUME

Alarm Type Constant: Concerned destination point code (DPC) resume.

Emitted By: Mtp2SapMO

MTP3_ALARM_CONCERNED_SP_NETWORK_CONGESTED

public static final int MTP3_ALARM_CONCERNED_SP_NETWORK_CONGESTED

Alarm Type Constant: Concerned destination point code (DPC) network congested.

Emitted By: Mtp2SapMO

MTP3_ALARM_CONCERNED_SP_USER_UNAVAILABLE

public static final int MTP3_ALARM_CONCERNED_SP_USER_UNAVAILABLE

Alarm Type Constant: Concerned destination point code (DPC) remote user unavailable.

Emitted By: Mtp2SapMO

MTP3_ALARM_CONCERNED_SP_STOP_NET_CONG

public static final int MTP3_ALARM_CONCERNED_SP_STOP_NET_CONG

Alarm Type Constant: Concerned destination point code (DPC) stop network congestion.

Emitted By: Mtp2SapMO

Constructor Detail

Mtp3AlarmEvent

public Mtp3AlarmEvent(Mtp3ManagedObject source,
                      int priority,
                      int alarmType)

Constructs a new Mtp3AlarmEvent.

Parameters:

source - The Managed Object that emitted this Event.

priority - The priority of this Mtp3AlarmEvent. This may be either (in increasing order of priority):

1. PRIORITY_INFORMATIONAL - The cause of this event does not affect the functional state of the system and may be ignored.
   This Mtp3AlarmEvent is for purely informational purposes only.
2. PRIORITY_LOW - Indicates that the state of the MO that emitted this Mtp3AlarmEvent 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 Mtp3AlarmEvent 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 Mtp3AlarmEvent. Immediate recovery action is required.

alarmType - The type of this alarm. This may be any one of the Alarm Type constants defined in this class, or one of those inherited from OamAlarmEvent.

Method Detail

setAlarmType

public 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 MTP3 Types.

Throws:

java.lang.IllegalArgumentException - - if the supplied alarm type is not one of the defined MTP3 Alarm Types

Overrides:

setAlarmType in class OamAlarmEvent

toString

public java.lang.String toString()

Returns a string representation (with details) of classes which extend this class. Over rides standard JAVA toString method.

Overrides:

toString in class java.util.EventObject