|
OpenNMS API 1.1.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opennms.netmgt.poller.IPv4Monitor
org.opennms.netmgt.poller.LdapMonitor
This class is designed to be used by the service poller framework to test the availability of a generic LDAP service on remote interfaces. The class implements the ServiceMonitor interface that allows it to be used along with other plug-ins by the service poller framework.
Nested Class Summary | |
private class |
LdapMonitor.TimeoutLDAPSocket
A class to add a timeout to the socket that the LDAP code uses to access an LDAP server |
Field Summary | |
private static java.lang.String |
DEFAULT_BASE
Default search base for an LDAP search |
private static java.lang.String |
DEFAULT_FILTER
Default search filter for an LDAP search |
private static int |
DEFAULT_RETRY
Default retries. |
private static int |
DEFAULT_TIMEOUT
Default timeout. |
Fields inherited from interface org.opennms.netmgt.poller.ServiceMonitor |
SERVICE_AVAILABLE, SERVICE_STATUS_MASK, SERVICE_UNAVAILABLE, SERVICE_UNRESPONSIVE, SURPRESS_EVENT_MASK |
Constructor Summary | |
(package private) |
LdapMonitor()
|
Method Summary | |
void |
initialize(java.util.Map parameters)
This method is called after the framework creates an instance of the plug-in. |
void |
initialize(NetworkInterface iface)
This method is called whenever a new interface that supports the plug-in service is added to the scheduling system. |
int |
poll(NetworkInterface iface,
java.util.Map parameters,
Package pkg)
Poll the specified address for service availability. |
void |
release()
This method is called whenever the plug-in is being unloaded, normally during framework exit. |
void |
release(NetworkInterface iface)
This method is the called whenever an interface is being removed from the scheduler. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
private static final int DEFAULT_RETRY
private static final int DEFAULT_TIMEOUT
private static final java.lang.String DEFAULT_BASE
private static final java.lang.String DEFAULT_FILTER
Constructor Detail |
LdapMonitor()
Method Detail |
public int poll(NetworkInterface iface, java.util.Map parameters, Package pkg)
iface
- The network interface to test the service on.parameters
- The package parameters (timeout, retry, etc...) to be used for this poll.
java.lang.RuntimeException
- Thrown if the interface experiences errors during the poll.ServiceMonitor.SURPRESS_EVENT_MASK
,
ServiceMonitor.SERVICE_AVAILABLE
,
ServiceMonitor.SERVICE_UNAVAILABLE
public void initialize(java.util.Map parameters)
This method is called after the framework creates an instance of the plug-in. The framework passes the object a proxy object that can be used to retreive configuration information specific to the plug-in. Additionally, any parameters for the plug-in from the package definition are passed using the parameters element.
If there is a critical error, like missing service libraries, the the montior may throw a ServiceMonitorException. If the plug-in throws an exception then the plug-in will be disabled in the framework.
initialize
in interface ServiceMonitor
parameters
- Not currently used
java.lang.RuntimeException
- Thrown if
an unrecoverable error occurs that prevents the plug-in from functioning.public void release()
This method is called whenever the plug-in is being unloaded, normally during framework exit. During this time the framework may release any resource and save any state information using the proxy object from the initialization routine.
Even if the plug-in throws a monitor exception, it will not prevent the plug-in from being unloaded. The plug-in should not return until all of its state information is saved. Once the plug-in returns from this call its configuration proxy object is considered invalid.
release
in interface ServiceMonitor
java.lang.RuntimeException
- Thrown if an error occurs
during deallocation.public void initialize(NetworkInterface iface)
This method is called whenever a new interface that supports the plug-in service is added to the scheduling system. The plug-in has the option to load and/or associate configuration information with the interface before the framework begins scheduling the new device.
Should a monitor exception be thrown during an initialization call then the framework will log an error and discard the interface from scheduling.
initialize
in interface ServiceMonitor
iface
- The network interface to be added to the scheduler.
java.lang.RuntimeException
- Thrown if an unrecoverable error
occurs that prevents the interface from being monitored.
NetworkInterfaceNotSupportedException
- Thrown
if the passed interface is invalid for this monitor.public void release(NetworkInterface iface)
This method is the called whenever an interface is being removed from the scheduler. For example, if a service is determined as being no longer supported then this method will be invoked to cleanup any information associated with this device. This gives the implementor of the interface the ability to serialize any data prior to the interface being discarded.
If an exception is thrown during the release the exception will be logged, but the interface will still be discarded for garbage collection.
release
in interface ServiceMonitor
iface
- The network interface that was being monitored.
java.lang.RuntimeException
- Thrown if an unrecoverable error
occurs that prevents the interface from being monitored.
|
OpenNMS API 1.1.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |