jain.protocol.ss7.oam.mtp2
Interface Mtp2LayerManager


public abstract interface Mtp2LayerManager
extends OamLayerManager

This interface defines the methods required for the creation and management of all MTP Level 2 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.mtp2.Mtp2LayerManager interface must be jain.protocol.ss7.oam.mtp2.Mtp2LayerManagerImpl.

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 Mtp2LayerManager will be located at:
.jain.protocol.ss7.oam.mtp2.Mtp2LayerManagerImpl

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.mtp2.Mtp2LayerManagerImpl

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 addMtp2StatisticListener(Mtp2StatisticListener listener)
          Adds a Mtp2StatisticListener to the list of registered statistic listeners of the MTP2 layer.
 Mtp2SapMO createMtp2Sap(int portType)
          Creates a new Mtp2SapMO.
 Mtp2TimerProfileMO createMtp2TimerProfile()
          Creates a new Mtp2TimerProfileMO that will use the correct Timer values for the the protocol variant of this Mtp2LayerManager.
 void deleteMtp2Sap(Mtp2SapMO sap)
          Deletes the specified Mtp2SapMO.
 void deleteMtp2TimerProfile(Mtp2TimerProfileMO timerProfile)
          Deletes the specified Mtp2TimerProfileMO.
 Mtp2SapMO[] getActiveMtp2Sap()
          Returns all of the the Mtp2 Service Access Points.
 Mtp2SapMO getActiveMtp2Sap(int index)
          Returns one of the the Mtp2 Service Access Points.
 Mtp2SapMO[] getAllMtp2Saps()
          Returns all of the Mtp2 SAPS created by this layer manager
 Mtp2SapMO getAllMtp2Saps(int index)
          Returns one of the MTP2 SAPs created by this layer manager
 Mtp2TimerProfileMO[] getAllMtp2TimerProfiles()
          Returns all of the Mtp2 Timer Profiles created by this layer manager
 Mtp2TimerProfileMO getAllMtp2TimerProfiles(int index)
          Returns one of the MTP2 Timer Profiles created by this layer manager
 Mtp2StatisticEvent getStatistic(int statisticType, Mtp2ManagedObject managedObject)
          Returns a Mtp2StatisticEvent of the specified statistic type containing the value of the statistic for the specified managed object.
 void removeMtp2StatisticListener(Mtp2StatisticListener listener)
          Removes a MTP2 Statistic Listener from the list of registered statistic listeners of this MTP2 Layer Manager.
 void setActiveMtp2Sap(int index, Mtp2SapMO mtp2Sap)
          Sets one of the Mtp2 Service Access Points.
 void setActiveMtp2Sap(Mtp2SapMO[] mtp2Saps)
          Sets all of the Mtp2 Service Access Points.
 void startPollingStatistic(int statisticType, Mtp2ManagedObject managedObject, int interval)
          Initiates the polling of statistic of the specified statistic type for the specified managed object.
 void stopPollingStatistic(int statisticType, Mtp2ManagedObject 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

addMtp2StatisticListener

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

removeMtp2StatisticListener

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

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

getStatistic

public Mtp2StatisticEvent getStatistic(int statisticType,
                                       Mtp2ManagedObject managedObject)
                                throws StatisticNotSupportedException
Returns a Mtp2StatisticEvent 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 Managed Object (MO) for which the statistic is to be collected.
Returns:
the Mtp2StatisticEvent 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,
                                  Mtp2ManagedObject 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 MTP2 Statistic Event containing the value of the statistic will be sent asynchronously to the registered MTP2 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 MTP2 Statistic Listener until either:
Parameters:
statisticType - the type of the statistic to be polled [.getStatisticType() == statisticType]
managedObject - the Managed Object (MO) for which the statistic is to be collected.
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,
                                 Mtp2ManagedObject 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 MTP2 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.
managedObject - the 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.

createMtp2TimerProfile

public Mtp2TimerProfileMO createMtp2TimerProfile()
                                          throws TooManyInstancesException
Creates a new Mtp2TimerProfileMO that will use the correct Timer values for the the protocol variant of this Mtp2LayerManager. 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 - -

createMtp2Sap

public Mtp2SapMO createMtp2Sap(int portType)
                        throws TooManyInstancesException,
                               java.lang.IllegalArgumentException
Creates a new Mtp2SapMO.
Parameters:
portType - either:
  • Mtp2SapMO.PORT_TYPE_DTE - connects the transmit clock to the applicable line interface circuit
  • Mtp2SapMO.PORT_TYPE_DCE - connects the transmit clock to an internal baud rate generator and provides this clock to the applicable line interface circuit.
Returns:
the newly created Service Access Point
Throws:
TooManyInstancesException - - if the implementation cannot create any more SAPs
IllegalAgrumentException - - if the supplied port type is not one of the defined types

deleteMtp2TimerProfile

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

deleteMtp2Sap

public void deleteMtp2Sap(Mtp2SapMO sap)
Deletes the specified Mtp2SapMO. Note that once a Mtp2SapMO has been deleted, it should no longer be returned by the getAllMtp2Saps() method.

getActiveMtp2Sap

public Mtp2SapMO getActiveMtp2Sap(int index)
Returns one of the the Mtp2 Service Access Points.

There is a subtle difference between this method and the getAllMtp2Saps() method in that this method returns one of the MTP2 SAPs that are currently in use, whereas the getAllMtp2Saps() method returns one of all the MTP2 SAPs (both those Mtp2SapMOs currently in use and the Mtp2SapMOs that have been configured are not available for use for any reason including for backup). Every Mtp2SapMOs that was created through the setActiveMtp2Sap() method shall be returned by this method.

Parameters:
index - the index position of the SAP
Returns:
the MTP2 SAP at the specified position

setActiveMtp2Sap

public void setActiveMtp2Sap(int index,
                             Mtp2SapMO mtp2Sap)
                      throws TooManyInstancesException
Sets one of the Mtp2 Service Access Points.
Parameters:
index - the index position of the SAP
mtp2Sap - the MTP2 SAP to be set at the specified position
Throws:
TooManyInstancesException - - if index is greater than the number of Mtp2Saps permitted by this implementation.

getActiveMtp2Sap

public Mtp2SapMO[] getActiveMtp2Sap()
Returns all of the the Mtp2 Service Access Points.

There is a subtle difference between this method and the getAllMtp2Saps() method in that this method returns only the MTP2 SAPs that are currently in use, whereas the getAllMtp2Saps() method contains all MTP2 SAPs (both those Mtp2SapMOs currently in use and the Mtp2SapMOs that have been configured are not available for use for any reason including for backup). Every Mtp2SapMOs that was created through the setActiveMtp2Sap() method shall be returned by this method.

Returns:
all of the the Mtp2 Service Access Points.

setActiveMtp2Sap

public void setActiveMtp2Sap(Mtp2SapMO[] mtp2Saps)
                      throws TooManyInstancesException
Sets all of the Mtp2 Service Access Points.
Parameters:
mtp2Saps - all of the the Mtp2 Service Access Points.
Throws:
TooManyInstancesException - - if the size of the array is greater than the number of Mtp2Saps permitted by this implementation.
TooManyInstancesException - - if no more SAPs can be activated

getAllMtp2Saps

public Mtp2SapMO[] getAllMtp2Saps()
Returns all of the Mtp2 SAPS created by this layer manager

getAllMtp2Saps

public Mtp2SapMO getAllMtp2Saps(int index)
Returns one of the MTP2 SAPs created by this layer manager
Parameters:
index - the index of the MTP2 SAP in the list

getAllMtp2TimerProfiles

public Mtp2TimerProfileMO[] getAllMtp2TimerProfiles()
Returns all of the Mtp2 Timer Profiles created by this layer manager

getAllMtp2TimerProfiles

public Mtp2TimerProfileMO getAllMtp2TimerProfiles(int index)
Returns one of the MTP2 Timer Profiles created by this layer manager
Parameters:
index - the index of the MTP2 Timer Profiles 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