ACP API

net.juniper.smgt.acp.application
Interface CongestionPoint


public interface CongestionPoint

A CongestionPoint instance represents a real or virtual network traffic congestion point in the network. It may be useful to obtain information about other congestion points in the network. This can be done by asking the CongestionPointChecker for instances of this interface.


Method Summary
 void addListener(CongestionPointListener cpl)
          Register to receive notifications when the congestion point changes or goes down.
 java.lang.Object getAttribute(java.lang.String attrName)
          Returns the specified attribute for this congestion point.
 void removeListener(CongestionPointListener cpl)
          Unregister a listener previously registered using the addListener() method.
 

Method Detail

getAttribute

java.lang.Object getAttribute(java.lang.String attrName)
                              throws ActionCongestionPointException
Returns the specified attribute for this congestion point.

Parameters:
attrName - Attribute names are specified as follows:

Attribute names can use following format:
Simple (name) - attribute name
Nested (name1.name2.name3) The attribute value is assumed to be a JavaBean.
Indexed (name[index]) - The attribute value is assumed to be an array.
Mapped (name(key)) - The attribute value is assumed to be an map and have a JavaBean style property getter method.
Combined (name1.name2[index].name3(key)) - Combining mapped, nested, and indexed references is also supported.

The possible names are as follows:
hostname Name of the host on which the SAE is installed.
routerName Name of the virtual router, in the format <virtualRouter>@<router>.
interfaceName Name of the interface (e.g. "fastethernet 3/1"). For LSP ingress interfaces, this is the LSP path name.
interfaceSpeed Bandwidth of the interface, in bits per second. For LSP ingress interfaces, this is the LSP path bandwidth.
interfaceAlias Alias of the interface that is configured on the JUNOSe router with the interface ip description command
interfaceDescr Alternative name of the interface that SNMP uses
portId Identifier of the VLAN or virtual circuit; virtual circuit takes the format <VPI>|<VCI>. This attribute is not supported on JUNOS routing platforms
loginName Subscriber's login name.
accountingId Value of the LDAP attribute accountingUserId
ifRadiusClass RADIUS class attribute of the underlying router interface. This attribute is not supported on JUNOS routing platforms
ifSessionId Identifier for RADIUS accounting of the underlying router interface. This attribute is not supported on JUNOS routing platforms
userMacAddress MAC address of the DHCP subscriber. This attribute is not supported on JUNOS routing platforms
dhcpPacket Contents of the DHCP discover request, in the format:
- First 4 octets - gateway IP address (giaddr field)
- Remaining octets - DHCP options; for more information, see RFC 2251
userType Type of subscriber
userRadiusClass RADIUS class of the subscriber session for a service. This attribute can occur multiple times, and can be returned by an authorization plug-in
primaryUserName pppLoginName or publicDhcpUserName. This attribute is not supported on JUNOS routing platforms
ifIndex SNMP index of interface. This attribute is not supported on JUNOS routing platforms.
nasPort Numeric identifier that the router uses to identify the interface to RADIUS.
userInetAddress IP address of the subscriber that uses a byte array instead of an integer.
nasInetAddress IP address of the router that uses a byte array instead of an integer.
routerType Type of the router driver
Returns:
May return null, or in same cases -1, if the specified property has no value.
Throws:
ActionCongestionPointException - If the attrName is invalid.

addListener

void addListener(CongestionPointListener cpl)
Register to receive notifications when the congestion point changes or goes down.


removeListener

void removeListener(CongestionPointListener cpl)
Unregister a listener previously registered using the addListener() method.


ACP API