|
|||||||||
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<MonitorProviderCfg>
org.opends.server.protocols.ldap.LDAPStatistics
public class LDAPStatistics
This class defines a data structure that will be used to keep track of various metrics related to LDAP communication that the server has conducted. The statistics that will be tracked include:
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 | |
---|---|
LDAPStatistics(java.lang.String instanceName)
Creates a new instance of this class with no parent. |
|
LDAPStatistics(java.lang.String instanceName,
LDAPStatistics parent)
Creates a new instance of this class with the specified parent. |
Method Summary | |
---|---|
void |
clearStatistics()
Clears any statistical information collected to this point. |
long |
getAbandonRequests()
Retrieves the number of abandon requests that have been received. |
long |
getAddRequests()
Retrieves the number of add requests that have been received. |
long |
getAddResponses()
Retrieves the number of add responses that have been sent. |
long |
getBindRequests()
Retrieves the number of bind requests that have been received. |
long |
getBindResponses()
Retrieves the number of bind responses that have been sent. |
long |
getBytesRead()
Retrieves the number of bytes that have been received from clients. |
long |
getBytesWritten()
Retrieves the number of bytes that have been written to clients. |
long |
getCompareRequests()
Retrieves the number of compare requests that have been received. |
long |
getCompareResponses()
Retrieves the number of compare responses that have been sent. |
long |
getConnectionsClosed()
Retrieves the number of client connections that have been closed. |
long |
getConnectionsEstablished()
Retrieves the number of client connections that have been established. |
long |
getDeleteRequests()
Retrieves the number of delete requests that have been received. |
long |
getDeleteResponses()
Retrieves the number of delete responses that have been sent. |
long |
getExtendedRequests()
Retrieves the number of extended requests that have been received. |
long |
getExtendedResponses()
Retrieves the number of extended responses that have been sent. |
long |
getMessagesRead()
Retrieves the number of LDAP messages that have been received from clients. |
long |
getMessagesWritten()
Retrieves the number of LDAP messages that have been written to clients. |
long |
getModifyDNRequests()
Retrieves the number of modify DN requests that have been received. |
long |
getModifyDNResponses()
Retrieves the number of modify DN responses that have been sent. |
long |
getModifyRequests()
Retrieves the number of modify requests that have been received. |
long |
getModifyResponses()
Retrieves the number of modify responses that have been sent. |
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 |
getOperationsAbandoned()
Retrieves the number of operations that have been abandoned by clients. |
long |
getOperationsCompleted()
Retrieves the number of operations for which the server has completed processing. |
long |
getOperationsInitiated()
Retrieves the number of operations that have been initiated by clients. |
LDAPStatistics |
getParent()
Retrieves the parent statistics tracker that will also be updated whenever this tracker is updated. |
long |
getSearchRequests()
Retrieves the number of search requests that have been received. |
long |
getSearchResultEntries()
Retrieves the number of search result entries that have been sent. |
long |
getSearchResultReferences()
Retrieves the number of search result references that have been sent. |
long |
getSearchResultsDone()
Retrieves the number of search result done messages that have been sent. |
long |
getUnbindRequests()
Retrieves the number of unbind requests that have been received. |
long |
getUpdateInterval()
Retrieves the length of time in milliseconds that should elapse between calls to the updateMonitorData() method. |
void |
initializeMonitorProvider(MonitorProviderCfg configuration)
Initializes this monitor provider based on the information in the provided configuration entry. |
void |
updateAbandonedOperation()
Updates the appropriate set of counters to indicate that an operation was abandoned without sending a response to the client. |
void |
updateBytesRead(int bytesRead)
Updates the appropriate set of counters to indicate that the specified number of bytes have been read by the client. |
void |
updateConnect()
Updates the appropriate set of counters to indicate that a new connection has been established. |
void |
updateDisconnect()
Updates the appropriate set of counters to indicate that a connection has been closed. |
void |
updateMessageRead(LDAPMessage message)
Updates the appropriate set of counters based on the provided message that has been read from the client. |
void |
updateMessageWritten(LDAPMessage message,
int bytesWritten)
Updates the appropriate set of counters based on the provided message that has been written to the client. |
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 LDAPStatistics(java.lang.String instanceName)
instanceName
- The name for this monitor provider instance.public LDAPStatistics(java.lang.String instanceName, LDAPStatistics parent)
instanceName
- The name for this monitor provider instance.parent
- The parent object that should also be updated
whenever this class is updated. It may be null if
there should not be a parent.Method Detail |
---|
public void initializeMonitorProvider(MonitorProviderCfg configuration) throws ConfigException
initializeMonitorProvider
in class MonitorProvider<MonitorProviderCfg>
configuration
- The configuration to use to initialize
this monitor provider.
ConfigException
- If an unrecoverable problem arises in
the process of performing the
initialization.public java.lang.String getMonitorInstanceName()
getMonitorInstanceName
in class MonitorProvider<MonitorProviderCfg>
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<MonitorProviderCfg>
updateMonitorData()
method.public void updateMonitorData()
getUpdateInterval()
milliseconds apart, but no guarantees will
be made.
updateMonitorData
in class MonitorProvider<MonitorProviderCfg>
public java.util.ArrayList<Attribute> getMonitorData()
getMonitorData
in class MonitorProvider<MonitorProviderCfg>
public void clearStatistics()
public void updateConnect()
public void updateDisconnect()
public void updateBytesRead(int bytesRead)
bytesRead
- The number of bytes read by the client.public void updateMessageRead(LDAPMessage message)
message
- The message that was read from the client.public void updateMessageWritten(LDAPMessage message, int bytesWritten)
message
- The message that was written to the client.bytesWritten
- The size of the message written in bytes.public void updateAbandonedOperation()
public long getConnectionsEstablished()
public long getConnectionsClosed()
public long getBytesRead()
public long getBytesWritten()
public long getMessagesRead()
public long getMessagesWritten()
public long getOperationsInitiated()
public long getOperationsCompleted()
public long getOperationsAbandoned()
public long getAbandonRequests()
public long getAddRequests()
public long getAddResponses()
public long getBindRequests()
public long getBindResponses()
public long getCompareRequests()
public long getCompareResponses()
public long getDeleteRequests()
public long getDeleteResponses()
public long getExtendedRequests()
public long getExtendedResponses()
public long getModifyRequests()
public long getModifyResponses()
public long getModifyDNRequests()
public long getModifyDNResponses()
public long getSearchRequests()
public long getSearchResultEntries()
public long getSearchResultReferences()
public long getSearchResultsDone()
public long getUnbindRequests()
public LDAPStatistics getParent()
null
if there is none.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |