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

Interface HttpConnectionHandlerCfg

All Superinterfaces:
Configuration, ConnectionHandlerCfg
public interface HttpConnectionHandlerCfg extends ConnectionHandlerCfg
A server-side interface for querying HTTP Connection Handler settings.

HTTP Connection Handlers provide HTTP services built on top of the underlying LDAP directory.

  • Method Details

    • configurationClass

      Class<? extends HttpConnectionHandlerCfg> configurationClass()
      Gets the configuration class associated with this HTTP Connection Handler.
      Specified by:
      configurationClass in interface Configuration
      Specified by:
      configurationClass in interface ConnectionHandlerCfg
      Returns:
      Returns the configuration class associated with this HTTP Connection Handler.

    • addHttpChangeListener

      void addHttpChangeListener(ConfigurationChangeListener<HttpConnectionHandlerCfg> listener)
      Register to be notified when this HTTP Connection Handler is changed.
      Parameters:
      listener - The HTTP Connection Handler configuration change listener.

    • removeHttpChangeListener

      void removeHttpChangeListener(ConfigurationChangeListener<HttpConnectionHandlerCfg> listener)
      Deregister an existing HTTP Connection Handler configuration change listener.
      Parameters:
      listener - The HTTP Connection Handler configuration change listener.

    • getAcceptBacklog

      int getAcceptBacklog()
      Gets the "accept-backlog" property.

      Specifies the maximum number of pending connection attempts that are allowed to queue up in the accept backlog before the server starts rejecting new connection attempts.

      This is primarily an issue for cases in which a large number of connections are established to the server in a very short period of time (for example, a benchmark utility that creates a large number of client threads that each have their own connection to the server) and the connection handler is unable to keep up with the rate at which the new connections are established.

      Default value: 128

      Returns:
      Returns the value of the "accept-backlog" property.

    • getAdvertisedListenAddress

      SortedSet<com.forgerock.opendj.util.Host> getAdvertisedListenAddress()
      Gets the "advertised-listen-address" property.

      The advertised address(es) which clients should use for connecting to this HTTP Connection Handler.

      Multiple addresses may be provided as separate values for this attribute. The meta-address 0.0.0.0 is not permitted.

      Default value is inherited from another property

      Returns:
      Returns an unmodifiable set containing the values of the "advertised-listen-address" property.

    • isAllowTcpReuseAddress

      boolean isAllowTcpReuseAddress()
      Gets the "allow-tcp-reuse-address" property.

      Indicates whether the HTTP Connection Handler should reuse socket descriptors.

      If enabled, the SO_REUSEADDR socket option is used on the server listen socket to potentially allow the reuse of socket descriptors for clients in a TIME_WAIT state. This may help the server avoid temporarily running out of socket descriptors in cases in which a very large number of short-lived connections have been established from the same client system.

      Default value: true

      Returns:
      Returns the value of the "allow-tcp-reuse-address" property.

    • isApiDescriptorEnabled

      boolean isApiDescriptorEnabled()
      Gets the "api-descriptor-enabled" property.

      Indicates whether the HTTP Connection Handler should publish Swagger and CREST API descriptors.

      When enabled, API descriptors facilitate development of new client applications. The API descriptors are not protected and are not recommended for production systems."

      Default value: true

      Returns:
      Returns the value of the "api-descriptor-enabled" property.

    • getBufferSize

      long getBufferSize()
      Gets the "buffer-size" property.

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

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

      Default value: 4096 bytes

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

    • getJavaClass

      String getJavaClass()
      Gets the "java-class" property.

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

      Default value: org.opends.server.protocols.http.HTTPConnectionHandler

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

    • isKeepStats

      boolean isKeepStats()
      Gets the "keep-stats" property.

      Indicates whether the HTTP Connection Handler should keep statistics.

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

      Default value: true

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

    • getKeyManagerProvider

      String getKeyManagerProvider()
      Gets the "key-manager-provider" property.

      Specifies the name of the key manager that should be used with this HTTP Connection Handler .

      Default value is undefined

      Returns:
      Returns the value of the "key-manager-provider" property.

    • getKeyManagerProviderDn

      Dn getKeyManagerProviderDn()
      Gets the "key-manager-provider" property as a DN.

      Specifies the name of the key manager that should be used with this HTTP Connection Handler .

      Returns:
      Returns the DN value of the "key-manager-provider" property.

    • getListenAddress

      SortedSet<com.forgerock.opendj.util.Host> getListenAddress()
      Gets the "listen-address" property.

      The network interface(s) on which this HTTP Connection Handler should listen for incoming client connections.

      Multiple addresses may be provided as separate values for this attribute. If no values are provided, then the directory server will listen on all interfaces.

      Default value is inherited from another property

      Returns:
      Returns an unmodifiable set containing the values of the "listen-address" property.

    • getListenPort

      int getListenPort()
      Gets the "listen-port" property.

      Specifies the port number on which the HTTP Connection Handler will listen for connections from clients.

      Only a single port number may be provided.

      Returns:
      Returns the value of the "listen-port" property.

    • getMaxBlockedWriteTimeLimit

      Duration getMaxBlockedWriteTimeLimit()
      Gets the "max-blocked-write-time-limit" property.

      Specifies the maximum length of time that attempts to write data to HTTP clients should be allowed to block.

      If an attempt to write data to a client takes longer than this length of time, then the client connection is terminated.

      Default value: 30 seconds

      Returns:
      Returns the value of the "max-blocked-write-time-limit" property.

    • getMaxConcurrentOpsPerConnection

      Integer getMaxConcurrentOpsPerConnection()
      Gets the "max-concurrent-ops-per-connection" property.

      Specifies the maximum number of internal operations that each HTTP client connection can execute concurrently.

      This property allow to limit the impact that each HTTP request can have on the whole server by limiting the number of internal operations that each HTTP request can execute concurrently. A value of 0 means that no limit is enforced.

      Returns:
      Returns the value of the "max-concurrent-ops-per-connection" property.

    • getMaxRequestSize

      long getMaxRequestSize()
      Gets the "max-request-size" property.

      Specifies the size in bytes of the largest HTTP request message that will be allowed by the HTTP Connection Handler.

      This can help prevent denial-of-service attacks by clients that indicate they send extremely large requests to the server causing it to attempt to allocate large amounts of memory.

      Default value: 5 megabytes

      Returns:
      Returns the value of the "max-request-size" property.

    • getNumRequestHandlers

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

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

      The HTTP 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.

    • getSslCertNickname

      SortedSet<String> getSslCertNickname()
      Gets the "ssl-cert-nickname" property.

      Specifies the nicknames (also called the aliases) of the keys or key pairs that the HTTP Connection Handler should use when performing SSL communication.

      The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key. This is only applicable when the HTTP Connection Handler is configured to use SSL.

      Returns:
      Returns an unmodifiable set containing the values of the "ssl-cert-nickname" property.

    • getSslCipherSuite

      SortedSet<String> getSslCipherSuite()
      Gets the "ssl-cipher-suite" property.

      Specifies the names of the SSL cipher suites that are allowed for use in SSL communication.

      Returns:
      Returns an unmodifiable set containing the values of the "ssl-cipher-suite" property.

    • getSslClientAuthPolicy

      HttpConnectionHandlerCfgDefn.SslClientAuthPolicy getSslClientAuthPolicy()
      Gets the "ssl-client-auth-policy" property.

      Specifies the policy that the HTTP Connection Handler should use regarding client SSL certificates. Clients can use the SASL EXTERNAL mechanism only if the policy is set to "optional" or "required".

      This is only applicable if clients are allowed to use SSL.

      Default value: optional

      Returns:
      Returns the value of the "ssl-client-auth-policy" property.

    • getSslProtocol

      SortedSet<String> getSslProtocol()
      Gets the "ssl-protocol" property.

      Specifies the names of the SSL protocols that are allowed for use in SSL communication.

      Returns:
      Returns an unmodifiable set containing the values of the "ssl-protocol" property.

    • getTrustManagerProvider

      SortedSet<String> getTrustManagerProvider()
      Gets the "trust-manager-provider" property.

      Specifies the name(s) of the trust manager(s) that should be used with the HTTP Connection Handler.

      Default value is undefined

      Returns:
      Returns an unmodifiable set containing the values of the "trust-manager-provider" property.

    • getTrustManagerProviderDns

      SortedSet<Dn> getTrustManagerProviderDns()
      Gets the "trust-manager-provider" property as a set of DNs.

      Specifies the name(s) of the trust manager(s) that should be used with the HTTP Connection Handler.

      Returns:
      Returns the DN values of the "trust-manager-provider" property.

    • isUseSsl

      boolean isUseSsl()
      Gets the "use-ssl" property.

      Indicates whether the HTTP Connection Handler should use SSL.

      If enabled, the HTTP Connection Handler will use SSL to encrypt communication with the clients.

      Default value: false

      Returns:
      Returns the value of the "use-ssl" property.

    • isUseTcpKeepAlive

      boolean isUseTcpKeepAlive()
      Gets the "use-tcp-keep-alive" property.

      Indicates whether the HTTP Connection Handler should use TCP keep-alive.

      If enabled, the SO_KEEPALIVE socket option is used to indicate that TCP keepalive messages should periodically be sent to the client to verify that the associated connection is still valid. This may also help prevent cases in which intermediate network hardware could silently drop an otherwise idle client connection, provided that the keepalive interval configured in the underlying operating system is smaller than the timeout enforced by the network hardware.

      Default value: true

      Returns:
      Returns the value of the "use-tcp-keep-alive" property.

    • isUseTcpNoDelay

      boolean isUseTcpNoDelay()
      Gets the "use-tcp-no-delay" property.

      Indicates whether the HTTP Connection Handler should use TCP no-delay.

      If enabled, the TCP_NODELAY socket option is used to ensure that response messages to the client are sent immediately rather than potentially waiting to determine whether additional response messages can be sent in the same packet. In most cases, using the TCP_NODELAY socket option provides better performance and lower response times, but disabling it may help for some cases in which the server sends a large number of entries to a client in response to a search request.

      Default value: true

      Returns:
      Returns the value of the "use-tcp-no-delay" property.