jain.protocol.ss7.oam.sccp
Interface SccpLayerMO

public abstract interface SccpLayerMO

extends SccpManagedObject, OamLayer

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

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

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

• Collect SCCP 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	addSccpStatisticListener(SccpStatisticListener listener) Adds a SccpStatisticListener to the list of registered statistic listeners of the SCCP layer.
ConcernedAreaMO	createConcernedArea() Creates a new Concerned Area Managed Object
GlobalTitleEntryMO	createGlobalTitleEntry() Creates a new Global Title Entry Managed Object
GlobalTitleEntryMO[]	createGlobalTitleEntryRange(int lowerEntry, int upperEntry, SignallingPointMO signallingPoint) Creates an array of Global Title Entries for a specific range of GlobalTitle Entrys, that have the same Signalling Point.
SccpEntitySetMO	createSccpEntitySet() Creates a new SCCP Entity Set Managed Object
SccpRoutingControlMO	createSccpRoutingControl() Creates a new Routing Control Managed Object
SccpSapMO	createSccpSap() Creates a new SCCP Sevice Access Point (SAP) Managed Object
SccpTimerProfile	createSccpTimerProfile() Creates a new Timer Profile Managed Object
SccpTimerProfile	createSccpTimerProfile(int variant) Creates a new SccpTimerProfileMO that will use the Timer values defined in the specified protocol variant.
SubSystemMO	createSubSystem() Creates a new SubSystem Managed Object
SccpRoutingControlMO	getRoutingControl() Returns the SCCP Routing control of this SCCP
SccpTimerProfile	getSccpTimerProfile() Returns the SCCP Timer Profile containing the SCCP Timer values
SccpStatisticEvent	getStatistic(int statisticType) Returns a SccpStatisticEvent of the specified statistic type containing the value of the statistic.
void	removeSccpStatisticListener(SccpStatisticListener listener) Removes a SCCP Statistic Listener from the list of registered statistic listeners of this SCCP Layer MO.
void	setRoutingControl(SccpRoutingControlMO scrc) Sets the SCCP Routing control for this SCCP.
void	setSccpTimerProfile(SccpTimerProfile timerProfile) Sets the SCCP Timer Profile containing the SCCP Timer values
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.sccp.SccpManagedObject

addSccpAlarmListener, addSccpErrorListener, removeSccpAlarmListener, removeSccpErrorListener

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

addSccpStatisticListener

public void addSccpStatisticListener(SccpStatisticListener listener)
                              throws java.util.TooManyListenersException,
                                     jain.protocol.ss7.SS7ListenerAlreadyRegisteredException

Adds a SccpStatisticListener to the list of registered statistic listeners of the SCCP layer.
A SCCP 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 SCCP Statistic Listeners by invoking the removeSccpStatisticListener() method.

Parameters:

listener - the SCCP Statistic Listener to be added.

Throws:

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

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

removeSccpStatisticListener

public void removeSccpStatisticListener(SccpStatisticListener listener)
                                 throws jain.protocol.ss7.SS7ListenerNotRegisteredException

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

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

Parameters:

listener - the SCCP Statistic Listener to be removed.

Throws:

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

getStatistic

public SccpStatisticEvent getStatistic(int statisticType)
                                throws StatisticNotSupportedException

Returns a SccpStatisticEvent 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 SccpStatisticEvent 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 SCCP Statistic Event containing the value of the statistic will be sent asynchronously to the registered SCCP 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 SCCP 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 SCCP Statistic Listeners by invoking the removeSccpStatisticListener() 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 SCCP 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.

createSccpTimerProfile

public SccpTimerProfile createSccpTimerProfile(int variant)

Creates a new SccpTimerProfileMO 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

getSccpTimerProfile

public SccpTimerProfile getSccpTimerProfile()

Returns the SCCP Timer Profile containing the SCCP Timer values

Returns:

the SCCP Timer Profile

setSccpTimerProfile

public void setSccpTimerProfile(SccpTimerProfile timerProfile)

Sets the SCCP Timer Profile containing the SCCP Timer values

Parameters:

timerProfile - the SCCP Timer Profile

setRoutingControl

public void setRoutingControl(SccpRoutingControlMO scrc)

Sets the SCCP Routing control for this SCCP.

Parameters:

scrc - the routing control

getRoutingControl

public SccpRoutingControlMO getRoutingControl()

Returns the SCCP Routing control of this SCCP

Returns:

the routing control

createGlobalTitleEntry

public GlobalTitleEntryMO createGlobalTitleEntry()

Creates a new Global Title Entry Managed Object

createGlobalTitleEntryRange

public GlobalTitleEntryMO[] createGlobalTitleEntryRange(int lowerEntry,
                                                        int upperEntry,
                                                        SignallingPointMO signallingPoint)

Creates an array of Global Title Entries for a specific range of GlobalTitle Entrys, that have the same Signalling Point. This method can be used as a 'wildcard' type creation.

createConcernedArea

public ConcernedAreaMO createConcernedArea()

Creates a new Concerned Area Managed Object

createSccpSap

public SccpSapMO createSccpSap()

Creates a new SCCP Sevice Access Point (SAP) Managed Object

createSccpEntitySet

public SccpEntitySetMO createSccpEntitySet()

Creates a new SCCP Entity Set Managed Object

createSccpRoutingControl

public SccpRoutingControlMO createSccpRoutingControl()

Creates a new Routing Control Managed Object

createSccpTimerProfile

public SccpTimerProfile createSccpTimerProfile()

Creates a new Timer Profile Managed Object

createSubSystem

public SubSystemMO createSubSystem()

Creates a new SubSystem Managed Object