jain.protocol.ss7.oam.tcap
Interface TcapLayerManager


public abstract interface TcapLayerManager
extends OamLayerManager

This interface defines the methods required for the creation and management of all TCAP Managed Objects. It 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.tcap.TcapLayerManager interface must be jain.protocol.ss7.oam.tcap.TcapLayerManagerImpl.

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 TcapLayerManager will be located at:
.jain.protocol.ss7.oam.tcap.TcapLayerManagerImpl

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.tcap.TcapLayerManagerImpl

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 addTcapStatisticListener(TcapStatisticListener listener)
          Adds a TcapStatisticListener to the list of registered statistic listeners of the TCAP layer.
 TcapNodeMO createTcapNode(OwnSignallingPointMO sp, SccpSapMO[] subsystems)
          Creates a new TcapNodeMO for the specified local signalling point and subsystem.
 void deleteTcapNode(TcapNodeMO tcap)
          Deletes the specified TcapNodeMO.
 TcapNodeMO[] getActiveTcapNode()
          Returns all of the active TCAP layers managed by this TCAP Layer Manager.
 TcapNodeMO getActiveTcapNode(int index)
          Returns one of the active TCAP layers managed by this TCAP Layer Manager.
 TcapNodeMO[] getAllTcapNodes()
          Returns all of the TCAP layers managed by this TCAP Layer Manager.
 TcapNodeMO getAllTcapNodes(int index)
          Returns one of the TCAP layers managed by this TCAP Layer Manager.
 TcapStatisticEvent getStatistic(int statisticType, TcapManagedObject managedObject)
          Returns a TcapStatisticEvent of the specified statistic type containing the value of the statistic for the specified managed object.
 void removeTcapStatisticListener(TcapStatisticListener listener)
          Removes a TCAP Statistic Listener from the list of registered statistic listeners of this TCAP Layer Manager.
 void setActiveTcapNode(int index, TcapNodeMO tcapLayer)
          Sets one of the active TCAP layers managed by this TCAP Layer Manager.
 void setActiveTcapNode(TcapNodeMO[] tcapLayers)
          Sets all of the active TCAP layers managed by this TCAP Layer Manager.
 void startPollingStatistic(int statisticType, TcapManagedObject managedObject, int interval)
          Initiates the polling of statistic of the specified statistic type for the specified managed object.
 void stopPollingStatistic(int statisticType, TcapManagedObject 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

addTcapStatisticListener

public void addTcapStatisticListener(TcapStatisticListener listener)
                              throws java.util.TooManyListenersException,
                                     SS7ListenerAlreadyRegisteredException
Adds a TcapStatisticListener to the list of registered statistic listeners of the TCAP layer.
A TCAP 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 TCAP Statistic Listener to be added.
Throws:
TooManyListenersException - thrown if a limit is placed on the allowable number of registered TCAP Statistic Listeners by the implementation, and this limit is exceeded.
SS7ListenerAlreadyRegisteredException - thrown if an attempt is made to register a TCAP Statistic Listener that is already registered with this TCAP Layer Manager as an Statistic Listener.

removeTcapStatisticListener

public void removeTcapStatisticListener(TcapStatisticListener listener)
                                 throws SS7ListenerNotRegisteredException
Removes a TCAP Statistic Listener from the list of registered statistic listeners of this TCAP Layer Manager. Once removed, a TCAP statistic listener will no longer receive any TCAP Statistic Events for statistics that the Listener started polling, but did not explicitly stop polling.

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

getStatistic

public TcapStatisticEvent getStatistic(int statisticType,
                                       TcapManagedObject managedObject)
                                throws StatisticNotSupportedException
Returns a TcapStatisticEvent 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 TCAP Managed Object (MO) for which the statistic is to be collected
Returns:
the TcapStatisticEvent 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,
                                  TcapManagedObject 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 TCAP Statistic Event containing the value of the statistic will be sent asynchronously to the registered TCAP 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 TCAP 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,
                                 TcapManagedObject 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 TCAP 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 TCAP 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.

setActiveTcapNode

public void setActiveTcapNode(int index,
                              TcapNodeMO tcapLayer)
                       throws TooManyInstancesException
Sets one of the active TCAP layers managed by this TCAP Layer Manager. There will be one instance of a local TCAP per local signalling point. Where multiple logical signalling points exist within the one physical stack, there will be several local TCAP instances.
Parameters:
index - the position of the TCAP layer in the array of TCAP layers managed by this TCAP Layer Manager.
tcapLayer - the TCAP Layer
Throws:
TooManyInstancesException - - if no more TCAP Nodes can be activated by this implementation

getActiveTcapNode

public TcapNodeMO getActiveTcapNode(int index)
Returns one of the active TCAP layers managed by this TCAP Layer Manager. There will be one instance of a local TCAP per local signalling point. Where multiple logical signalling points exist within the one physical stack, there will be several local TCAP instances.

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

Parameters:
index - the position of the TCAP layer in the array of TCAP layers managed by this TCAP Layer Manager.
Returns:
one of the active TCAPs

setActiveTcapNode

public void setActiveTcapNode(TcapNodeMO[] tcapLayers)
                       throws TooManyInstancesException
Sets all of the active TCAP layers managed by this TCAP Layer Manager. There will be one instance of a local TCAP per local signalling point. Where multiple logical signalling points exist within the one physical stack, there will be several local TCAP instances.
Parameters:
tcapLayers - all of the TCAP Layer
Throws:
TooManyInstancesException - - if no more tcap nodes can be actvated by this implementation

getActiveTcapNode

public TcapNodeMO[] getActiveTcapNode()
Returns all of the active TCAP layers managed by this TCAP Layer Manager. There will be one instance of a local TCAP per local signalling point. Where multiple logical signalling points exist within the one physical stack, there will be several local TCAP instances.

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

Returns:
all of the TCAP Layers

createTcapNode

public TcapNodeMO createTcapNode(OwnSignallingPointMO sp,
                                 SccpSapMO[] subsystems)
                          throws TooManyInstancesException
Creates a new TcapNodeMO for the specified local signalling point and subsystem.
Parameters:
sp - the signalling point of the TCAP layer
subsystems - the susbsystems of the TCAP layer.
Throws:
TooManyInstancesException - if
  • too many subsystems were supplied for the signalling point, or
  • no more Tcap Nodes can be created by this implementation

deleteTcapNode

public void deleteTcapNode(TcapNodeMO tcap)
Deletes the specified TcapNodeMO. Note that once a TcapNodeMO has been deleted, it should no longer be returned by the getAllTcapNodes() method.

getAllTcapNodes

public TcapNodeMO getAllTcapNodes(int index)
Returns one of the TCAP layers managed by this TCAP Layer Manager. Every TcapNodeMO that was created through the setActiveTcapNode() method shall by the getActiveTcapNode() method.

Parameters:
index - the position of the TCAP layer in the array of TCAP layers managed by this TCAP Layer Manager.
Returns:
one of the created TCAPs

getAllTcapNodes

public TcapNodeMO[] getAllTcapNodes()
Returns all of the TCAP layers managed by this TCAP Layer Manager. Every TcapNodeMO that was created through the setActiveTcapNode() method shall by the getActiveTcapNode() method.
Returns:
all of the created TCAPs


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