jain.protocol.ss7.oam.mtp3
Interface RouteMO

public abstract interface RouteMO

extends Mtp3ManagedObject

This inteface defines the methods of a Route Managed Object(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 java.io.Serializable

serialVersionUID

Method Summary

void	clearLinkSetList() Removes all LinkSets from this LinkSet
int	getAvailability() Returns the availability of this Route [ITU Rec.
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 ReouteSet.
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	setLinkSet(int index, LinkSetMO linkSet) Sets a LinkSet at the specified position in the LinkSets in this route
void	setLinkSet(LinkSetMO[] linkSetList) Sets the LinkSets in this route
void	setPriority(int priority) Sets the priority of this Route within the containing ReouteSet.
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, getName, removePropertyChangeListener, 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

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 ReouteSet. The returned priority determines if this Route is used as current Route. Enabled Routes (isSignallingPointAccessible() == true) contained in the same Route Set 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)

Sets the priority of this Route within the containing ReouteSet. The supplied priority will determine if this Route is used as current Route. Enabled Routes (isSignallingPointAccessible() == true) contained in the same Route Set 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)

getLinkSet

public LinkSetMO[] getLinkSet()

Gets the list of LinkSets in this route

Returns:

an array of the link sets 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 link set

setLinkSet

public void setLinkSet(int index,
                       LinkSetMO linkSet)

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

setLinkSet

public void setLinkSet(LinkSetMO[] linkSetList)

Sets the LinkSets in this route

Parameters:

linkSetList - the LinkSets

clearLinkSetList

public void clearLinkSetList()

Removes all LinkSets from this LinkSet