|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface defines the methods required for the creation and management of all MTP Level 3 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.mtp3.Mtp3LayerManager interface must be jain.protocol.ss7.oam.mtp3.Mtp3LayerManagerImpl.
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 Mtp3LayerManager will be located at:
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.mtp3.Mtp3LayerManagerImpl
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 |
addMtp3StatisticListener(Mtp3StatisticListener listener)
Adds a Mtp3StatisticListener to the list of registered statistic listeners of the MTP3 layer. |
LinkMO |
createLink(Mtp2SapMO mtp2Sap)
Creates a new Link Managed Object. |
LinksetMO |
createLinkset(Mtp3SapMO adjacentSignallingPoint,
LinkMO[] links)
Creates a new Linkset Managed Object. |
Mtp3SapMO |
createMtp3Sap(long pointCode,
int type,
int networkInd,
int serviceIndicator)
Creates a new Mtp3 Service Access Point MO (representing a Remote Signalling Point) |
Mtp3TimerProfileMO |
createMtp3TimerProfile()
Creates a new Mtp3TimerProfileMO that will use the correct Timer values for the the protocol variant of this Mtp3LayerManager. |
OwnSignallingPointMO |
createOwnSignallingPoint(long pointCode,
int type,
int networkInd,
int serviceIndicator)
Creates a new Own Signalling Point Managed Object. |
RouteMO |
createRoute(Mtp3SapMO destinationSignallingPoint,
LinksetMO[] linksets)
Creates a new Route Managed Object. |
RoutesetMO |
createRouteset(RouteMO[] routes)
Creates a new Routeset Managed Object. |
ScreeningTableMO |
createScreeningTable()
Creates a new Screening Table managed object. |
void |
deleteLink(LinkMO link)
Deletes the specified Link Managed Object. |
void |
deleteLinkset(LinksetMO linkset)
Deletes the specified Linkset Managed Object. |
void |
deleteMtp3Sap(Mtp3SapMO sap)
Deletes the specified Mtp3 Service Access Point MO. |
void |
deleteMtp3TimerProfile(Mtp3TimerProfileMO timerProfile)
Deletes the specified Mtp3TimerProfileMO. |
void |
deleteOwnSignallingPoint(OwnSignallingPointMO signallingPoint)
Deletes the specified Own Signalling Point Managed Object. |
void |
deleteRoute(RouteMO route)
Deletes the specified Route Managed Object. |
void |
deleteRouteset(RoutesetMO routeset)
Deletes the specified Routeset Managed Object. |
void |
deleteScreeningTable(ScreeningTableMO screeningTable)
Deletes the specified Screening Table managed object. |
OwnSignallingPointMO[] |
getActiveOwnSignallingPoint()
Returns the all of the active (local) Signalling Points of this stack. The underlying stack management system may support multiple signalling points on the the same system. |
OwnSignallingPointMO |
getActiveOwnSignallingPoint(int index)
Returns one of the active (local) Signalling Points of this stack. The underlying stack management system may support multiple signalling points on the the same system. |
LinkMO[] |
getAllLinks()
Returns all of the Links created by this layer manager |
LinkMO |
getAllLinks(int index)
Returns one of the Links created by this layer manager |
LinksetMO[] |
getAllLinksets()
Returns all of the Linksets created by this layer manager |
LinksetMO |
getAllLinksets(int index)
Returns one of the Linksets created by this layer manager |
Mtp3SapMO[] |
getAllMtp3Saps()
Returns all of the MTP3 SAPs (Remote Signalling Points) created by this layer manager |
Mtp3SapMO |
getAllMtp3Saps(int index)
Returns one of the MTP3 SAPs (Remote Signalling Points) created by this layer manager |
Mtp3TimerProfileMO[] |
getAllMtp3TimerProfiles()
Returns all of the MTP3 Timer Profiles created by this layer manager |
Mtp3TimerProfileMO |
getAllMtp3TimerProfiles(int index)
Returns one of the MTP3 Timer Profiles created by this layer manager |
OwnSignallingPointMO[] |
getAllOwnSignallingPoints()
Returns all of the Own Signalling Points created by this layer manager |
OwnSignallingPointMO |
getAllOwnSignallingPoints(int index)
Returns one of the Own Signalling Points created by this layer manager |
RouteMO[] |
getAllRoutes()
Returns all of the Routes created by this layer manager |
RouteMO |
getAllRoutes(int index)
Returns one of the Routes created by this layer manager |
RoutesetMO[] |
getAllRoutesets()
Returns all of the Routesets created by this layer manager |
RoutesetMO |
getAllRoutesets(int index)
Returns one of the Routesets created by this layer manager |
ScreeningTableMO[] |
getAllScreeningTables()
Returns all of the Screening Tables created by this layer manager. |
ScreeningTableMO |
getAllScreeningTables(int index)
Returns one of the Screening Tables created by this layer manager |
Mtp3StatisticEvent |
getStatistic(int statisticType,
Mtp3ManagedObject managedObject)
Returns a Mtp3StatisticEvent of the specified statistic type containing the value of the statistic. |
void |
removeMtp3StatisticListener(Mtp3StatisticListener listener)
Removes a MTP3 Statistic Listener from the list of registered statistic listeners of this MTP3 Layer Manager. |
void |
setActiveOwnSignallingPoint(int index,
OwnSignallingPointMO OwnSignallingPoint)
Sets one of the active (local) Signalling Points of this stack. The underlying stack management system may support multiple signalling points on the the same system. |
void |
setActiveOwnSignallingPoint(OwnSignallingPointMO[] OwnSignallingPoints)
Sets all of the active (local) Signalling Points of this stack. The underlying stack management system may support multiple signalling points on the the same system. |
void |
startPollingStatistic(int statisticType,
Mtp3ManagedObject managedObject,
int interval)
Initiates the polling of statistic of the specified statistic type for the specified managed object. |
void |
stopPollingStatistic(int statisticType,
Mtp3ManagedObject 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 |
public void addMtp3StatisticListener(Mtp3StatisticListener listener) throws java.util.TooManyListenersException, SS7ListenerAlreadyRegisteredException
listener
- the MTP3 Statistic Listener to be added.public void removeMtp3StatisticListener(Mtp3StatisticListener listener) throws SS7ListenerNotRegisteredException
ie. Removing a MTP3 Statistic Listener application implicitly stops the polling of all of the applications statistics.
listener
- the MTP3 Statistic Listener to be removed.public Mtp3StatisticEvent getStatistic(int statisticType, Mtp3ManagedObject managedObject) throws StatisticNotSupportedException
statisticType
- the type of the statistic to be returned
[managedObject
- the MTP3 Managed Object (MO) for which the statistic is to be collectedpublic void startPollingStatistic(int statisticType, Mtp3ManagedObject managedObject, int interval) throws StatisticNotSupportedException
statisticType
- the type of the statistic to be polled
[managedObject
- the MTP3 Managed Object (MO) for which the statistic is to be polledinterval
- the polling interval in millisecondspublic void stopPollingStatistic(int statisticType, Mtp3ManagedObject managedObject) throws IllegalOperationException
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 MTP3 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.
statisticType
- the type of the statistic for which polling is to stop.managedObject
- the MTP3 Managed Object (MO) for which the polling is to stoppublic Mtp3TimerProfileMO createMtp3TimerProfile() throws TooManyInstancesException
public LinkMO createLink(Mtp2SapMO mtp2Sap) throws TooManyInstancesException
mtp2Sap
- the MTP2 SAP defining the hardware characteristics of this linkpublic LinksetMO createLinkset(Mtp3SapMO adjacentSignallingPoint, LinkMO[] links) throws TooManyInstancesException
adjacentSignallingPoint
- the Adjacent Signalling Point of this Linksetlinks
- the links of this linkset.public RouteMO createRoute(Mtp3SapMO destinationSignallingPoint, LinksetMO[] linksets) throws TooManyInstancesException
destinationSignallingPoint
- the destination signalling point of this Routelinksets
- the Linksets that make up this routepublic RoutesetMO createRouteset(RouteMO[] routes) throws TooManyInstancesException
routes
- the routes that make up this routesetpublic OwnSignallingPointMO createOwnSignallingPoint(long pointCode, int type, int networkInd, int serviceIndicator) throws TooManyInstancesException, java.lang.IllegalArgumentException
pointCode
- the signalling point codetype
- one of the following:
networkInd
- one of the following Network Indicator constants:
serviceIndicator
- one of the following Service Indicator constants:
public Mtp3SapMO createMtp3Sap(long pointCode, int type, int networkInd, int serviceIndicator) throws TooManyInstancesException, java.lang.IllegalArgumentException
pointCode
- the signalling point codetype
- one of the following:
networkInd
- one of the following Network Indicator constants:
serviceIndicator
- one of the following Service Indicator constants:
public ScreeningTableMO createScreeningTable() throws java.lang.UnsupportedOperationException, TooManyInstancesException
screeningType
- either:
public void deleteMtp3TimerProfile(Mtp3TimerProfileMO timerProfile)
public void deleteLink(LinkMO link)
public void deleteLinkset(LinksetMO linkset)
public void deleteRoute(RouteMO route)
public void deleteRouteset(RoutesetMO routeset)
public void deleteOwnSignallingPoint(OwnSignallingPointMO signallingPoint)
public void deleteMtp3Sap(Mtp3SapMO sap)
public void deleteScreeningTable(ScreeningTableMO screeningTable) throws java.lang.UnsupportedOperationException
public void setActiveOwnSignallingPoint(int index, OwnSignallingPointMO OwnSignallingPoint) throws TooManyInstancesException
index
- the index position of the element in the array.OwnSignallingPoint
- the local Signalling Pointpublic OwnSignallingPointMO getActiveOwnSignallingPoint(int index)
There is a subtle difference between this method and the getAllOwnSignallingPoints() method in that this method returns one of the Own Signalling Points that are currently in use, whereas the getAllOwnSignallingPoints() method returns one all the Own Signalling Points (both those Signalling Points currently in use and the Signalling Points that have been configured are not available for use for any reason including for backup). Every OwnSignallingPoint that was created through the setActiveOwnSignallingPoint() method shall be returned by this method.
index
- the index position of the element in the array.public void setActiveOwnSignallingPoint(OwnSignallingPointMO[] OwnSignallingPoints) throws TooManyInstancesException
OwnSignallingPoints
- all of the (local) Signalling Points of this stack.public OwnSignallingPointMO[] getActiveOwnSignallingPoint()
There is a subtle difference between this method and the getAllOwnSignallingPoints() method in that this method returns only the Own Signalling Points that are currently in use, whereas the getAllOwnSignallingPoints() method contains all Own Signalling Points (both those Signalling Points currently in use and the Signalling Points that have been configured are not available for use for any reason including for backup). Every OwnSignallingPoint that was created through the setActiveOwnSignallingPoint() method shall be returned by this method.
public Mtp3SapMO[] getAllMtp3Saps()
public Mtp3SapMO getAllMtp3Saps(int index)
index
- the index of the Remote Signalling Point in the listpublic Mtp3TimerProfileMO[] getAllMtp3TimerProfiles()
public Mtp3TimerProfileMO getAllMtp3TimerProfiles(int index)
index
- the index of the MTP3 Timer Profile in the listpublic LinkMO[] getAllLinks()
public LinkMO getAllLinks(int index)
index
- the index of the Link in the listpublic LinksetMO[] getAllLinksets()
public LinksetMO getAllLinksets(int index)
index
- the index of the Linkset in the listpublic RouteMO[] getAllRoutes()
public RouteMO getAllRoutes(int index)
index
- the index of the Route in the listpublic RoutesetMO[] getAllRoutesets()
public RoutesetMO getAllRoutesets(int index)
index
- the index of the Routeset in the listpublic ScreeningTableMO[] getAllScreeningTables() throws java.lang.UnsupportedOperationException
public ScreeningTableMO getAllScreeningTables(int index) throws java.lang.UnsupportedOperationException
index
- the index of the Screening Table in the listpublic OwnSignallingPointMO[] getAllOwnSignallingPoints()
public OwnSignallingPointMO getAllOwnSignallingPoints(int index)
index
- the index of the Own Signalling Point in the list
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |