jain.protocol.ss7.oam.mtp3
Interface RouteMO


public abstract interface RouteMO
extends Mtp3ManagedObject

This inteface defines the methods of a Route Managed Object(MO). A Route specifies the pre-determined path, consisting of a succession of signaling points/signaling transfer points and the interconnecting signaling links, that a message takes through the signaling network between the origination point and the destination point. ie. A Route specifies the path an MSU should take to an adjacent or far-end node.

There are no statistics that can be collected for this MO

The following Alarms can be emitted by this MO

The following Errors can be emitted by this MO


Field Summary
static int ROUTE_AVAILABLE
          Indicates that this Route is available.
static int ROUTE_RESTRICTED
          Indicates that this Route is restricted.
static int ROUTE_UNAVAILABLE
          Indicates that this Route is unavailable.
 
Fields inherited from class jain.protocol.ss7.oam.OamManagedObject
OBJECTID_CONCERNED_AREA, OBJECTID_GLOBAL_TITLE_ENTRY, OBJECTID_LINK, OBJECTID_LINKSET, OBJECTID_MTP2_SAP, OBJECTID_MTP2_TIMER_PROFILE, OBJECTID_MTP3_SAP, OBJECTID_MTP3_TIMER_PROFILE, OBJECTID_OWN_SIGNALLING_POINT, OBJECTID_ROUTE, OBJECTID_ROUTESET, OBJECTID_SCCP_ENTITY_SET, OBJECTID_SCCP_ROUTING_CONTROL, OBJECTID_SCCP_SAP, OBJECTID_SCCP_TIMER_PROFILE, OBJECTID_SCREENING_TABLE, OBJECTID_TCAP
 
Fields inherited from class java.io.Serializable
serialVersionUID
 
Method Summary
 void clearLinksetList()
          Removes all Linksets from this Linkset
 int getAvailability()
          Returns the availability of this Route [ITU Rec.
 Mtp3SapMO getDestSignallingPoint()
          Gets the Service Access Point (SAP) that identifies the Destination Signalling Point of this Routeset.
 LinksetMO getFirstLinkset()
          Gets the Linkset which is intended to be used as first segment of the succession of Linksets in this Route, which form the signalling route on the network level.
 LinksetMO[] getLinkset()
          Gets the list of Linksets in this route
 LinksetMO getLinkset(int index)
          Gets the Linkset at the specified position in the set of Linksets in this route
 int getPriority()
          Returns the priority of this Route within the containing Routeset.
 boolean isRoutingAllowed()
          Returns whether it is administratively permitted to route SS7 MSUs towards the Destination Signalling Point via the firstLinkset of this Route (the Adiministrative State).
 boolean isSignallingPointAccessible()
          Indicates if the respective Destination Signalling Point is accessible via the firstLinkset of this Route (the Operational State).
 void setDestSignallingPoint(Mtp3SapMO destinationSignallingPoint)
          Sets the Service Access Point (SAP) that identifies the Destination Signalling Point of this Routeset.
 void setLinkset(int index, LinksetMO linkset)
          Sets a Linkset at the specified position in the Linksets in this route
 void setLinkset(LinksetMO[] linksets)
          Sets the Linksets in this route
 void setPriority(int priority)
          Sets the priority of this Route within the containing Routeset.
 void setRoutingAllowed(boolean allowed)
          Sets whether it is administratively permitted to route SS7 MSUs towards the Destination Signalling Point via the firstLinkset of this Route (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, addVetoableChangeListener, getName, getObjectId, getProprietaryInformation, removePropertyChangeListener, removeVetoableChangeListener, setName
 

Field Detail

ROUTE_AVAILABLE

public static final int ROUTE_AVAILABLE
Indicates that this Route is available. A signalling route becomes available when a transfer-allowed message, indicating that signalling traffic towards a particular destination can be transferred via the signalling transfer point sending the concerned message, is received.

ROUTE_UNAVAILABLE

public static final int ROUTE_UNAVAILABLE
Indicates that this Route is unavailable. A signalling route becomes unavailable when a transfer-prohibited message, indicating that signalling traffic towards a particular destination cannot be transferred via the signalling transfer point sending the concerned message, is received

ROUTE_RESTRICTED

public static final int ROUTE_RESTRICTED
Indicates that this Route is restricted. A signalling route becomes restricted when a transfer-restricted message, indicating that the signalling traffic towards a particular destination is being transferred with some difficulty via the signalling transfer point sending the concerned message is received.
Method Detail

getDestSignallingPoint

public Mtp3SapMO getDestSignallingPoint()
Gets the Service Access Point (SAP) that identifies the Destination Signalling Point of this Routeset. The SAP may represent an adjacent or far-end node.
Returns:
the destination signalling point of this routeset

setDestSignallingPoint

public void setDestSignallingPoint(Mtp3SapMO destinationSignallingPoint)
                            throws java.beans.PropertyVetoException
Sets the Service Access Point (SAP) that identifies the Destination Signalling Point of this Routeset. The SAP may represent an adjacent or far-end node.
Parameters:
destinationSignallingPoint - the destination signalling point of this Route.
Throws:
java.beans.PropertyVetoException - - if the linksets contained in this RouteMO cannot route to the supplied destination signalling point.

Note that the mechanism for checking for and throwing the PropertyVetoException is defined in the JavaBeans(tm) API specification


getFirstLinkset

public LinksetMO getFirstLinkset()
Gets the Linkset which is intended to be used as first segment of the succession of Linksets in this Route, which form the signalling route on the network level.
Returns:
the first Linkset in this route

isSignallingPointAccessible

public boolean isSignallingPointAccessible()
Indicates if the respective Destination Signalling Point is accessible via the firstLinkset of this Route (the Operational State).
Returns:
either:
  • true if the 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 via the firstLinkset of this Route (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 via the firstLinkset of this Route (the Adiministrative State).
Returns:
either:
  • true if routing is permitted (unlocked).
  • false otherwise (locked).

getAvailability

public int getAvailability()
Returns the availability of this Route [ITU Rec. Q.704, 3.4]. This is a display only attribute.
Returns:
either:
  • ROUTE_AVAILABLE
  • ROUTE_UNAVAILABLE
  • ROUTE_RESTRICTED

getPriority

public int getPriority()
Returns the priority of this Route within the containing Routeset. The returned priority determines if this Route is used as current Route. Enabled Routes (isSignallingPointAccessible() == true) contained in the same Routeset are chosen in ascending order as current routes (The lower the value, the higher the priority).
Returns:
the priority (The lower the value, the higher the priority)

setPriority

public void setPriority(int priority)
                 throws java.lang.IllegalArgumentException
Sets the priority of this Route within the containing Routeset. The supplied priority will determine if this Route is used as current Route. Enabled Routes (isSignallingPointAccessible() == true) contained in the same Routeset are chosen in ascending order as current routes (The lower the value, the higher the priority).
Parameters:
priority - the priority (The lower the value, the higher the priority)
Throws:
java.lang.IllegalArgumentException - - if the supplied priority is unnaceptable

getLinkset

public LinksetMO[] getLinkset()
Gets the list of Linksets in this route
Returns:
an array of the linksets in this route

getLinkset

public LinksetMO getLinkset(int index)
Gets the Linkset at the specified position in the set of Linksets in this route
Parameters:
index - the index position of the element in the array
Returns:
the linkset

setLinkset

public void setLinkset(int index,
                       LinksetMO linkset)
                throws TooManyInstancesException
Sets a Linkset at the specified position in the Linksets in this route
Parameters:
index - the index position of the element in the array
linkset - the Linkset to be added
Throws:
TooManyInstancesException - - if index is greater than the number of LinksetMOs permitted in a RouteMO by this implementation.

setLinkset

public void setLinkset(LinksetMO[] linksets)
                throws TooManyInstancesException
Sets the Linksets in this route
Parameters:
linksets - the Linksets that compose this route
Throws:
TooManyInstancesException - - if the size of linksets is greater than the number of LinksetMOs permitted in a RouteMO by this implementation.

clearLinksetList

public void clearLinksetList()
Removes all Linksets from this Linkset


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