jain.protocol.ss7.oam.mtp3
Interface RouteSetMO


public abstract interface RouteSetMO
extends Mtp3ManagedObject

This inteface defines the methods of a RouteSet Managed Object(MO). A RouteSet defines all of the signaling routes that may be used between an originating point and a destination point by a message traversing the signaling network.


Field Summary
static int CONG_CONGESTED_LEVEL1
           
static int CONG_CONGESTED_LEVEL2
           
static int CONG_CONGESTED_LEVEL3
           
static int CONG_UNCONGESTED
           
 
Fields inherited from class java.io.Serializable
serialVersionUID
 
Method Summary
 int getCongestionLevel()
          Gets the Congestion Level of this Route Set.
 Mtp3SapMO getDestSignallingPoint()
          Gets the Service Access Point (SAP) that identifies the Destination Signalling Point of this Route Set.
 RouteMO[] getRoute()
          Gets the list of Routes in this route set
 RouteMO getRoute(int index)
          Gets the route at the specified position in this route set.
 boolean isLoadSharing()
          Indicates if this Route Set supports Load Sharing.
 boolean isRoutingAllowed()
          Returns whether it is administratively permitted to route SS7 MSUs towards the Destination Signalling Point of this RouteSet (the Adiministrative State).
 boolean isSignallingPointAccessible()
          Indicates if the Destination Signalling Point of this Route Set is accessible (the Operational State).
 void setDestSignallingPoint(Mtp3SapMO destinationSignallingPoint)
          Sets the Service Access Point (SAP) that identifies the Destination Signalling Point of this Route Set.
 void setLoadSharing(boolean loadSharing)
          Sets whether or not this Route Set supports Load Sharing.
 void setRoute(int index, RouteMO route)
          Sets the route at the specified position in this route set.
 void setRoute(RouteMO[] routes)
          Sets the array of Routes in this route set.
 void setRoutingAllowed(boolean allowed)
          Sets whether it is administratively permitted to route SS7 MSUs towards the Destination Signalling Point of this RouteSet (the Adiministrative State).
 
Methods inherited from interface jain.protocol.ss7.oam.mtp3.Mtp3ManagedObject
addMtp3AlarmListener, addMtp3ErrorListener, removeMtp3AlarmListener, removeMtp3ErrorListener
 
Methods inherited from interface jain.protocol.ss7.oam.OamManagedObject
addPropertyChangeListener, getName, getProprietaryInformation, removePropertyChangeListener, setName
 

Field Detail

CONG_UNCONGESTED

public static final int CONG_UNCONGESTED

CONG_CONGESTED_LEVEL1

public static final int CONG_CONGESTED_LEVEL1

CONG_CONGESTED_LEVEL2

public static final int CONG_CONGESTED_LEVEL2

CONG_CONGESTED_LEVEL3

public static final int CONG_CONGESTED_LEVEL3
Method Detail

getDestSignallingPoint

public Mtp3SapMO getDestSignallingPoint()
Gets the Service Access Point (SAP) that identifies the Destination Signalling Point of this Route Set.
Returns:
the destination signalling point of this route set

setDestSignallingPoint

public void setDestSignallingPoint(Mtp3SapMO destinationSignallingPoint)
Sets the Service Access Point (SAP) that identifies the Destination Signalling Point of this Route Set.
Parameters:
destinationSignallingPoint - the destination signalling point of this Reoute Set.

setLoadSharing

public void setLoadSharing(boolean loadSharing)
Sets whether or not this Route Set supports Load Sharing.
Parameters:
loadSharing - either:
  • true enables Load Sharing.
  • false disables Load Sharing

isLoadSharing

public boolean isLoadSharing()
Indicates if this Route Set supports Load Sharing.
Returns:
either
  • true if this Route Set supports Load Sharing.
  • false otherwise.

isSignallingPointAccessible

public boolean isSignallingPointAccessible()
Indicates if the Destination Signalling Point of this Route Set is accessible (the Operational State).
Returns:
either:
  • true if this RouteSet's Destination Signalling Point is accessible (enabled).
  • false otherwise (disabled).

setRoutingAllowed

public void setRoutingAllowed(boolean allowed)
Sets whether it is administratively permitted to route SS7 MSUs towards the Destination Signalling Point of this RouteSet (the Adiministrative State).
Parameters:
allowed - either:
  • true if routing is permitted (unlocked).
  • false otherwise (locked).

isRoutingAllowed

public boolean isRoutingAllowed()
Returns whether it is administratively permitted to route SS7 MSUs towards the Destination Signalling Point of this RouteSet (the Adiministrative State).
Returns:
either:
  • true if routing is permitted (unlocked).
  • false otherwise (locked).

getCongestionLevel

public int getCongestionLevel()
Gets the Congestion Level of this Route Set. This reflects RouteSet congestion. Different vaules are valid depending on the protocol variant supported.
Returns:
either :
  • CONG_UNCONGESTED
  • CONG_CONGESTED_LEVEL1
  • CONG_CONGESTED_LEVEL2
  • CONG_CONGESTED_LEVEL3

getRoute

public RouteMO[] getRoute()
Gets the list of Routes in this route set
Returns:
an array of the routes in this route set

setRoute

public void setRoute(RouteMO[] routes)
              throws TooManyInstancesException
Sets the array of Routes in this route set. Each route in this Route Set must have the same Destination Signalling Point.
Parameters:
/routes - the routes to be set for this route set
Throws:
TooManyInstancesException - - if the size of routes is greater than the number of routes permitted in a RouteSet by this implementation.

getRoute

public RouteMO getRoute(int index)
Gets the route at the specified position in this route set.
Parameters:
index - the index of the element in the array
Returns:
an array of the routes in this route set

setRoute

public void setRoute(int index,
                     RouteMO route)
              throws TooManyInstancesException
Sets the route at the specified position in this route set. The route to be set must have the same Destination Signalling Point as this route set.
Parameters:
index - the index of the element in the array
/routeList - the routes to be set for this route set
Throws:
TooManyInstancesException - - if index is greater than the number of Routes permitted in a Route Set by this implementation.


11 October 99
If you have any comments or queries, please mail them to JainOAM@East.Sun.Com

Copyright - 1999 Sun Microsystems