Package org.forgerock.opendj.server.config.client

Interface LdapConnectionHandlerCfgClient

All Superinterfaces:
ConfigurationClient, ConnectionHandlerCfgClient, NetConnectionHandlerCfgClient
public interface LdapConnectionHandlerCfgClient extends NetConnectionHandlerCfgClient
A client-side interface for reading and modifying LDAP Connection Handler settings.

The LDAP Connection Handler is used to interact with clients using LDAP.

  • Method Details

    • definition

      ManagedObjectDefinition<? extends LdapConnectionHandlerCfgClient,? extends LdapConnectionHandlerCfg> definition()
      Get the configuration definition associated with this LDAP Connection Handler.
      Specified by:
      definition in interface ConfigurationClient
      Specified by:
      definition in interface ConnectionHandlerCfgClient
      Specified by:
      definition in interface NetConnectionHandlerCfgClient
      Returns:
      Returns the configuration definition associated with this LDAP Connection Handler.

    • getBufferSize

      ValueOrExpression<Long> getBufferSize()
      Gets the "buffer-size" property.

      Specifies the size in bytes of the LDAP response message write buffer.

      This property specifies write buffer size allocated by the server for each client connection and used to buffer LDAP response messages data when writing.

      Default value: 4096 bytes

      Returns:
      Returns the value of the "buffer-size" property.

    • setBufferSize

      void setBufferSize(ValueOrExpression<Long> value) throws PropertyException
      Sets the "buffer-size" property.

      Specifies the size in bytes of the LDAP response message write buffer.

      This property specifies write buffer size allocated by the server for each client connection and used to buffer LDAP response messages data when writing.

      Parameters:
      value - The value of the "buffer-size" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getJavaClass

      @MandatoryProperty ValueOrExpression<String> getJavaClass()
      Gets the "java-class" property.

      Specifies the fully-qualified name of the Java class that provides the LDAP Connection Handler implementation.

      Default value: org.opends.server.protocols.ldap.LdapConnectionHandler

      Specified by:
      getJavaClass in interface ConnectionHandlerCfgClient
      Specified by:
      getJavaClass in interface NetConnectionHandlerCfgClient
      Returns:
      Returns the value of the "java-class" property.

    • setJavaClass

      @MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
      Sets the "java-class" property.

      Specifies the fully-qualified name of the Java class that provides the LDAP Connection Handler implementation.

      Specified by:
      setJavaClass in interface ConnectionHandlerCfgClient
      Specified by:
      setJavaClass in interface NetConnectionHandlerCfgClient
      Parameters:
      value - The value of the "java-class" property.
      Throws:
      PropertyException - If the new value is invalid.

    • isKeepStats

      ValueOrExpression<Boolean> isKeepStats()
      Gets the "keep-stats" property.

      Indicates whether the LDAP Connection Handler should keep statistics.

      If enabled, the LDAP Connection Handler maintains statistics about the number and types of operations requested over LDAP and the amount of data sent and received.

      Default value: true

      Returns:
      Returns the value of the "keep-stats" property.

    • setKeepStats

      void setKeepStats(ValueOrExpression<Boolean> value) throws PropertyException
      Sets the "keep-stats" property.

      Indicates whether the LDAP Connection Handler should keep statistics.

      If enabled, the LDAP Connection Handler maintains statistics about the number and types of operations requested over LDAP and the amount of data sent and received.

      Parameters:
      value - The value of the "keep-stats" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getNumRequestHandlers

      ValueOrExpression<Integer> getNumRequestHandlers()
      Gets the "num-request-handlers" property.

      Specifies the number of request handlers that are used to read requests from clients.

      The LDAP Connection Handler uses one thread to accept new connections from clients, but uses one or more additional threads to read requests from existing client connections. This ensures that new requests are read efficiently and that the connection handler itself does not become a bottleneck when the server is under heavy load from many clients at the same time.

      Returns:
      Returns the value of the "num-request-handlers" property.

    • setNumRequestHandlers

      void setNumRequestHandlers(ValueOrExpression<Integer> value) throws PropertyException
      Sets the "num-request-handlers" property.

      Specifies the number of request handlers that are used to read requests from clients.

      The LDAP Connection Handler uses one thread to accept new connections from clients, but uses one or more additional threads to read requests from existing client connections. This ensures that new requests are read efficiently and that the connection handler itself does not become a bottleneck when the server is under heavy load from many clients at the same time.

      Parameters:
      value - The value of the "num-request-handlers" property.
      Throws:
      PropertyException - If the new value is invalid.