Package org.opends.server.protocols.ldap

Class LdapStatistics

java.lang.Object
org.opends.server.protocols.ldap.LdapStatistics
public final class LdapStatistics extends Object
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
    Description
    LdapStatistics()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    getAllRequests()
    Returns the number of requests of all kind that have been received.
    long
    getBindRequests()
    Retrieves the number of bind requests that have been received.
    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
    getDeleteRequests()
    Retrieves the number of delete requests that have been received.
    long
    getExtendedRequests()
    Retrieves the number of extended requests that have been received.
    long
    getModifyDnRequests()
    Retrieves the number of modify DN requests that have been received.
    long
    getModifyRequests()
    Retrieves the number of modify requests that have been received.
    long
    getOperationsAbandoned()
    Retrieves the number of operations that have been abandoned by clients.
    long
    getSearchRequests()
    Retrieves the number of search requests that have been received.
    void
    updateBytesRead(int bytes)
    Updates the counter for the number of bytes that have been read from the network.
    void
    updateBytesWritten(int bytes)
    Updates the counter for the number of bytes that have been written to the network.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • LdapStatistics

      public LdapStatistics()

  • Method Details

    • updateBytesRead

      public void updateBytesRead(int bytes)
      Updates the counter for the number of bytes that have been read from the network.
      Parameters:
      bytes - The number of bytes read from the network.

    • updateBytesWritten

      public void updateBytesWritten(int bytes)
      Updates the counter for the number of bytes that have been written to the network.
      Parameters:
      bytes - The number of bytes written to the network.

    • 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.

    • 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.

    • getBindRequests

      public long getBindRequests()
      Retrieves the number of bind requests that have been received.
      Returns:
      The number of bind requests that have been received.

    • getCompareRequests

      public long getCompareRequests()
      Retrieves the number of compare requests that have been received.
      Returns:
      The number of compare requests that have been received.

    • getDeleteRequests

      public long getDeleteRequests()
      Retrieves the number of delete requests that have been received.
      Returns:
      The number of delete requests that have been received.

    • getExtendedRequests

      public long getExtendedRequests()
      Retrieves the number of extended requests that have been received.
      Returns:
      The number of extended requests that have been received.

    • getModifyRequests

      public long getModifyRequests()
      Retrieves the number of modify requests that have been received.
      Returns:
      The number of modify requests that have been received.

    • 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.

    • getSearchRequests

      public long getSearchRequests()
      Retrieves the number of search requests that have been received.
      Returns:
      The number of search requests that have been received.

    • getAllRequests

      public long getAllRequests()
      Returns the number of requests of all kind that have been received.
      Returns:
      The number of requests of all kind that have been received.