jain.protocol.ss7.oam.mtp3
Interface LinkMO

public abstract interface LinkMO
extends Mtp3ManagedObject

This inteface defines the methods of a Link Managed Object(MO).

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 getCongestionAbate(int congestionLevel)
          Returns the value at which a link congestion situation ends for the specified congestion level.
 int getCongestionLevel()
          Gets the Congestion Level of this Link.
 int getCongestionOnset(int congestionLevel)
          Returns the value at which a link congestion situation starts for the specified congestion level.
 int getCurrentCapacity()
          Returns the Current Capacity of this Link.
 void getDiscardAbate(int discardLevel)
          Returns the value at which MSUs are no longer discarded for the specified discard level.
 void getDiscardOnset(int discardLevel)
          Returns the value at which MSUs are discarded for the specified discard level.
 int getMaxCapacity()
          Returns the Maximum Capacity of this Link.
 Mtp2SapMO getMtp2Sap()
          Returns the Mtp2 Service Access Point associated with this Signalling Link.
 int getSignallingLinkCode()
          Gets the Signalling Link Code (SLC) parameter of this Signalling Link.
 boolean isActive()
          Returns whether this Signalling Link is active or innactive.
 boolean isEnabled()
          Returns whether this Link is enabled or disabled (the operational state of this Link).
 boolean isInstalled()
          Returns the Installed Status parameter of this Signalling Link.
 boolean isLinkNormal()
          Returns the Link Normal Status parameter of this Signalling Link.
 boolean isLocallyBlocked()
          Returns the Locally Blocked Status parameter of this Signalling Link.
 boolean isRoutingAllowed()
          Returns whether it is administratively permitted to route SS7 MSUs towards the Destination Signalling Point via this Link (the Adiministrative State).
 boolean isSignallingLinkTestOn()
          Returns the Signalling Link testing.
 boolean isTestPeriodically()
          Returns whether the link is tested periodically
 void setActive(boolean active)
          Activates or deactivates this Signalling Link.
 void setCongestionAbate(int congestionLevel, int congestionAbate)
          Sets the value at which a link congestion situation ends for the specified congestion level.
 void setCongestionOnset(int congestionLevel, int congestionOnset)
          Sets the value at which a link congestion situation starts for the specified congestion level.
 void setDiscardAbate(int discardLevel, int discardOnset)
          Sets the value at which MSUs are no longer discarded for the specified discard level.
 void setDiscardOnset(int discardLevel, int discardOnset)
          Sets the value at which MSUs are discarded for the specified discard level.
 void setEnabled(boolean enabled)
          Sets the operational state of this link.
 void setInstalled(boolean installed)
          Sets the Installed Status parameter of this Signalling Link.
 void setLinkNormal(boolean linkNormal)
          Sets the Link Normal Status parameter of this Signalling Link.
 void setLocallyBlocked(boolean locallyBlocked)
          Sets the Locally Blocked Status parameter of this Signalling Link.
 void setMtp2Sap(Mtp2SapMO mtp2Sap)
          Sets the Mtp2 Service Access Point associated with this Signalling Link.
 void setRoutingAllowed(boolean allowed)
          Sets whether it is administratively permitted to route SS7 MSUs towards the Destination Signalling Point via this Link (the Adiministrative State).
 void setSignallingLinkCode(int signallingLinkCode)
          Sets the Signalling Link Code (SLC)of this Signalling Link.
 void setSignallingLinkTestOn(boolean signallingLinkTestOn)
          Sets the Signalling Link testing.
 void setStatus(int status)
          Returns the status of this Link (as defined in ITU Rec.
 void setTestPeriodically(boolean testPeriodically)
          Sets the periodic testing of this signalling link
 
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

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

setSignallingLinkCode

public void setSignallingLinkCode(int signallingLinkCode)
Sets the Signalling Link Code (SLC)of this Signalling Link. The SLC is the same value (between 0 and 15) at each end of the link, and is different from that of any other link between the same two adjacent signalling points.
Throws:
MethodNotSupportedException - thrown if this method is not supported by the underlying system.

getSignallingLinkCode

public int getSignallingLinkCode()
Gets the Signalling Link Code (SLC) parameter of this Signalling Link. The SLC is the same value (between 0 and 15) at each end of the link, and is different from that of any other link between the same two adjacent signalling points.

getMaxCapacity

public int getMaxCapacity()
Returns the Maximum Capacity of this Link. The maximum capacity of a signalling link is the maximum load that should be placed on the signalling link. This is a display only attribute.
Returns:
the maximum capacity of this Link

getCurrentCapacity

public int getCurrentCapacity()
Returns the Current Capacity of this Link. The current capacity of a Link (implementation dependent, consequently an optional attribute) is the maximum load that should be placed on the Link given the present configuration of Signalling Data Links (SDLs) to signalling terminals.
Could be used where Signalling Terminal (ST) capacities might be different in an implementation and automatic allocation of SDL to ST can be done, and/or where a signalling terminal could control several Links. This is a display only attribute.
Returns:
the Current Capacity of this Link.

setStatus

public void setStatus(int status)
Returns the status of this Link (as defined in ITU Rec. Q.704).
Returns:
one of the following :
  • STATUS_LOCALLY_BLOCKED
  • STATUS_REMOTELY_BLOCKED
  • STATUS_LOCALLY_INHIBITED
  • STATUS_REMOTELY_INHBITED
  • STATUS_FAILED
  • STATUS_DEACTIVATED

isEnabled

public boolean isEnabled()
Returns whether this Link is enabled or disabled (the operational state of this Link).
Returns:
either:
  • true if this Link is enabled.
  • false if this Link is disabled.

setEnabled

public void setEnabled(boolean enabled)
Sets the operational state of this link.
Parameters:
enabled - the opertaional state (enabled or disabled) either:
  • true enables this Link.
  • false disables this Link.

setRoutingAllowed

public void setRoutingAllowed(boolean allowed)
Sets whether it is administratively permitted to route SS7 MSUs towards the Destination Signalling Point via this Link (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 this Link (the Adiministrative State).
Returns:
either:
  • true if routing is permitted (unlocked).
  • false otherwise (locked).

getCongestionLevel

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

setActive

public void setActive(boolean active)
Activates or deactivates this Signalling Link. When the link is originally created it will be deactivated by default.
Parameters:
active - either:
  • true This activates the link (puts the link into operation)and allows alignment of the link to take place.
  • false This deactivates the link (causing it to go out of alignment and to stop carrying traffic).

isActive

public boolean isActive()
Returns whether this Signalling Link is active or innactive.
Returns:
either:
  • true The link is active. (the Signalling Link may have been activated for carrying traffic by operator command
  • false The link is inactive (the Link may have been prevented from aligning or carrying traffic autonomously or may have been deactivated by operator command.

setInstalled

public void setInstalled(boolean installed)
Sets the Installed Status parameter of this Signalling Link.

isInstalled

public boolean isInstalled()
Returns the Installed Status parameter of this Signalling Link.

setLinkNormal

public void setLinkNormal(boolean linkNormal)
Sets the Link Normal Status parameter of this Signalling Link.

isLinkNormal

public boolean isLinkNormal()
Returns the Link Normal Status parameter of this Signalling Link.

setLocallyBlocked

public void setLocallyBlocked(boolean locallyBlocked)
Sets the Locally Blocked Status parameter of this Signalling Link.

isLocallyBlocked

public boolean isLocallyBlocked()
Returns the Locally Blocked Status parameter of this Signalling Link.

setSignallingLinkTestOn

public void setSignallingLinkTestOn(boolean signallingLinkTestOn)
Sets the Signalling Link testing.
Parameters:
signallingLinkTestOn - TRUE if link testing is on, FALSE otherwise.

isSignallingLinkTestOn

public boolean isSignallingLinkTestOn()
Returns the Signalling Link testing. return signallingLinkTestOn TRUE if link testing is on, FALSE otherwise.

setTestPeriodically

public void setTestPeriodically(boolean testPeriodically)
Sets the periodic testing of this signalling link
Parameters:
testPeriodically - TRUE if periodic link testing is enabled.

isTestPeriodically

public boolean isTestPeriodically()
Returns whether the link is tested periodically
Returns:
TRUE if the link is tested periodically.

setCongestionOnset

public void setCongestionOnset(int congestionLevel,
                               int congestionOnset)
Sets the value at which a link congestion situation starts for the specified congestion level.
Parameters:
congestionLevel - the congestion level (1, 2 or 3)
congestionOnset - the value at which a link congestion situation starts for the specified congestion level.

getCongestionOnset

public int getCongestionOnset(int congestionLevel)
Returns the value at which a link congestion situation starts for the specified congestion level.
Parameters:
congestionLevel - the congestion level (1, 2 or 3)
Returns:
the value at which a link congestion situation starts for the specified congestion level.

setCongestionAbate

public void setCongestionAbate(int congestionLevel,
                               int congestionAbate)
Sets the value at which a link congestion situation ends for the specified congestion level.
Parameters:
congestionLevel - the congestion level (1, 2 or 3)
congestionAbate - the value at which a link congestion situation ends for the specified congestion level.

getCongestionAbate

public int getCongestionAbate(int congestionLevel)
Returns the value at which a link congestion situation ends for the specified congestion level.
Parameters:
congestionLevel - the congestion level (1, 2 or 3)
Returns:
the value at which a link congestion situation ends for the specified congestion level.

setDiscardOnset

public void setDiscardOnset(int discardLevel,
                            int discardOnset)
Sets the value at which MSUs are discarded for the specified discard level.
Parameters:
discardLevel - the discard level (1, 2 or 3)
discardOnset - the value MSUs are discarded for the specified discard level.

getDiscardOnset

public void getDiscardOnset(int discardLevel)
Returns the value at which MSUs are discarded for the specified discard level.
Parameters:
discardLevel - the discard level (1, 2 or 3)
Returns:
the value at which MSUs are discarded for the specified discard level.

setDiscardAbate

public void setDiscardAbate(int discardLevel,
                            int discardOnset)
Sets the value at which MSUs are no longer discarded for the specified discard level.
Parameters:
discardLevel - the discard level (1, 2 or 3)
discardOnset - the value MSUs are no longer discarded for the specified discard level.

getDiscardAbate

public void getDiscardAbate(int discardLevel)
Returns the value at which MSUs are no longer discarded for the specified discard level.
Parameters:
discardLevel - the discard level (1, 2 or 3)
Returns:
the value at which MSUs are no longer discarded for the specified discard level.

getMtp2Sap

public Mtp2SapMO getMtp2Sap()
Returns the Mtp2 Service Access Point associated with this Signalling Link.

setMtp2Sap

public void setMtp2Sap(Mtp2SapMO mtp2Sap)
Sets the Mtp2 Service Access Point associated with this Signalling Link.
01 September 99
If you have any comments or queries, please mail them to JainOAM@East.Sun.Com

Copyright - 1999 Sun Microsystems