jain.protocol.ss7.oam.tcap
Class TcapAlarmEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ss7.oam.OamAlarmEvent
              |
              +--jain.protocol.ss7.oam.tcap.TcapAlarmEvent

public class TcapAlarmEvent
extends OamAlarmEvent

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

See Also:
Serialized Form

Field Summary
static int TCAP_ALARM_RESOURCE_LIMIT_REACHED
          Alarm Type Constant: No resources remaining.
 
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
TcapAlarmEvent(TcapManagedObject source, int priority, int alarmType)
          Constructs a new TcapAlarmEvent.
 
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

TCAP_ALARM_RESOURCE_LIMIT_REACHED

public static final int TCAP_ALARM_RESOURCE_LIMIT_REACHED
Alarm Type Constant: No resources remaining. This alarm is generated if the maximum resource for the TCAP stack configuration is reached and no new resource can be allocated.

Emitted By: TcapNodeMO

Constructor Detail

TcapAlarmEvent

public TcapAlarmEvent(TcapManagedObject source,
                      int priority,
                      int alarmType)
Constructs a new TcapAlarmEvent.
Parameters:
source - The Managed Object that emitted this Event.
priority - The priority of this TcapAlarmEvent. 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 TcapAlarmEvent is for purely informational purposes only.
  2. PRIORITY_LOW - Indicates that the state of the MO that emitted this TcapAlarmEvent 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 TcapAlarmEvent 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 TcapAlarmEvent. 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 TCAP Alarm Types.
Throws:
java.lang.IllegalArgumentException - - if the supplied alarm type is not one of the defined TCAP 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


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