jain.protocol.ss7.oam.tcap
Interface TcapLayerMO
- public abstract interface TcapLayerMO
- extends TcapManagedObject, OamLayer
This interface defines the methods required for the creation and management of
all TCAP Managed Objects. It defines the methods to:
-
Add a TCAP Statistic Listener to
this TcapLayerMO's list of registered Statistic Listeners.
An application must register with this TCAP Layer Managed Object (MO)
as a TCAP Statistic Listener in order to receive TCAP Statictics that are
being polled asynchronously.
When a Statictic is being polled asynchronously, the Statistic value will
be sent (as a TCAP Statistic Event)
at the end of each polling interval to the statistic Listener that started
to poll the statistic.
-
Remove a TCAP Statictic Listener from
this TcapLayerMO's list of registered Statistic Listeners.
Once a TCAP Statictic Listener has been removed from the list, it will
no longer receive TCAP Statistic Events
from this TcapLayerMO (even if the Listener has not expicitly stopped the
polling of the statistics in which it had previously started polling).
-
Collect TCAP 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 java.io.Serializable |
serialVersionUID |
addTcapStatisticListener
public void addTcapStatisticListener(TcapStatisticListener listener)
throws java.util.TooManyListenersException,
jain.protocol.ss7.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 MO as an Statistic Listener.
removeTcapStatisticListener
public void removeTcapStatisticListener(TcapStatisticListener listener)
throws jain.protocol.ss7.SS7ListenerNotRegisteredException
- Removes a TCAP Statistic Listener
from the list of registered statistic listeners of this TCAP Layer MO.
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 MO.
getStatistic
public TcapStatisticEvent getStatistic(int statisticType)
throws StatisticNotSupportedException
- Returns a TcapStatisticEvent 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 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,
int interval)
throws StatisticNotSupportedException
- Initiates the polling of statistic of the specified statistic type. 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]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 TCAP 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.
20 September 99
If you have any comments or queries, please mail them to JainOAM@East.Sun.ComCopyright - 1999 Sun Microsystems