LDAPStatistics (OpenDJ 3.0.0 Documentation)

java.lang.Object
- org.opends.server.api.MonitorProvider<MonitorProviderCfg>
- - org.opends.server.protocols.ldap.LDAPStatistics

Direct Known Subclasses:

HTTPStatistics
```
public class LDAPStatistics
extends MonitorProvider<MonitorProviderCfg>
```
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:
- The total number of LDAP client connections accepted by the server.
- The total number of LDAP client connections that have been closed.
- The total number of LDAP messages read, both overall and broken down by message type.
- The total number of LDAP messages written, both overall and broken down by message type.
- The total number of bytes read from LDAP clients.
- The total number of bytes written to LDAP clients.
This class may also be used in a hierarchical form if it is desirable to get specific and general statistics at the same time (e.g., information about the interaction with a specific client or aggregated for all clients).

Constructor Summary

Constructors
Constructor and Description

LDAPStatistics(String instanceName)
Creates a new instance of this class with the specified parent.

Constructors
Constructor and Description
`LDAPStatistics(String instanceName)` Creates a new instance of this class with the specified parent.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clearStatistics()` Clears any statistical information collected to this point.
`protected Attribute`	`createAttribute(String name, Object value)` Constructs an attribute using the provided information.
`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.
`List<Attribute>`	`getMonitorData()` Retrieves a set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested.
`String`	`getMonitorInstanceName()` Retrieves the name of this monitor provider.
`ObjectClass`	`getMonitorObjectClass()` Retrieves the objectclass that should be included in the monitor entry created from 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.
`long`	`getSearchOneRequests()` Retrieves the number of one-level search requests that have been received.
`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`	`getSearchSubRequests()` Retrieves the number of subtree search requests that have been received.
`long`	`getUnbindRequests()` Retrieves the number of unbind requests that have been received.
`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`	`updateBytesWritten(int bytesWritten)` Updates the appropriate set of counters to indicate that the specified number of bytes have been written to 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)` Updates the appropriate set of counters based on the provided message that has been written to the client.
`void`	`updateOperationMonitoringData(OperationType type, long time)` Update the operation counters and times depending on the OperationType.

Methods inherited from class org.opends.server.api.MonitorProvider
finalizeMonitorProvider, isConfigurationAcceptable, scheduleUpdate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LDAPStatistics
```
public LDAPStatistics(String instanceName)
```
    Creates a new instance of this class with the specified parent.
    
    Parameters:
    instanceName - The name for this monitor provider instance.
- Method Detail
  - initializeMonitorProvider
```
public void initializeMonitorProvider(MonitorProviderCfg configuration)
                               throws org.forgerock.opendj.config.server.ConfigException
```
    Initializes this monitor provider based on the information in the provided configuration entry.
    
    Overrides:
    
    initializeMonitorProvider in class MonitorProvider<MonitorProviderCfg>
    
    Parameters:
    configuration - The configuration to use to initialize this monitor provider.
    
    Throws:
    
    org.forgerock.opendj.config.server.ConfigException - If an unrecoverable problem arises in the process of performing the initialization.
  - getMonitorInstanceName
```
public String getMonitorInstanceName()
```
    Retrieves the name of this monitor provider. It should be unique among all monitor providers, including all instances of the same monitor provider.
    
    Specified by:
    
    getMonitorInstanceName in class MonitorProvider<MonitorProviderCfg>
    
    Returns:
    The name of this monitor provider.
  - getMonitorObjectClass
```
public ObjectClass getMonitorObjectClass()
```
    Retrieves the objectclass that should be included in the monitor entry created from this monitor provider. This may be overridden by subclasses that wish to include their own custom objectclass in the monitor entry (e.g., to make it easier to search for monitor entries of that type). The default implementation returns the "extensibleObject" objectclass.
    
    Overrides:
    
    getMonitorObjectClass in class MonitorProvider<MonitorProviderCfg>
    
    Returns:
    The objectclass that should be included in the monitor entry created from this monitor provider.
  - getMonitorData
```
public List<Attribute> getMonitorData()
```
    Retrieves a set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested.
    
    Specified by:
    
    getMonitorData in class MonitorProvider<MonitorProviderCfg>
    
    Returns:
    A set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested.
  - clearStatistics
```
public void clearStatistics()
```
    Clears any statistical information collected to this point.
  - updateConnect
```
public void updateConnect()
```
    Updates the appropriate set of counters to indicate that a new connection has been established.
  - updateDisconnect
```
public void updateDisconnect()
```
    Updates the appropriate set of counters to indicate that a connection has been closed.
  - updateBytesRead
```
public void updateBytesRead(int bytesRead)
```
    Updates the appropriate set of counters to indicate that the specified number of bytes have been read by the client.
    
    Parameters:
    bytesRead - The number of bytes read by the client.
  - updateBytesWritten
```
public void updateBytesWritten(int bytesWritten)
```
    Updates the appropriate set of counters to indicate that the specified number of bytes have been written to the client.
    
    Parameters:
    bytesWritten - The number of bytes written to the client.
  - updateMessageRead
```
public void updateMessageRead(LDAPMessage message)
```
    Updates the appropriate set of counters based on the provided message that has been read from the client.
    
    Parameters:
    message - The message that was read from the client.
  - updateMessageWritten
```
public void updateMessageWritten(LDAPMessage message)
```
    Updates the appropriate set of counters based on the provided message that has been written to the client.
    
    Parameters:
    message - The message that was written to the client.
  - updateAbandonedOperation
```
public void updateAbandonedOperation()
```
    Updates the appropriate set of counters to indicate that an operation was abandoned without sending a response to the client.
  - createAttribute
```
protected Attribute createAttribute(String name,
                        Object value)
```
    Constructs an attribute using the provided information. It will use the server's schema definitions.
    
    Parameters:
    name - The name to use for the attribute.
    value - The value to use for the attribute.
    
    Returns:
    the constructed attribute.
  - getConnectionsEstablished
```
public long getConnectionsEstablished()
```
    Retrieves the number of client connections that have been established.
    
    Returns:
    The number of client connections that have been established.
  - getConnectionsClosed
```
public long getConnectionsClosed()
```
    Retrieves the number of client connections that have been closed.
    
    Returns:
    The number of client connections that have been closed.
  - getBytesRead
```
public long getBytesRead()
```
    Retrieves the number of bytes that have been received from clients.
    
    Returns:
    The number of bytes that have been received from clients.
  - getBytesWritten
```
public long getBytesWritten()
```
    Retrieves the number of bytes that have been written to clients.
    
    Returns:
    The number of bytes that have been written to clients.
  - getMessagesRead
```
public long getMessagesRead()
```
    Retrieves the number of LDAP messages that have been received from clients.
    
    Returns:
    The number of LDAP messages that have been received from clients.
  - getMessagesWritten
```
public long getMessagesWritten()
```
    Retrieves the number of LDAP messages that have been written to clients.
    
    Returns:
    The number of LDAP messages that have been written to clients.
  - getOperationsInitiated
```
public long getOperationsInitiated()
```
    Retrieves the number of operations that have been initiated by clients.
    
    Returns:
    The number of operations that have been initiated by clients.
  - getOperationsCompleted
```
public long getOperationsCompleted()
```
    Retrieves the number of operations for which the server has completed processing.
    
    Returns:
    The number of operations for which the server has completed processing.
  - getOperationsAbandoned
```
public long getOperationsAbandoned()
```
    Retrieves the number of operations that have been abandoned by clients.
    
    Returns:
    The number of operations that have been abandoned by clients.
  - getAbandonRequests
```
public long getAbandonRequests()
```
    Retrieves the number of abandon requests that have been received.
    
    Returns:
    The number of abandon requests that have been received.
  - getAddRequests
```
public long getAddRequests()
```
    Retrieves the number of add requests that have been received.
    
    Returns:
    The number of add requests that have been received.
  - getAddResponses
```
public long getAddResponses()
```
    Retrieves the number of add responses that have been sent.
    
    Returns:
    The number of add responses that have been sent.
  - getBindRequests
```
public long getBindRequests()
```
    Retrieves the number of bind requests that have been received.
    
    Returns:
    The number of bind requests that have been received.
  - getBindResponses
```
public long getBindResponses()
```
    Retrieves the number of bind responses that have been sent.
    
    Returns:
    The number of bind responses that have been sent.
  - getCompareRequests
```
public long getCompareRequests()
```
    Retrieves the number of compare requests that have been received.
    
    Returns:
    The number of compare requests that have been received.
  - getCompareResponses
```
public long getCompareResponses()
```
    Retrieves the number of compare responses that have been sent.
    
    Returns:
    The number of compare responses that have been sent.
  - getDeleteRequests
```
public long getDeleteRequests()
```
    Retrieves the number of delete requests that have been received.
    
    Returns:
    The number of delete requests that have been received.
  - getDeleteResponses
```
public long getDeleteResponses()
```
    Retrieves the number of delete responses that have been sent.
    
    Returns:
    The number of delete responses that have been sent.
  - getExtendedRequests
```
public long getExtendedRequests()
```
    Retrieves the number of extended requests that have been received.
    
    Returns:
    The number of extended requests that have been received.
  - getExtendedResponses
```
public long getExtendedResponses()
```
    Retrieves the number of extended responses that have been sent.
    
    Returns:
    The number of extended responses that have been sent.
  - getModifyRequests
```
public long getModifyRequests()
```
    Retrieves the number of modify requests that have been received.
    
    Returns:
    The number of modify requests that have been received.
  - getModifyResponses
```
public long getModifyResponses()
```
    Retrieves the number of modify responses that have been sent.
    
    Returns:
    The number of modify responses that have been sent.
  - getModifyDNRequests
```
public long getModifyDNRequests()
```
    Retrieves the number of modify DN requests that have been received.
    
    Returns:
    The number of modify DN requests that have been received.
  - getModifyDNResponses
```
public long getModifyDNResponses()
```
    Retrieves the number of modify DN responses that have been sent.
    
    Returns:
    The number of modify DN responses that have been sent.
  - getSearchRequests
```
public long getSearchRequests()
```
    Retrieves the number of search requests that have been received.
    
    Returns:
    The number of search requests that have been received.
  - getSearchOneRequests
```
public long getSearchOneRequests()
```
    Retrieves the number of one-level search requests that have been received.
    
    Returns:
    The number of one-level search requests that have been received.
  - getSearchSubRequests
```
public long getSearchSubRequests()
```
    Retrieves the number of subtree search requests that have been received.
    
    Returns:
    The number of subtree search requests that have been received.
  - getSearchResultEntries
```
public long getSearchResultEntries()
```
    Retrieves the number of search result entries that have been sent.
    
    Returns:
    The number of search result entries that have been sent.
  - getSearchResultReferences
```
public long getSearchResultReferences()
```
    Retrieves the number of search result references that have been sent.
    
    Returns:
    The number of search result references that have been sent.
  - getSearchResultsDone
```
public long getSearchResultsDone()
```
    Retrieves the number of search result done messages that have been sent.
    
    Returns:
    The number of search result done messages that have been sent.
  - getUnbindRequests
```
public long getUnbindRequests()
```
    Retrieves the number of unbind requests that have been received.
    
    Returns:
    The number of unbind requests that have been received.
  - updateOperationMonitoringData
```
public void updateOperationMonitoringData(OperationType type,
                                 long time)
```
    Update the operation counters and times depending on the OperationType.
    
    Parameters:
    type - of the operation.
    time - of the operation execution.

Class LDAPStatistics

Constructor Summary

Method Summary

Methods inherited from class org.opends.server.api.MonitorProvider

Methods inherited from class java.lang.Object

Constructor Detail

LDAPStatistics

Method Detail

initializeMonitorProvider

getMonitorInstanceName

getMonitorObjectClass

getMonitorData

clearStatistics

updateConnect

updateDisconnect

updateBytesRead

updateBytesWritten

updateMessageRead

updateMessageWritten

updateAbandonedOperation

createAttribute

getConnectionsEstablished

getConnectionsClosed

getBytesRead

getBytesWritten

getMessagesRead

getMessagesWritten

getOperationsInitiated

getOperationsCompleted

getOperationsAbandoned

getAbandonRequests

getAddRequests

getAddResponses

getBindRequests

getBindResponses

getCompareRequests

getCompareResponses

getDeleteRequests

getDeleteResponses

getExtendedRequests

getExtendedResponses

getModifyRequests

getModifyResponses

getModifyDNRequests

getModifyDNResponses

getSearchRequests

getSearchOneRequests

getSearchSubRequests

getSearchResultEntries

getSearchResultReferences

getSearchResultsDone

getUnbindRequests

updateOperationMonitoringData