|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Thread
org.opends.server.api.DirectoryThread
org.opends.server.api.MonitorProvider<ClientConnectionMonitorProviderCfg>
org.opends.server.monitors.ClientConnectionMonitorProvider
public class ClientConnectionMonitorProvider
This class defines a Directory Server monitor provider that can be used to obtain information about the client connections established to the server. Note that the information reported is obtained with little or no locking, so it may not be entirely consistent, especially for active connections.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class java.lang.Thread |
---|
java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler |
Field Summary |
---|
Fields inherited from class java.lang.Thread |
---|
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY |
Constructor Summary | |
---|---|
ClientConnectionMonitorProvider()
Creates an instance of this monitor provider. |
Method Summary | |
---|---|
java.util.ArrayList<Attribute> |
getMonitorData()
Retrieves a set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested. |
java.lang.String |
getMonitorInstanceName()
Retrieves the name of this monitor provider. |
long |
getUpdateInterval()
Retrieves the length of time in milliseconds that should elapse between calls to the updateMonitorData() method. |
void |
initializeMonitorProvider(ClientConnectionMonitorProviderCfg configuration)
Initializes this monitor provider based on the information in the provided configuration entry. |
void |
updateMonitorData()
Performs any processing periodic processing that may be desired to update the information associated with this monitor. |
Methods inherited from class org.opends.server.api.MonitorProvider |
---|
finalizeMonitorProvider, getMonitorObjectClass, isConfigurationAcceptable, run |
Methods inherited from class org.opends.server.api.DirectoryThread |
---|
getAssociatedTask, getCreationStackTrace, getDebugProperties, getParentThread, setAssociatedTask |
Methods inherited from class java.lang.Thread |
---|
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ClientConnectionMonitorProvider()
Method Detail |
---|
public void initializeMonitorProvider(ClientConnectionMonitorProviderCfg configuration) throws ConfigException, InitializationException
initializeMonitorProvider
in class MonitorProvider<ClientConnectionMonitorProviderCfg>
configuration
- The configuration to use to initialize
this monitor provider.
ConfigException
- If an unrecoverable problem arises in
the process of performing the
initialization.
InitializationException
- If a problem occurs during
initialization that is not
related to the server
configuration.public java.lang.String getMonitorInstanceName()
getMonitorInstanceName
in class MonitorProvider<ClientConnectionMonitorProviderCfg>
public long getUpdateInterval()
updateMonitorData()
method. A negative or zero
return value indicates that the updateMonitorData()
method
should not be periodically invoked.
getUpdateInterval
in class MonitorProvider<ClientConnectionMonitorProviderCfg>
updateMonitorData()
method.public void updateMonitorData()
getUpdateInterval()
milliseconds apart, but no guarantees will
be made.
updateMonitorData
in class MonitorProvider<ClientConnectionMonitorProviderCfg>
public java.util.ArrayList<Attribute> getMonitorData()
getMonitorData
in class MonitorProvider<ClientConnectionMonitorProviderCfg>
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |