jain.protocol.ss7.oam
Interface OamManagedObjectMBean

All Known Subinterfaces:
ConcernedAreaMBean, GlobalTitleEntryMBean, LinkMBean, LinkSetMBean, Mtp2LayerManagerMBean, Mtp2ManagedObjectMBean, Mtp2SapMBean, Mtp2TimerProfileMBean, Mtp3LayerManagerMBean, Mtp3ManagedObjectMBean, Mtp3SapMBean, Mtp3TimerProfileMBean, OwnSignallingPointMBean, RouteMBean, RouteSetMBean, SccpEntitySetMBean, SccpLayerManagerMBean, SccpManagedObjectMBean, SccpRoutingControlMBean, SccpSapMBean, SccpTimerProfileMBean, ScreeningTableMBean, SignallingPointMBean, TcapLayerManagerMBean, TcapManagedObjectMBean, TcapNodeMBean

public abstract interface OamManagedObjectMBean
extends NotificationBroadcaster, MBeanRegistration, java.lang.Cloneable, java.io.Serializable

This interface is implemented by all JAIN OAM Managed Beans (MBeans).
NotificationBroadcaster Interface
This interface specifies three methods which MBeans acting as notification sources must implement:

getNotificationInfo gives a potential consumer the description of all notifications this source may emit. This method returns an array of MBeanNotificationInfo objects, each of which describes a notification.

addNotificationListener registers a consumer’s interest in notifications sent by this MBean. This method takes a reference to a NotificationListener object, a reference to a NotificationFilter object, and a hand-back object. The same listener object may be registered more than once, each time with a different hand-back object. This means that the handleNotification method of this listener will be invoked several times, with different hand-back objects. The MBean has to maintain a table of listener, filter and hand-back triplets. When the MBean emits a notification, it invokes the handleNotification method of all the registered NotificationListener objects, with their respective hand-back object.
If the consumer has specified a NotificationFilter when registering as a NotificationListener object, the MBean will invoke the filter’s isNotificationEnabled method first. Only if the filter returns a positive (true) response will the source then call the notification handler.

removeNotificationListener allows a consumer to unregister itself from a notification source. This method takes a reference to a NotificationListener object, as well as a hand-back object. If the hand-back object is provided, only the entry corresponding to this listener and hand-back pair will be removed. The same listener object may still be registered with other hand-back objects. Otherwise, if the hand-back is not provided, all entries corresponding to the listener will be removed.




Inheritance hierarchy for JAIN OAM Notification



Version:
1.1
Author:
Colm Hayden & Phelim O'Doherty

Field Summary
static java.lang.String OBJECT_TYPE_CONCERNED_AREA
          The Object Type for a ConcernedAreaMBean, getObjectType() for this MBean returns "OBJECT_TYPE_CONCERNED_AREA".
static java.lang.String OBJECT_TYPE_GLOBAL_TITLE_ENTRY
          The Object Type for a GlobalTitleEntryMBean, getObjectType() for this MBean returns "OBJECT_TYPE_GLOBAL_TITLE_ENTRY".
static java.lang.String OBJECT_TYPE_LINK
          The Object Type for a LinkMBean, getObjectType() for this MBean returns "OBJECT_TYPE_LINK".
static java.lang.String OBJECT_TYPE_LINKSET
          The Object Type for a LinksetMBean, getObjectType() for this MBean returns "OBJECT_TYPE_LINKSET".
static java.lang.String OBJECT_TYPE_MTP2_LAYER_MANAGER
          The Object Type for a Mtp2LayerManager, getObjectType() for this MBean returns "OBJECT_TYPE_MTP2_LAYER_MANAGER".
static java.lang.String OBJECT_TYPE_MTP2_SAP
          The Object Type for a Mtp2SapMBean, getObjectType() for this MBean returns "OBJECT_TYPE_MTP2_SAP".
static java.lang.String OBJECT_TYPE_MTP2_TIMER_PROFILE
          The Object Type for a Mtp2TimerProfileMBean, getObjectType() for this MBean returns "OBJECT_TYPE_MTP2_TIMER_PROFILE".
static java.lang.String OBJECT_TYPE_MTP3_LAYER_MANAGER
          The Object Type for a Mtp3LayerManager, getObjectType() for this MBean returns "OBJECT_TYPE_MTP3_LAYER_MANAGER".
static java.lang.String OBJECT_TYPE_MTP3_SAP
          The Object Type for a Mtp3SapMBean, getObjectType() for this MBean returns "OBJECT_TYPE_MTP3_SAP".
static java.lang.String OBJECT_TYPE_MTP3_TIMER_PROFILE
          The Object Type for a Mtp3TimerProfileMBean, getObjectType() for this MBean returns "OBJECT_TYPE_MTP3_TIMER_PROFILE".
static java.lang.String OBJECT_TYPE_OAM_TIMER_VAL
          The Object Type for a OamTimerValMBean, getObjectType() for this MBean returns "OBJECT_TYPE_OAM_TIMER_VAL".
static java.lang.String OBJECT_TYPE_OWN_SIGNALLING_POINT
          The Object Type for an OwnSignallingPointMBean, getObjectType() for this MBean returns "OBJECT_TYPE_OWN_SIGNALLING_POINT".
static java.lang.String OBJECT_TYPE_ROUTE
          The Object Type for a RouteMBean, getObjectType() for this MBean returns "OBJECT_TYPE_ROUTE".
static java.lang.String OBJECT_TYPE_ROUTESET
          The Object Type for a RoutesetMBean, getObjectType() for this MBean returns "OBJECT_TYPE_ROUTESET".
static java.lang.String OBJECT_TYPE_SCCP_ENTITY_SET
          The Object Type for a SccpEntitySetMBean, getObjectType() for this MBean returns "OBJECT_TYPE_SCCP_ENTITY_SET".
static java.lang.String OBJECT_TYPE_SCCP_LAYER_MANAGER
          The Object Type for a SccpLayerManager, getObjectType() for this MBean returns "OBJECT_TYPE_SCCP_LAYER_MANAGER".
static java.lang.String OBJECT_TYPE_SCCP_ROUTING_CONTROL
          The Object Type for a SccpRoutingControlMBean, getObjectType() for this MBean returns "OBJECT_TYPE_SCCP_ROUTING_CONTROL".
static java.lang.String OBJECT_TYPE_SCCP_SAP
          The Object Type for a SccpSapMBean, getObjectType() for this MBean returns "OBJECT_TYPE_SCCP_SAP".
static java.lang.String OBJECT_TYPE_SCCP_TIMER_PROFILE
          The Object Type for a SccpTimerProfileMBean, getObjectType() for this MBean returns "OBJECT_TYPE_SCCP_TIMER_PROFILE".
static java.lang.String OBJECT_TYPE_SCREENING_TABLE
          The Object Type for a ScreeningTableMBean, getObjectType() for this MBean returns "OBJECT_TYPE_SCREENING_TABLE".
static java.lang.String OBJECT_TYPE_TCAP_LAYER_MANAGER
          The Object Type for a TcapLayerManager, getObjectType() for this MBean returns "OBJECT_TYPE_TCAP_LAYER_MANAGER".
static java.lang.String OBJECT_TYPE_TCAP_NODE
          The Object Type for a TcapNodeMBean, getObjectType() for this MBean returns "OBJECT_TYPE_TCAP_NODE".
 
Fields inherited from class java.io.Serializable
serialVersionUID
 
Method Summary
 java.lang.String getName()
          Gets the name of this OamManagedBean.
 java.lang.String getObjectId()
          Returns an object id that is unique within all objects of the same class.
 ObjectName getObjectName()
          Gets the ObjectName of this OamManagedObjectBean.
 java.lang.String getObjectType()
          Returns the Object Type of this Managed Bean (MBean) as a String.
 java.lang.Object getProprietaryInformation()
          Returns an Object that may contain proprietary methods for this Managed Bean (MBean).
 OamStatisticNotification getStatistic(java.lang.Integer statisticType)
          Returns an OamStatisticNotification of the specified statistic type containing the value of the statistic.
 void setName(java.lang.String name)
          Sets the name of this OamManagedBean.
 void startPollingStatistic(java.lang.Integer statisticType, java.lang.Integer interval)
          Initiates the polling of statistic of the specified statistic type on this OamManagedObjectMBean.
 void stopPollingStatistic(java.lang.Integer statisticType)
          Stops the polling of statistic of the specified statistic type.
 
Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener
 
Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister
 

Field Detail

OBJECT_TYPE_MTP2_SAP

public static final java.lang.String OBJECT_TYPE_MTP2_SAP
The Object Type for a Mtp2SapMBean, getObjectType() for this MBean returns "OBJECT_TYPE_MTP2_SAP".

OBJECT_TYPE_MTP2_TIMER_PROFILE

public static final java.lang.String OBJECT_TYPE_MTP2_TIMER_PROFILE
The Object Type for a Mtp2TimerProfileMBean, getObjectType() for this MBean returns "OBJECT_TYPE_MTP2_TIMER_PROFILE".

OBJECT_TYPE_LINK

public static final java.lang.String OBJECT_TYPE_LINK
The Object Type for a LinkMBean, getObjectType() for this MBean returns "OBJECT_TYPE_LINK".

OBJECT_TYPE_LINKSET

public static final java.lang.String OBJECT_TYPE_LINKSET
The Object Type for a LinksetMBean, getObjectType() for this MBean returns "OBJECT_TYPE_LINKSET".

OBJECT_TYPE_ROUTE

public static final java.lang.String OBJECT_TYPE_ROUTE
The Object Type for a RouteMBean, getObjectType() for this MBean returns "OBJECT_TYPE_ROUTE".

OBJECT_TYPE_ROUTESET

public static final java.lang.String OBJECT_TYPE_ROUTESET
The Object Type for a RoutesetMBean, getObjectType() for this MBean returns "OBJECT_TYPE_ROUTESET".

OBJECT_TYPE_MTP3_SAP

public static final java.lang.String OBJECT_TYPE_MTP3_SAP
The Object Type for a Mtp3SapMBean, getObjectType() for this MBean returns "OBJECT_TYPE_MTP3_SAP".

OBJECT_TYPE_OWN_SIGNALLING_POINT

public static final java.lang.String OBJECT_TYPE_OWN_SIGNALLING_POINT
The Object Type for an OwnSignallingPointMBean, getObjectType() for this MBean returns "OBJECT_TYPE_OWN_SIGNALLING_POINT".

OBJECT_TYPE_SCREENING_TABLE

public static final java.lang.String OBJECT_TYPE_SCREENING_TABLE
The Object Type for a ScreeningTableMBean, getObjectType() for this MBean returns "OBJECT_TYPE_SCREENING_TABLE".

OBJECT_TYPE_MTP3_TIMER_PROFILE

public static final java.lang.String OBJECT_TYPE_MTP3_TIMER_PROFILE
The Object Type for a Mtp3TimerProfileMBean, getObjectType() for this MBean returns "OBJECT_TYPE_MTP3_TIMER_PROFILE".

OBJECT_TYPE_CONCERNED_AREA

public static final java.lang.String OBJECT_TYPE_CONCERNED_AREA
The Object Type for a ConcernedAreaMBean, getObjectType() for this MBean returns "OBJECT_TYPE_CONCERNED_AREA".

OBJECT_TYPE_GLOBAL_TITLE_ENTRY

public static final java.lang.String OBJECT_TYPE_GLOBAL_TITLE_ENTRY
The Object Type for a GlobalTitleEntryMBean, getObjectType() for this MBean returns "OBJECT_TYPE_GLOBAL_TITLE_ENTRY".

OBJECT_TYPE_SCCP_ENTITY_SET

public static final java.lang.String OBJECT_TYPE_SCCP_ENTITY_SET
The Object Type for a SccpEntitySetMBean, getObjectType() for this MBean returns "OBJECT_TYPE_SCCP_ENTITY_SET".

OBJECT_TYPE_SCCP_ROUTING_CONTROL

public static final java.lang.String OBJECT_TYPE_SCCP_ROUTING_CONTROL
The Object Type for a SccpRoutingControlMBean, getObjectType() for this MBean returns "OBJECT_TYPE_SCCP_ROUTING_CONTROL".

OBJECT_TYPE_SCCP_SAP

public static final java.lang.String OBJECT_TYPE_SCCP_SAP
The Object Type for a SccpSapMBean, getObjectType() for this MBean returns "OBJECT_TYPE_SCCP_SAP".

OBJECT_TYPE_SCCP_TIMER_PROFILE

public static final java.lang.String OBJECT_TYPE_SCCP_TIMER_PROFILE
The Object Type for a SccpTimerProfileMBean, getObjectType() for this MBean returns "OBJECT_TYPE_SCCP_TIMER_PROFILE".

OBJECT_TYPE_TCAP_NODE

public static final java.lang.String OBJECT_TYPE_TCAP_NODE
The Object Type for a TcapNodeMBean, getObjectType() for this MBean returns "OBJECT_TYPE_TCAP_NODE".

OBJECT_TYPE_OAM_TIMER_VAL

public static final java.lang.String OBJECT_TYPE_OAM_TIMER_VAL
The Object Type for a OamTimerValMBean, getObjectType() for this MBean returns "OBJECT_TYPE_OAM_TIMER_VAL".

OBJECT_TYPE_MTP2_LAYER_MANAGER

public static final java.lang.String OBJECT_TYPE_MTP2_LAYER_MANAGER
The Object Type for a Mtp2LayerManager, getObjectType() for this MBean returns "OBJECT_TYPE_MTP2_LAYER_MANAGER".

OBJECT_TYPE_MTP3_LAYER_MANAGER

public static final java.lang.String OBJECT_TYPE_MTP3_LAYER_MANAGER
The Object Type for a Mtp3LayerManager, getObjectType() for this MBean returns "OBJECT_TYPE_MTP3_LAYER_MANAGER".

OBJECT_TYPE_SCCP_LAYER_MANAGER

public static final java.lang.String OBJECT_TYPE_SCCP_LAYER_MANAGER
The Object Type for a SccpLayerManager, getObjectType() for this MBean returns "OBJECT_TYPE_SCCP_LAYER_MANAGER".

OBJECT_TYPE_TCAP_LAYER_MANAGER

public static final java.lang.String OBJECT_TYPE_TCAP_LAYER_MANAGER
The Object Type for a TcapLayerManager, getObjectType() for this MBean returns "OBJECT_TYPE_TCAP_LAYER_MANAGER".
Method Detail

getStatistic

public OamStatisticNotification getStatistic(java.lang.Integer statisticType)
                                      throws StatisticNotSupportedException,
                                             IllegalOperationException
Returns an OamStatisticNotification of the specified statistic type containing the value of the statistic. For example, if the object implementing this interface is an Mtp3ManagedObject then an Mtp3StatisticNotification will be returned. This method will return the statistic synchronously, whereas the startPollingStatistic() method will return the statistic asynchronously as an event at set intervals.
Parameters:
statisticType - the type of the statistic to be returned [.getStatisticType() == statisticType]
Returns:
the OamStatisticNotification containing the requested statistic. Depending on the type of this OamManagedObjectMBean, the type of the returned OamStatisticNotification may be:

Throws:
StatisticNotSupportedException - if the specified statistic is not supported (cannot be collected) by the underlying Stack management system.
IllegalOperationException - if the specifiecd statistic type cannot be collected for this OamManagedObjectMBean

startPollingStatistic

public void startPollingStatistic(java.lang.Integer statisticType,
                                  java.lang.Integer interval)
                           throws StatisticNotSupportedException,
                                  IllegalOperationException
Initiates the polling of statistic of the specified statistic type on this OamManagedObjectMBean. Each time the specified interval expires, an OamStatisticNotification containing the value of the statistic will be sent asynchronously to the registered NotificationListener that started polling the statistic (by invoking this method), providing that the NotificationListener has registered with this OamManagedObjectMBean using an appropriate Filter.

Depending on the type of this OamManagedObjectMBean, the type of the OamStatisticNotification that is fired will be one of:

The specified statistic shall be continually sent after the specified interval to the registered NotificationListener until either:

Parameters:
statisticType - the type of the statistic to be polled [.getStatisticType() == statisticType]
interval - the polling interval in milliseconds
Throws:
StatisticNotSupportedException - if the specified statistic is not supported (cannot be collected) by the underlying Stack management system.
IllegalOperationException - if the specifiecd statistic type cannot be collected for this OamManagedObjectMBean.

stopPollingStatistic

public void stopPollingStatistic(java.lang.Integer statisticType)
                          throws IllegalOperationException
Stops the polling of statistic of the specified statistic type.

If
the specified statistic is currently being polled by the NotificationListener that invoked this method
then
this polling will stop and the specified statistic shall no longer be sent to the registered NotificationListener.

If
the specified statistic is no longer being polled by the NotificationListener that invoked this method
then
then invoking this operation will have no effect.

Parameters:
statisticType - the type of the statistic for which polling is to stop.
Throws:
IllegalOperationException - - if the statistic is not being polled on this OamManagedObjectMBean or the specified statistic type cannot be collected for this OamManagedObjectMBean.

setName

public void setName(java.lang.String name)
             throws java.lang.NullPointerException
Sets the name of this OamManagedBean. This can be used to store a proprietary Managed Bean (MBean) identifier.
Parameters:
name - the name of this Managed Bean (MBean)
Throws:
java.lang.NullPointerException - if the supplied name is null

getName

public java.lang.String getName()
Gets the name of this OamManagedBean. This may take the form of a proprietary Managed Bean identifier.
Returns:
the name of this Managed Bean (MBean)

getObjectName

public ObjectName getObjectName()
Gets the ObjectName of this OamManagedObjectBean. An Object Name uniquely identifies an MBean within an MBean server. Management applications use this object name to identify the MBean on which to perform management operations. An object name is used in the same way as an object reference. Therefore all JAIN OAM methods accept an Object Name to identify an MBean instance rather than an object reference.

The class ObjectName represents an object name which consists of two parts.


[domainName]:property=value[,property=value]*
For all JAIN OAM MBeans, the domain name should be the package name of the implemenation class from which the object was instantiated.

e.g. com.aepona.jain.protocol.ss7.oam.sccp

The key property list for all JAIN OAM MBeans should consist of the two properties:


Therefore the complete objectName for an instance of
com.aepona.jain.protocol.ss7.oam.sccp.SccpSap
implementing the JAIN OAM MBean interface
com.aepona.jain.protocol.ss7.oam.sccp.SccpSapMBean
will be
"com.aepona.jain.protocol.ss7.oam.sccp:type=OBJECT_TYPE_SCCP_SAP,id=1234"
where 1234 could be any uniquely generated id by the SccpLayerManagerMBean Implemenation.

Returns:
the ObjectName of this Managed Bean (MBean).

getObjectId

public java.lang.String getObjectId()
Returns an object id that is unique within all objects of the same class. This is generated by the implementation layer manager in order to uniquely identify multiple instances of the same class. An implementation should implicitly set this id when an object is created. The String equivalent of this method is used as the 'id' property in the objectName.

getProprietaryInformation

public java.lang.Object getProprietaryInformation()
Returns an Object that may contain proprietary methods for this Managed Bean (MBean).
Returns:
- a proprietary Object containing additional proprietary information about this Managed Bean (MBean).

getObjectType

public java.lang.String getObjectType()
Returns the Object Type of this Managed Bean (MBean) as a String. For example, if an object 'mtpsSap_1' implements Mtp2SapMBean, then mtp2Sap_1.getObjectType() should return "OBJECT_TYPE_MTP2_SAP".
Returns:
the object type of this Managed Bean (MBean)


11 August 2000
If you have any comments or queries, please mail them to JainOamApiFeedback@AePONA.Com

Copyright - 2000 Sun Microsystems