jain.protocol.ss7.oam.sccp
Interface SccpLayerManager


public abstract interface SccpLayerManager
extends OamLayerManager

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:

It must be noted that under the JAIN Naming Convention the lower-level package structure and classname of a proprietary implementation of the jain.protocol.ss7.oam.sccp.SccpLayerManager interface must be jain.protocol.ss7.oam.sccp.SccpLayerManagerImpl.

Under the JAIN naming convention, the upper-level package structure (pathname) can be used to differentiate between proprietary implementations from different SS7 Vendors. The pathname used by each SS7 Vendor must be the domain name assigned to the Vendor in reverse order, e.g. Sun Microsystem's would be 'com.sun'

It follows that a proprietary implementation of a SccpLayerManager will be located at:
.jain.protocol.ss7.oam.sccp.SccpLayerManagerImpl

Where:
pathname = reverse domain name, e.g. com.sun'

The resulting Peer JAIN SS7 Object would be located at: com.sun.jain.protocol.ss7.oam.sccp.SccpLayerManagerImpl

An application may create a JainTcapStackImpl by invoking the JainSs7Factory.createJainSS7Object() method. The PathName of the vendor specific implementation of which you want to instantiate can be set before calling this method or the default or current pathname may be used


Fields inherited from class jain.protocol.ss7.oam.OamLayerManager
PROTOCOL_VARIANT_ANSI, PROTOCOL_VARIANT_ITU, PROTOCOL_VARIANT_OTHER
 
Method Summary
 void addSccpStatisticListener(SccpStatisticListener listener)
          Adds a SccpStatisticListener to the list of registered statistic listeners of the SCCP layer.
 ConcernedAreaMO createConcernedArea(SccpSapMO[] remoteSubsystems)
          Creates a new Concerned Area Managed Object containing the specified remote Subsystems (SccpSaps).
 GlobalTitleEntryMO createGlobalTitleEntry(SccpEntitySetMO entitySet, int globalTitleIndicator, byte[] addressInformation)
          Creates a new Global Title Entry Managed Object.
 SccpEntitySetMO createSccpEntitySet(SccpSapMO[] destinationSubsystems, int sharingMode)
          Creates a new SCCP Entity Set Managed Object
 SccpRoutingControlMO createSccpRoutingControl(OwnSignallingPointMO sp, SccpSapMO[] subsystems)
          Creates a new Routing Control Managed Object for the specified Own Signalling Point and (local) Subsystems
 SccpSapMO createSccpSap(int ssn, Mtp3SapMO signallingPoint)
          Creates a new SCCP Sevice Access Point (SAP) Managed Object (a local or remote Subsystem)
 SccpTimerProfileMO createSccpTimerProfile()
          Creates a new SccpTimerProfileMO that will use the correct Timer values for the the protocol variant of this SccpLayerManager.
 void deleteConcernedArea(ConcernedAreaMO concernedArea)
          Deletes the specified Concerned Area Managed Object.
 void deleteGlobalTitleEntry(GlobalTitleEntryMO globalTitleEntry)
          Deletes the specified Global Title Entry Managed Object.
 void deleteSccpEntitySet(SccpEntitySetMO entitySet)
          Deletes the specified SCCP Entity Set Managed Object.
 void deleteSccpRoutingControl(SccpRoutingControlMO routingControl)
          Deletes the specified Routing Control Managed Object.
 void deleteSccpSap(SccpSapMO subSystem)
          Deletes the specified SCCP Sevice Access Point (SAP) Managed Object (a local or remote Subsystem).
 void deleteSccpTimerProfile(SccpTimerProfileMO timerProfile)
          Deletes the specified SccpTimerProfileMO.
 SccpRoutingControlMO[] getActiveSccpRoutingControl()
          Returns the Active SCCP Routing controls of this SCCP Layer Manager.
 SccpRoutingControlMO getActiveSccpRoutingControl(int index)
          Returns the Active SCCP Routing controls of this SCCP Layer Manager.
 ConcernedAreaMO[] getAllConcernedAreas()
          Returns all of the Concerned Areas created by this layer manager
 ConcernedAreaMO getAllConcernedAreas(int index)
          Returns one of the Concerned Areas created by this layer manager
 GlobalTitleEntryMO[] getAllGlobalTitleEntries()
          Returns all of the Global Tiltle Entries created by this layer manager
 GlobalTitleEntryMO getAllGlobalTitleEntries(int index)
          Returns one of the Global Tiltle Entries created by this layer manager
 SccpEntitySetMO[] getAllSccpEntitySets()
          Returns all of the SCCP Entity Sets created by this layer manager
 SccpEntitySetMO getAllSccpEntitySets(int index)
          Returns one of the SCCP Entity Sets created by this layer manager
 SccpRoutingControlMO[] getAllSccpRoutingControls()
          Returns all of the SCCP Routing Controls created by this layer manager
 SccpRoutingControlMO getAllSccpRoutingControls(int index)
          Returns one of the SCCP Routing Controls created by this layer manager
 SccpSapMO[] getAllSccpSaps()
          Returns all of the SCCP SAPs (Local or Remote Subsystems) created by this layer manager
 SccpSapMO getAllSccpSaps(int index)
          Returns one of the SCCP SAPs (Local or Remote Subsystems) created by this layer manager
 SccpTimerProfileMO[] getAllSccpTimerProfiles()
          Returns all of the SCCP Timer Profiles created by this layer manager
 SccpTimerProfileMO getAllSccpTimerProfiles(int index)
          Returns one of the SCCP Timer Profiles) created by this layer manager
 SccpStatisticEvent getStatistic(int statisticType, SccpManagedObject managedObject)
          Returns a SccpStatisticEvent of the specified statistic type containing the value of the statistic for the specified managed object.
 void removeSccpStatisticListener(SccpStatisticListener listener)
          Removes a SCCP Statistic Listener from the list of registered statistic listeners of this SCCP Layer Manager.
 void setActiveSccpRoutingControl(int index, SccpRoutingControlMO routingControl)
          Sets one of the Active SCCP Routing controls of this SCCP Layer Manager.
 void setActiveSccpRoutingControl(SccpRoutingControlMO[] routingControls)
          Sets the Active SCCP Routing controls of this SCCP Layer Manager.
 void startPollingStatistic(int statisticType, SccpManagedObject managedObject, int interval)
          Initiates the polling of statistic of the specified statistic type for the specified managed object.
 void stopPollingStatistic(int statisticType, SccpManagedObject managedObject)
          Stops the polling of statistic of the specified statistic type for the specified managed object.
 
Methods inherited from interface jain.protocol.ss7.oam.OamLayerManager
commit, getProtocolVariant, getProtocolYear, getVendorDetails, readCurrentConfiguration, setProtocolVariant, setProtocolYear
 

Method Detail

addSccpStatisticListener

public void addSccpStatisticListener(SccpStatisticListener listener)
                              throws java.util.TooManyListenersException,
                                     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 Manager as an Statistic Listener.

removeSccpStatisticListener

public void removeSccpStatisticListener(SccpStatisticListener listener)
                                 throws SS7ListenerNotRegisteredException
Removes a SCCP Statistic Listener from the list of registered statistic listeners of this SCCP Layer Manager. 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 Manager.

getStatistic

public SccpStatisticEvent getStatistic(int statisticType,
                                       SccpManagedObject managedObject)
                                throws StatisticNotSupportedException
Returns a SccpStatisticEvent of the specified statistic type containing the value of the statistic for the specified managed object. 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]
managedObject - the SCCP Managed Object (MO) for which the statistic is to be collected
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,
                                  SccpManagedObject managedObject,
                                  int interval)
                           throws StatisticNotSupportedException
Initiates the polling of statistic of the specified statistic type for the specified managed object. 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]
managedObject - the SCCP Managed Object (MO) for which the statistic is to be polled
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,
                                 SccpManagedObject managedObject)
                          throws IllegalOperationException
Stops the polling of statistic of the specified statistic type for the specified managed object.

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
invoking this operation will have no effect.

Parameters:
statisticType - the type of the statistic for which polling is to stop.
managedObject - the SCCP Managed Object (MO) for which the polling is to stop
Throws:
IllegalOperationException - - if the statistic is not being polled for the specified managed object and therefore it's polling cannot be stopped.

setActiveSccpRoutingControl

public void setActiveSccpRoutingControl(int index,
                                        SccpRoutingControlMO routingControl)
                                 throws TooManyInstancesException
Sets one of the Active SCCP Routing controls of this SCCP Layer Manager. 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
Throws:
TooManyInstancesException - - if index is greater than the number of active routing controls permitted for an SCCP Layer by this implementation.

getActiveSccpRoutingControl

public SccpRoutingControlMO getActiveSccpRoutingControl(int index)
Returns the Active SCCP Routing controls of this SCCP Layer Manager. 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.

There is a subtle difference between this method and the getAllSccpRoutingControls() method in that this method returns one the SCCP Routing Controls that are currently in use, whereas the getAllSccpRoutingControls() method contains all SCCP Routing Controls (both those Routing Controls currently in use and the Routing Controls that have been configured, but not activated for any reason including for backup). Every SCCP Routing Control that was created through the setActiveRoutingControl() method shall be returned by this method.

Parameters:
index - the index of the SCCP Routing Control to be returned.
Returns:
one of the active routing control

setActiveSccpRoutingControl

public void setActiveSccpRoutingControl(SccpRoutingControlMO[] routingControls)
                                 throws TooManyInstancesException
Sets the Active SCCP Routing controls of this SCCP Layer Manager. 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
Throws:
TooManyInstancesException - - if the size of routingControls is greater than the number of active Routing controls permitted for an SCCP Layer by this implementation.

getActiveSccpRoutingControl

public SccpRoutingControlMO[] getActiveSccpRoutingControl()
Returns the Active SCCP Routing controls of this SCCP Layer Manager. 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.

There is a subtle difference between this method and the getAllSccpRoutingControls() method in that this method returns only the SCCP Routing Controls that are currently in use, whereas the getAllSccpRoutingControls() method contains all SCCP Routing Controls (both those Routing Controls currently in use and the Routing Controls that have been configured, but not activated for any reason including for backup). Every SCCP Routing Control that was created through the setActiveRoutingControl() method shall be returned by this method.

Returns:
all of the active routing controls

createSccpTimerProfile

public SccpTimerProfileMO createSccpTimerProfile()
                                          throws TooManyInstancesException
Creates a new SccpTimerProfileMO that will use the correct Timer values for the the protocol variant of this SccpLayerManager. When the Timer Profile is created, the corresponding OamTimerVals should be created for each Timer with the correct min, max and default values set.
Returns:
the newly created Timer
Throws:
TooManyInstancesException - - if no more SCCP timer Profiles can be created by this implementation

createGlobalTitleEntry

public GlobalTitleEntryMO createGlobalTitleEntry(SccpEntitySetMO entitySet,
                                                 int globalTitleIndicator,
                                                 byte[] addressInformation)
                                          throws java.lang.IllegalArgumentException,
                                                 TooManyInstancesException
Creates a new Global Title Entry Managed Object.
Parameters:
entitySet - the entity set to which this entry translates to
globalTitleIndicator - one of the Global Title Indicator constants:
  • GlobalTitleEntryMO.GTINDICATOR_0000
  • GlobalTitleEntryMO.GTINDICATOR_0001
  • GlobalTitleEntryMO.GTINDICATOR_0010
  • GlobalTitleEntryMO.GTINDICATOR_0011
  • GlobalTitleEntryMO.GTINDICATOR_0100
addressInformation - the address information composed of digits in the form of Binary Coded Decimal(BCD).
Throws:
java.lang.IllegalArgumentException - - if
  • the supplied global tilte indicator is not one of the defined constants, or
  • the address information is in an unacceptable format
TooManyInstancesException - - if no more Global Title Entries can be created by this implementation

createConcernedArea

public ConcernedAreaMO createConcernedArea(SccpSapMO[] remoteSubsystems)
                                    throws TooManyInstancesException
Creates a new Concerned Area Managed Object containing the specified remote Subsystems (SccpSaps).
Parameters:
remoteSubsystems - the remote subsystems to be informed of local (primary broadcast) or remote (secondary broadcast) SCCP Subsystem status changes, or to be informed of the SCCP status after completion of SCCP Restart.
Throws:
TooManyInstancesException - - if
  • too many remote subsystems are supplied for the concerned area, or
  • no more Concerned Areas can be created by this implementation

createSccpSap

public SccpSapMO createSccpSap(int ssn,
                               Mtp3SapMO signallingPoint)
                        throws java.lang.IllegalArgumentException,
                               TooManyInstancesException
Creates a new SCCP Sevice Access Point (SAP) Managed Object (a local or remote Subsystem)
Parameters:
ssn - the subsystem number
signallingPoint - the signalling point of this subsystem
Throws:
java.lang.IllegalArgumentException - - if the supplied subsystem number represents an unnaceptable value
TooManyInstancesException - - if no more SCCP SAPs can be created by this implemntation

createSccpEntitySet

public SccpEntitySetMO createSccpEntitySet(SccpSapMO[] destinationSubsystems,
                                           int sharingMode)
                                    throws TooManyInstancesException
Creates a new SCCP Entity Set Managed Object
Parameters:
destinationSubsystems - the destination Subsystems (SCCP SAPs) of the Entity Set.
sharingMode - the sharing mode determining the distribution of SCCP traffic over the entities in this set. This may be one of:
  • SccpEntitySetMO.SM_SOLITARY - there can only be one access point in the set.
  • SccpEntitySetMO.SM_DUPLI_DOMINANT - the second entity is a backup for the first entity.
  • SccpEntitySetMO.SM_DUPLI_REPLACEMENT - the second entity is standby for backup for the first entity, but after changeover, the primary and backup roles are swapped.
  • SccpEntitySetMO.SM_DUPLI_SHARED - the load is shared over both the entities in the set.
Throws:
java.lang.IllegalArgumentException - - if the supplied saring mode is ot one of the defined constants
TooManyInstancesException - - if
  • too many destination subsystems are supplied for the Entity Set, or
  • no more SCCP Entity Sets can be created by this implementation

createSccpRoutingControl

public SccpRoutingControlMO createSccpRoutingControl(OwnSignallingPointMO sp,
                                                     SccpSapMO[] subsystems)
                                              throws TooManyInstancesException
Creates a new Routing Control Managed Object for the specified Own Signalling Point and (local) Subsystems
Parameters:
sp - the Own signalling point whose routing is to be controlled by this Routing Control function.
subsystems - the local subsystems controlled by this Routing Control.
Throws:
TooManyInstancesException - - if
  • too many subsystems are supplied for the created SCCP Routing Control, or
  • no more SCCP Routing Control MOs can be created by this implementation

deleteSccpTimerProfile

public void deleteSccpTimerProfile(SccpTimerProfileMO timerProfile)
Deletes the specified SccpTimerProfileMO. Note that once a SccpTimerProfileMO has been deleted, it should no longer be returned by the getAllSccpTimerProfiles() method.

deleteGlobalTitleEntry

public void deleteGlobalTitleEntry(GlobalTitleEntryMO globalTitleEntry)
Deletes the specified Global Title Entry Managed Object. Note that once a GlobalTitleEntryMO has been deleted, it should no longer be returned by the getAllGlobalTitleEntries() method.

deleteConcernedArea

public void deleteConcernedArea(ConcernedAreaMO concernedArea)
Deletes the specified Concerned Area Managed Object. Note that once a ConcernedAreaMO has been deleted, it should no longer be returned by the getAllConcernedAreas() method.

deleteSccpSap

public void deleteSccpSap(SccpSapMO subSystem)
Deletes the specified SCCP Sevice Access Point (SAP) Managed Object (a local or remote Subsystem). Note that once a SccpSapMO has been deleted, it should no longer be returned by the getAllSccpSaps() method.

deleteSccpEntitySet

public void deleteSccpEntitySet(SccpEntitySetMO entitySet)
Deletes the specified SCCP Entity Set Managed Object. Note that once a SccpEntitySetMO has been deleted, it should no longer be returned by the getAllSccpEntitySet() method.

deleteSccpRoutingControl

public void deleteSccpRoutingControl(SccpRoutingControlMO routingControl)
Deletes the specified Routing Control Managed Object. Note that once a SccpRoutingControlMO has been deleted, it should no longer be returned by the getAllSccpRoutingControls() method.

getAllSccpSaps

public SccpSapMO[] getAllSccpSaps()
Returns all of the SCCP SAPs (Local or Remote Subsystems) created by this layer manager

getAllSccpSaps

public SccpSapMO getAllSccpSaps(int index)
Returns one of the SCCP SAPs (Local or Remote Subsystems) created by this layer manager
Parameters:
index - the index of the Subsystem in the list

getAllSccpTimerProfiles

public SccpTimerProfileMO[] getAllSccpTimerProfiles()
Returns all of the SCCP Timer Profiles created by this layer manager

getAllSccpTimerProfiles

public SccpTimerProfileMO getAllSccpTimerProfiles(int index)
Returns one of the SCCP Timer Profiles) created by this layer manager
Parameters:
index - the index of the SCCP Timer Profile in the list

getAllSccpRoutingControls

public SccpRoutingControlMO[] getAllSccpRoutingControls()
Returns all of the SCCP Routing Controls created by this layer manager

getAllSccpRoutingControls

public SccpRoutingControlMO getAllSccpRoutingControls(int index)
Returns one of the SCCP Routing Controls created by this layer manager
Parameters:
index - the index of the SCCP Routing Control in the list

getAllGlobalTitleEntries

public GlobalTitleEntryMO[] getAllGlobalTitleEntries()
Returns all of the Global Tiltle Entries created by this layer manager

getAllGlobalTitleEntries

public GlobalTitleEntryMO getAllGlobalTitleEntries(int index)
Returns one of the Global Tiltle Entries created by this layer manager
Parameters:
index - the index of the Global Tiltle Entry in the list

getAllSccpEntitySets

public SccpEntitySetMO[] getAllSccpEntitySets()
Returns all of the SCCP Entity Sets created by this layer manager

getAllSccpEntitySets

public SccpEntitySetMO getAllSccpEntitySets(int index)
Returns one of the SCCP Entity Sets created by this layer manager
Parameters:
index - the index of the SCCP Entity Set in the list

getAllConcernedAreas

public ConcernedAreaMO[] getAllConcernedAreas()
Returns all of the Concerned Areas created by this layer manager

getAllConcernedAreas

public ConcernedAreaMO getAllConcernedAreas(int index)
Returns one of the Concerned Areas created by this layer manager
Parameters:
index - the index of the Concerned Area in the list


06 January 2000
If you have any comments or queries, please mail them to Colm Hayden [JAIN SS7 OAM Edit Lead]

Copyright - 2000 Sun Microsystems