net.juniper.smgt.acp.application
Interface CongestionPointChecker

public interface CongestionPointChecker

This interface provides two ways to learn about network congestion points.

Method Summary

CongestionPoint

checkCongestionPoint(java.lang.String filter, int timeout) This method will return a reference to the congestion point specified by 'filter'.

Method Detail

checkCongestionPoint

CongestionPoint checkCongestionPoint(java.lang.String filter,
                                     int timeout)

This method will return a reference to the congestion point specified by 'filter'. It will block until a congestion point matching the filter is reported to the ACP, or until 'timeout' expires, whichever occurs first. Note that, after obtaining a congestion point, a listener may be registered with that congestion point to be notified when the congestion point changes or goes down.

The filter parameter is a string of the form "(<attribute name> = <attribute value>)", where <attribute name> is the name of a congestion point attribute. The possible attribute names are listed in the Javadoc for the method CongestionPoint.getAttribute(String attr). The <attribute value> may be one of the following:

• A string - Matches if any of the named attribute's values equals the string. This is case insensitive.
• A string that contains an asterisk character - which matches in the same way as a string literal, except that the asterisk character acts as a wild card representing zero or more arbitrary characters in the value.

Finally, a filter may consist of a set of filters, as defined above, combined using logical AND, OR, and NOT operators. This may take one of the following forms:

• (&(<filter>)(<filter>)...) - Matches if all filters match.
• (|(<filter>)(<filter>)...) - Matches if any filter matches.
• (!(<filter>)) - Matches if the filter does not match.

As well, the following special filters exists:

• () - Matches no values.
• (*) - Matches all values.

An example of a filter is: (&(interfaceName = fastEthernet3/*)(routerName = default@junos))").

Parameters:

filter - The criteria that the congestion point's attributes must match, as defined above.

timeout - The maximum time to wait, in seconds. Zero means wait forever. A negative number means return immediately.

Returns:

A CongestionPoint instance.

See Also:

CongestionPoint.addListener(CongestionPointListener)