jain.protocol.ss7.oam.mtp2
Interface Mtp2LayerMO


public abstract interface Mtp2LayerMO
extends Mtp2ManagedObject, OamLayer

This interface defines the methods required for the creation and management of all MTP Level 2 Managed Objects. It defines the methods to:


Fields inherited from class jain.protocol.ss7.oam.OamLayer
PROTOCOL_VERSION_ANSI, PROTOCOL_VERSION_ITU, PROTOCOL_VERSION_OTHER
 
Fields inherited from class java.io.Serializable
serialVersionUID
 
Method Summary
 void addMtp2StatisticListener(Mtp2StatisticListener listener)
          Adds a Mtp2StatisticListener to the list of registered statistic listeners of the MTP2 layer.
 Mtp2SapMO createMtp2SapMO()
          Creates a new Mtp2SapMO.
 Mtp2TimerProfile createMtp2TimerProfileMO(int variant)
          Creates a new Mtp2TimerProfileMO that will use the Timer values defined in the specified protocol variant.
 Mtp2SapMO getMtp2Sap()
          Returns the Mtp2 Service Access Point.
 Mtp2StatisticEvent getStatistic(int statisticType)
          Returns a Mtp2StatisticEvent of the specified statistic type containing the value of the statistic.
 void removeMtp2StatisticListener(Mtp2StatisticListener listener)
          Removes a MTP2 Statistic Listener from the list of registered statistic listeners of this MTP2 Layer MO.
 void setMtp2Sap(Mtp2SapMO mtp2Sap)
          Sets the Mtp2 Service Access Point.
 void startPollingStatistic(int statisticType, int interval)
          Initiates the polling of statistic of the specified statistic type.
 void stopPollingStatistic(int statisticType)
          Stops the polling of statistic of the specified statistic type.
 
Methods inherited from interface jain.protocol.ss7.oam.mtp2.Mtp2ManagedObject
addMtp2AlarmListener, addMtp2ErrorListener, removeMtp2AlarmListener, removeMtp2ErrorListener
 
Methods inherited from interface jain.protocol.ss7.oam.OamLayer
commit, getProtocolVariant, getProtocolYear, readCurrentConfiguration, setProtocolVariant
 
Methods inherited from interface jain.protocol.ss7.oam.OamManagedObject
addPropertyChangeListener, getName, removePropertyChangeListener, setName
 

Method Detail

addMtp2StatisticListener

public void addMtp2StatisticListener(Mtp2StatisticListener listener)
                              throws java.util.TooManyListenersException,
                                     jain.protocol.ss7.SS7ListenerAlreadyRegisteredException
Adds a Mtp2StatisticListener to the list of registered statistic listeners of the MTP2 layer.
A MTP2 Statistic Listener will be continually sent Statistic Events for a particular statistic at set intervals from the point at which the Listener starts polling the statistic until the point at which the Listener either:
Parameters:
listener - the MTP2 Statistic Listener to be added.
Throws:
TooManyListenersException - thrown if a limit is placed on the allowable number of registered MTP2 Statistic Listeners by the implementation, and this limit is exceeded.
SS7ListenerAlreadyRegisteredException - thrown if an attempt is made to register a MTP2 Statistic Listener that is already registered with this MTP2 Layer MO as an Statistic Listener.

removeMtp2StatisticListener

public void removeMtp2StatisticListener(Mtp2StatisticListener listener)
                                 throws jain.protocol.ss7.SS7ListenerNotRegisteredException
Removes a MTP2 Statistic Listener from the list of registered statistic listeners of this MTP2 Layer MO. Once removed, a MTP2 statistic listener will no longer receive any MTP2 Statistic Events for statistics that the Listener started polling, but did not explicitly stop polling.

     ie.   Removing a MTP2 Statistic Listener application implicitly stops the polling
           of all of the applications statistics.
 
Parameters:
listener - the MTP2 Statistic Listener to be removed.
Throws:
SS7ListenerNotRegisteredException - thrown if the MTP2 Statistic Listener to be removed is not registered as an Statistic Listener of MTP2 Layer MO.

getStatistic

public Mtp2StatisticEvent getStatistic(int statisticType)
                                throws StatisticNotSupportedException
Returns a Mtp2StatisticEvent of the specified statistic type containing the value of the statistic. 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 Mtp2StatisticEvent containing the requested statistic.
Throws:
StatisticNotSupportedException - if the specified statistic is not supported (cannot be collected) by the underlying Stack management system.

startPollingStatistic

public void startPollingStatistic(int statisticType,
                                  int interval)
                           throws StatisticNotSupportedException
Initiates the polling of statistic of the specified statistic type. Each time the specified interval expires, a MTP2 Statistic Event containing the value of the statistic will be sent asynchronously to the registered MTP2 Statistic Listener that started polling the statistic (by invoking this method). The specified statistic shall be continually sent after the specified interval to the registered MTP2 Statistic Listener 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.

stopPollingStatistic

public void stopPollingStatistic(int statisticType)
Stops the polling of statistic of the specified statistic type. If the specified statistic is currently being polled by the Listener that invoked this method then this polling will stop and the specified statistic shall no longer be sent to the registered MTP2 Statistic Listener.
If the specified statistic is not longer being polled by the Listener 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.

createMtp2TimerProfileMO

public Mtp2TimerProfile createMtp2TimerProfileMO(int variant)
Creates a new Mtp2TimerProfileMO that will use the Timer values defined in the specified protocol variant.
Parameters:
variant - either:
  • jain.protocol.ss7.oam.OamTimerProfile.ITU - Values defined in ITU Q.702 Section 12.2
  • jain.protocol.ss7.oam.OamTimerProfile.ANSI - Values defined in ANSI T1.111 Paragraph 12.2
Returns:
the newly created Timer

createMtp2SapMO

public Mtp2SapMO createMtp2SapMO()
Creates a new Mtp2SapMO.
Returns:
the newly created Service Access Point

getMtp2Sap

public Mtp2SapMO getMtp2Sap()
Returns the Mtp2 Service Access Point.

setMtp2Sap

public void setMtp2Sap(Mtp2SapMO mtp2Sap)
Sets the Mtp2 Service Access Point.


20 September 99
If you have any comments or queries, please mail them to JainOAM@East.Sun.Com

Copyright - 1999 Sun Microsystems