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. Logically, more than one Signalling Point may exist on the same system. The SCCP routing information for each logical signalling point is contained in the SCCP Routing Control MO, with each SCCP Routing Control MO having only one Own Signalling Point MO associated with it. It follows that there will be one SCCP Routing Control MO instance for each local Signalling Point.

This interface 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 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
 LocalSubSystemMO createLocalSubSystem()
          Creates a new Local SubSystem Managed Object
 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 (a remote SubSystem)
 SccpTimerProfile createSccpTimerProfile(int variant)
          Creates a new SccpTimerProfileMO that will use the Timer values defined in the specified protocol variant.
 SccpRoutingControlMO[] getRoutingControl()
          Returns the SCCP Routing controls for each of the logical signalling points of this SCCP.
 SccpRoutingControlMO getRoutingControl(int index)
          Returns the SCCP Routing control for one of the logical signalling points of this SCCP.
 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(int index, SccpRoutingControlMO routingControl)
          Sets the SCCP Routing control for one of the logical signalling points of this SCCP.
 void setRoutingControl(SccpRoutingControlMO[] routingControls)
          Sets the SCCP Routing controls for all of the logical signalling points of this SCCP.
 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.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:
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,
                                  int 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:
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.

setRoutingControl

public void setRoutingControl(int index,
                              SccpRoutingControlMO routingControl)
Sets the SCCP Routing control for one of the logical signalling points of this SCCP. If the underlying system supports multiple local signalling points then an instance of the SCCP Routing Control MO should be created for each local Signalling Point.
Parameters:
index - the index of the SCCP Routing Control to be set.
routingControl - the routing control

getRoutingControl

public SccpRoutingControlMO getRoutingControl(int index)
Returns the SCCP Routing control for one of the logical signalling points of this SCCP. If the underlying system supports multiple local signalling points then an instance of the SCCP Routing Control MO should have been created for each local Signalling Point.
Parameters:
index - the index of the SCCP Routing Control to be returned.
Returns:
the routing control

setRoutingControl

public void setRoutingControl(SccpRoutingControlMO[] routingControls)
Sets the SCCP Routing controls for all of the logical signalling points of this SCCP. If the underlying system supports multiple local signalling points then an instance of the SCCP Routing Control MO should be created for each local Signalling Point.
Parameters:
routingControls - all of the routing controls

getRoutingControl

public SccpRoutingControlMO[] getRoutingControl()
Returns the SCCP Routing controls for each of the logical signalling points of this SCCP. If the underlying system supports multiple local signalling points then an instance of the SCCP Routing Control MO should have been created for each local Signalling Point.
Returns:
all of the routing controls

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

createGlobalTitleEntry

public GlobalTitleEntryMO createGlobalTitleEntry()
Creates a new Global Title Entry Managed Object

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 (a remote SubSystem)

createSccpEntitySet

public SccpEntitySetMO createSccpEntitySet()
Creates a new SCCP Entity Set Managed Object

createSccpRoutingControl

public SccpRoutingControlMO createSccpRoutingControl()
Creates a new Routing Control Managed Object

createLocalSubSystem

public LocalSubSystemMO createLocalSubSystem()
Creates a new Local SubSystem Managed Object


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

Copyright - 1999 Sun Microsystems