jain.protocol.ss7.oam.mtp3
Interface Mtp3LayerMO

public abstract interface Mtp3LayerMO

extends Mtp3ManagedObject, OamLayer

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

• Add a MTP3 Statistic Listener to this Mtp3LayerMO's list of registered Statistic Listeners.
  An application must register with this MTP3 Layer Managed Object (MO) as a MTP3 Statistic Listener in order to receive MTP3 Statictics that are being polled asynchronously. When a Statictic is being polled asynchronously, the Statistic value will be sent (as a MTP3 Statistic Event) at the end of each polling interval to the statistic Listener that started to poll the statistic.

• Remove a MTP3 Statictic Listener from this Mtp3LayerMO's list of registered Statistic Listeners.
  Once a MTP3 Statictic Listener has been removed from the list, it will no longer receive MTP3 Statistic Events from this Mtp3LayerMO (even if the Listener has not expicitly stopped the polling of the statistics in which it had previously started polling).

• Collect MTP3 Statistics.
  Statistics may be collected either:
  • Synchronously: where the statistic is returned immediately (once per method invocation).
  • Asynchronously: where polling of the statistic is started and the statistic is returned at set intervals until the statistic polling is stopped (either explicitly or implicitly).

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	addMtp3StatisticListener(Mtp3StatisticListener listener) Adds a Mtp3StatisticListener to the list of registered statistic listeners of the MTP3 layer.
LinkMO	createLink() Creates a new Link Managed Object
LinkSetMO	createLinkSet() Creates a new LinkSet Managed Object
Mtp3SapMO	createMtp3Sap() Creates a new Mtp3 Service Access Point MO
Mtp3TimerProfile	createMtp3TimerProfile() Creates a new Mtp3 Timer Profile MO
Mtp3TimerProfile	createMtp3TimerProfile(int variant) Creates a new Mtp3TimerProfileMO that will use the Timer values defined in the specified protocol variant.
RouteMO	createRoute() Creates a new Route Managed Object
RouteSetMO	createRouteSet() Creates a new RouteSet Managed Object
ScreeningTableMO	createScreeningTable() Creates a new Screening Table managed object
SignallingPointMO	createSignallingPoint() Creates a new Mtp Signalling Point Managed Object
Mtp3TimerProfile	getMtp3TimerProfile() Returns the MTP3 Timer Profile containing the MTP3 Timer values
SignallingPointMO	getSignallingPoint() Returns the Signalling Point.
Mtp3StatisticEvent	getStatistic(int statisticType) Returns a Mtp3StatisticEvent of the specified statistic type containing the value of the statistic.
void	removeMtp3StatisticListener(Mtp3StatisticListener listener) Removes a MTP3 Statistic Listener from the list of registered statistic listeners of this MTP3 Layer MO.
void	setMtp3TimerProfile(Mtp3TimerProfile timerProfile) Sets the MTP3 Timer Profile containing the MTP3 Timer values
void	setSignallingPoint(SignallingPointMO signallingPoint) Sets the Signalling Point.
void	startPollingStatistic(int statisticType, long 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.mtp3.Mtp3ManagedObject

addMtp3AlarmListener, addMtp3ErrorListener, removeMtp3AlarmListener, removeMtp3ErrorListener

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

addMtp3StatisticListener

public void addMtp3StatisticListener(Mtp3StatisticListener listener)
                              throws java.util.TooManyListenersException,
                                     jain.protocol.ss7.SS7ListenerAlreadyRegisteredException

Adds a Mtp3StatisticListener to the list of registered statistic listeners of the MTP3 layer.
A MTP3 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:

• Explicitly stops polling the statistic by invoking the stopPollingStatistic() method, or
• Is removed from the list of MTP3 Statistic Listeners by invoking the removeMtp3StatisticListener() method.

Parameters:

listener - the MTP3 Statistic Listener to be added.

Throws:

TooManyListenersException - thrown if a limit is placed on the allowable number of registered MTP3 Statistic Listeners by the implementation, and this limit is exceeded.

SS7ListenerAlreadyRegisteredException - thrown if an attempt is made to register a MTP3 Statistic Listener that is already registered with this MTP3 Layer MO as an Statistic Listener.

removeMtp3StatisticListener

public void removeMtp3StatisticListener(Mtp3StatisticListener listener)
                                 throws jain.protocol.ss7.SS7ListenerNotRegisteredException

Removes a MTP3 Statistic Listener from the list of registered statistic listeners of this MTP3 Layer MO. Once removed, a MTP3 statistic listener will no longer receive any MTP3 Statistic Events for statistics that the Listener started polling, but did not explicitly stop polling.

     ie.   Removing a MTP3 Statistic Listener application implicitly stops the polling
           of all of the applications statistics.
 

Parameters:

listener - the MTP3 Statistic Listener to be removed.

Throws:

SS7ListenerNotRegisteredException - thrown if the MTP3 Statistic Listener to be removed is not registered as an Statistic Listener of MTP3 Layer MO.

getStatistic

public Mtp3StatisticEvent getStatistic(int statisticType)
                                throws StatisticNotSupportedException

Returns a Mtp3StatisticEvent 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 Mtp3StatisticEvent 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,
                                  long interval)
                           throws StatisticNotSupportedException

Initiates the polling of statistic of the specified statistic type. Each time the specified interval expires, a MTP3 Statistic Event containing the value of the statistic will be sent asynchronously to the registered MTP3 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 MTP3 Statistic Listener until either:

• the polling of this statistic is explicitly stopped by the listener invoking the stopPollingStatistic() method, or
• the Listener is removed from the list of MTP3 Statistic Listeners by invoking the removeMtp3StatisticListener() method.

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

createMtp3TimerProfile

public Mtp3TimerProfile createMtp3TimerProfile(int variant)

Creates a new Mtp3TimerProfileMO that will use the Timer values defined in the specified protocol variant.

Parameters:

variant - either:

• jain.protocol.ss7.oam.OamTimer.ITU - Values defined in ITU Q.703 Section 12.3
• jain.protocol.ss7.oam.OamTimer.ANSI - Values defined in ANSI T1.111 Paragraph 12.3

Returns:

the newly created Timer

getMtp3TimerProfile

public Mtp3TimerProfile getMtp3TimerProfile()

Returns the MTP3 Timer Profile containing the MTP3 Timer values

Returns:

the MTP3 Timer Profile

setMtp3TimerProfile

public void setMtp3TimerProfile(Mtp3TimerProfile timerProfile)

Sets the MTP3 Timer Profile containing the MTP3 Timer values

Parameters:

timerProfile - the MTP3 Timer Profile

createLink

public LinkMO createLink()

Creates a new Link Managed Object

createLinkSet

public LinkSetMO createLinkSet()

Creates a new LinkSet Managed Object

createRoute

public RouteMO createRoute()

Creates a new Route Managed Object

createRouteSet

public RouteSetMO createRouteSet()

Creates a new RouteSet Managed Object

createSignallingPoint

public SignallingPointMO createSignallingPoint()

Creates a new Mtp Signalling Point Managed Object

createMtp3Sap

public Mtp3SapMO createMtp3Sap()

Creates a new Mtp3 Service Access Point MO

createMtp3TimerProfile

public Mtp3TimerProfile createMtp3TimerProfile()

Creates a new Mtp3 Timer Profile MO

createScreeningTable

public ScreeningTableMO createScreeningTable()

Creates a new Screening Table managed object

setSignallingPoint

public void setSignallingPoint(SignallingPointMO signallingPoint)

Sets the Signalling Point.

Parameters:

signallingPoint - the Signalling Point

getSignallingPoint

public SignallingPointMO getSignallingPoint()

Returns the Signalling Point.

Returns:

the Signalling Point