LDAPConnectionHandlerCfgClient (OpenDJ 3.0.0 Documentation)

All Superinterfaces:

ConfigurationClient, ConnectionHandlerCfgClient
```
public interface LDAPConnectionHandlerCfgClient
extends ConnectionHandlerCfgClient
```
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 Summary

Methods
Modifier and Type	Method and Description
`ManagedObjectDefinition<? extends LDAPConnectionHandlerCfgClient,? extends LDAPConnectionHandlerCfg>`	`definition()` Get the configuration definition associated with this LDAP Connection Handler.
`int`	`getAcceptBacklog()` Gets the "accept-backlog" property.
`long`	`getBufferSize()` Gets the "buffer-size" property.
`String`	`getJavaClass()` Gets the "java-class" property.
`String`	`getKeyManagerProvider()` Gets the "key-manager-provider" property.
`SortedSet<InetAddress>`	`getListenAddress()` Gets the "listen-address" property.
`Integer`	`getListenPort()` Gets the "listen-port" property.
`long`	`getMaxBlockedWriteTimeLimit()` Gets the "max-blocked-write-time-limit" property.
`long`	`getMaxRequestSize()` Gets the "max-request-size" property.
`Integer`	`getNumRequestHandlers()` Gets the "num-request-handlers" property.
`SortedSet<String>`	`getSSLCertNickname()` Gets the "ssl-cert-nickname" property.
`SortedSet<String>`	`getSSLCipherSuite()` Gets the "ssl-cipher-suite" property.
`LDAPConnectionHandlerCfgDefn.SSLClientAuthPolicy`	`getSSLClientAuthPolicy()` Gets the "ssl-client-auth-policy" property.
`SortedSet<String>`	`getSSLProtocol()` Gets the "ssl-protocol" property.
`String`	`getTrustManagerProvider()` Gets the "trust-manager-provider" property.
`boolean`	`isAllowLDAPV2()` Gets the "allow-ldap-v2" property.
`boolean`	`isAllowStartTLS()` Gets the "allow-start-tls" property.
`boolean`	`isAllowTCPReuseAddress()` Gets the "allow-tcp-reuse-address" property.
`boolean`	`isKeepStats()` Gets the "keep-stats" property.
`boolean`	`isSendRejectionNotice()` Gets the "send-rejection-notice" property.
`boolean`	`isUseSSL()` Gets the "use-ssl" property.
`boolean`	`isUseTCPKeepAlive()` Gets the "use-tcp-keep-alive" property.
`boolean`	`isUseTCPNoDelay()` Gets the "use-tcp-no-delay" property.
`void`	`setAcceptBacklog(Integer value)` Sets the "accept-backlog" property.
`void`	`setAllowLDAPV2(Boolean value)` Sets the "allow-ldap-v2" property.
`void`	`setAllowStartTLS(Boolean value)` Sets the "allow-start-tls" property.
`void`	`setAllowTCPReuseAddress(Boolean value)` Sets the "allow-tcp-reuse-address" property.
`void`	`setBufferSize(Long value)` Sets the "buffer-size" property.
`void`	`setJavaClass(String value)` Sets the "java-class" property.
`void`	`setKeepStats(Boolean value)` Sets the "keep-stats" property.
`void`	`setKeyManagerProvider(String value)` Sets the "key-manager-provider" property.
`void`	`setListenAddress(Collection<InetAddress> values)` Sets the "listen-address" property.
`void`	`setListenPort(int value)` Sets the "listen-port" property.
`void`	`setMaxBlockedWriteTimeLimit(Long value)` Sets the "max-blocked-write-time-limit" property.
`void`	`setMaxRequestSize(Long value)` Sets the "max-request-size" property.
`void`	`setNumRequestHandlers(Integer value)` Sets the "num-request-handlers" property.
`void`	`setSendRejectionNotice(Boolean value)` Sets the "send-rejection-notice" property.
`void`	`setSSLCertNickname(Collection<String> values)` Sets the "ssl-cert-nickname" property.
`void`	`setSSLCipherSuite(Collection<String> values)` Sets the "ssl-cipher-suite" property.
`void`	`setSSLClientAuthPolicy(LDAPConnectionHandlerCfgDefn.SSLClientAuthPolicy value)` Sets the "ssl-client-auth-policy" property.
`void`	`setSSLProtocol(Collection<String> values)` Sets the "ssl-protocol" property.
`void`	`setTrustManagerProvider(String value)` Sets the "trust-manager-provider" property.
`void`	`setUseSSL(Boolean value)` Sets the "use-ssl" property.
`void`	`setUseTCPKeepAlive(Boolean value)` Sets the "use-tcp-keep-alive" property.
`void`	`setUseTCPNoDelay(Boolean value)` Sets the "use-tcp-no-delay" property.

Methods inherited from interface org.opends.server.admin.std.client.ConnectionHandlerCfgClient
getAllowedClient, getDeniedClient, isEnabled, setAllowedClient, setDeniedClient, setEnabled

Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties

- Method Detail
  - 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
    
    Returns:
    Returns the configuration definition associated with this LDAP Connection Handler.
  - 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.
    
    Returns:
    Returns the value of the "accept-backlog" property.
  - setAcceptBacklog
```
void setAcceptBacklog(Integer value)
                      throws PropertyException
```
    Sets 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.
    
    Parameters:
    value - The value of the "accept-backlog" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - isAllowLDAPV2
```
boolean isAllowLDAPV2()
```
    Gets the "allow-ldap-v2" property.
    Indicates whether connections from LDAPv2 clients are allowed.
    If LDAPv2 clients are allowed, then only a minimal degree of special support are provided for them to ensure that LDAPv3-specific protocol elements (for example, Configuration Guide 25 controls, extended response messages, intermediate response messages, referrals) are not sent to an LDAPv2 client.
    
    Returns:
    Returns the value of the "allow-ldap-v2" property.
  - setAllowLDAPV2
```
void setAllowLDAPV2(Boolean value)
                    throws PropertyException
```
    Sets the "allow-ldap-v2" property.
    Indicates whether connections from LDAPv2 clients are allowed.
    If LDAPv2 clients are allowed, then only a minimal degree of special support are provided for them to ensure that LDAPv3-specific protocol elements (for example, Configuration Guide 25 controls, extended response messages, intermediate response messages, referrals) are not sent to an LDAPv2 client.
    
    Parameters:
    value - The value of the "allow-ldap-v2" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - isAllowStartTLS
```
boolean isAllowStartTLS()
```
    Gets the "allow-start-tls" property.
    Indicates whether clients are allowed to use StartTLS.
    If enabled, the LDAP Connection Handler allows clients to use the StartTLS extended operation to initiate secure communication over an otherwise insecure channel. Note that this is only allowed if the LDAP Connection Handler is not configured to use SSL, and if the server is configured with a valid key manager provider and a valid trust manager provider.
    
    Returns:
    Returns the value of the "allow-start-tls" property.
  - setAllowStartTLS
```
void setAllowStartTLS(Boolean value)
                      throws PropertyException
```
    Sets the "allow-start-tls" property.
    Indicates whether clients are allowed to use StartTLS.
    If enabled, the LDAP Connection Handler allows clients to use the StartTLS extended operation to initiate secure communication over an otherwise insecure channel. Note that this is only allowed if the LDAP Connection Handler is not configured to use SSL, and if the server is configured with a valid key manager provider and a valid trust manager provider.
    
    Parameters:
    value - The value of the "allow-start-tls" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - isAllowTCPReuseAddress
```
boolean isAllowTCPReuseAddress()
```
    Gets the "allow-tcp-reuse-address" property.
    Indicates whether the LDAP 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.
    
    Returns:
    Returns the value of the "allow-tcp-reuse-address" property.
  - setAllowTCPReuseAddress
```
void setAllowTCPReuseAddress(Boolean value)
                             throws PropertyException
```
    Sets the "allow-tcp-reuse-address" property.
    Indicates whether the LDAP 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.
    
    Parameters:
    value - The value of the "allow-tcp-reuse-address" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - getBufferSize
```
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.
    
    Returns:
    Returns the value of the "buffer-size" property.
  - setBufferSize
```
void setBufferSize(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
```
String getJavaClass()
```
    Gets the "java-class" property.
    Specifies the fully-qualified name of the Java class that provides the LDAP Connection Handler implementation.
    
    Specified by:
    
    getJavaClass in interface ConnectionHandlerCfgClient
    
    Returns:
    Returns the value of the "java-class" property.
  - setJavaClass
```
void setJavaClass(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
    
    Parameters:
    value - The value of the "java-class" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - isKeepStats
```
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.
    
    Returns:
    Returns the value of the "keep-stats" property.
  - setKeepStats
```
void setKeepStats(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.
  - getKeyManagerProvider
```
String getKeyManagerProvider()
```
    Gets the "key-manager-provider" property.
    Specifies the name of the key manager that should be used with this LDAP Connection Handler .
    
    Returns:
    Returns the value of the "key-manager-provider" property.
  - setKeyManagerProvider
```
void setKeyManagerProvider(String value)
                           throws PropertyException
```
    Sets the "key-manager-provider" property.
    Specifies the name of the key manager that should be used with this LDAP Connection Handler .
    
    Parameters:
    value - The value of the "key-manager-provider" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - getListenAddress
```
SortedSet<InetAddress> getListenAddress()
```
    Gets the "listen-address" property.
    Specifies the address or set of addresses on which this LDAP Connection Handler should listen for connections from LDAP clients.
    Multiple addresses may be provided as separate values for this attribute. If no values are provided, then the LDAP Connection Handler listens on all interfaces.
    
    Returns:
    Returns the values of the "listen-address" property.
  - setListenAddress
```
void setListenAddress(Collection<InetAddress> values)
                      throws PropertyException
```
    Sets the "listen-address" property.
    Specifies the address or set of addresses on which this LDAP Connection Handler should listen for connections from LDAP clients.
    Multiple addresses may be provided as separate values for this attribute. If no values are provided, then the LDAP Connection Handler listens on all interfaces.
    
    Parameters:
    values - The values of the "listen-address" property.
    
    Throws:
    
    PropertyException - If one or more of the new values are invalid.
  - getListenPort
```
Integer getListenPort()
```
    Gets the "listen-port" property.
    Specifies the port number on which the LDAP 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.
  - setListenPort
```
void setListenPort(int value)
                   throws PropertyException
```
    Sets the "listen-port" property.
    Specifies the port number on which the LDAP Connection Handler will listen for connections from clients.
    Only a single port number may be provided.
    
    Parameters:
    value - The value of the "listen-port" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - getMaxBlockedWriteTimeLimit
```
long getMaxBlockedWriteTimeLimit()
```
    Gets the "max-blocked-write-time-limit" property.
    Specifies the maximum length of time that attempts to write data to LDAP 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.
    
    Returns:
    Returns the value of the "max-blocked-write-time-limit" property.
  - setMaxBlockedWriteTimeLimit
```
void setMaxBlockedWriteTimeLimit(Long value)
                                 throws PropertyException
```
    Sets the "max-blocked-write-time-limit" property.
    Specifies the maximum length of time that attempts to write data to LDAP 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.
    
    Parameters:
    value - The value of the "max-blocked-write-time-limit" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - getMaxRequestSize
```
long getMaxRequestSize()
```
    Gets the "max-request-size" property.
    Specifies the size in bytes of the largest LDAP request message that will be allowed by this LDAP Connection handler.
    This property is analogous to the maxBERSize configuration attribute of the Sun Java System Directory Server. 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.
    
    Returns:
    Returns the value of the "max-request-size" property.
  - setMaxRequestSize
```
void setMaxRequestSize(Long value)
                       throws PropertyException
```
    Sets the "max-request-size" property.
    Specifies the size in bytes of the largest LDAP request message that will be allowed by this LDAP Connection handler.
    This property is analogous to the maxBERSize configuration attribute of the Sun Java System Directory Server. 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.
    
    Parameters:
    value - The value of the "max-request-size" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - getNumRequestHandlers
```
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(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.
  - isSendRejectionNotice
```
boolean isSendRejectionNotice()
```
    Gets the "send-rejection-notice" property.
    Indicates whether the LDAP Connection Handler should send a notice of disconnection extended response message to the client if a new connection is rejected for some reason.
    The extended response message may provide an explanation indicating the reason that the connection was rejected.
    
    Returns:
    Returns the value of the "send-rejection-notice" property.
  - setSendRejectionNotice
```
void setSendRejectionNotice(Boolean value)
                            throws PropertyException
```
    Sets the "send-rejection-notice" property.
    Indicates whether the LDAP Connection Handler should send a notice of disconnection extended response message to the client if a new connection is rejected for some reason.
    The extended response message may provide an explanation indicating the reason that the connection was rejected.
    
    Parameters:
    value - The value of the "send-rejection-notice" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - getSSLCertNickname
```
SortedSet<String> getSSLCertNickname()
```
    Gets the "ssl-cert-nickname" property.
    Specifies the nicknames (also called the aliases) of the certificates that the LDAP Connection Handler should use when performing SSL communication. The property can be used multiple times (referencing different nicknames) when an RSA, a DSA, and an ECC based server certificate is used in parallel.
    This is only applicable when the LDAP Connection Handler is configured to use SSL.
    
    Returns:
    Returns the values of the "ssl-cert-nickname" property.
  - setSSLCertNickname
```
void setSSLCertNickname(Collection<String> values)
                        throws PropertyException
```
    Sets the "ssl-cert-nickname" property.
    Specifies the nicknames (also called the aliases) of the certificates that the LDAP Connection Handler should use when performing SSL communication. The property can be used multiple times (referencing different nicknames) when an RSA, a DSA, and an ECC based server certificate is used in parallel.
    This is only applicable when the LDAP Connection Handler is configured to use SSL.
    
    Parameters:
    values - The values of the "ssl-cert-nickname" property.
    
    Throws:
    
    PropertyException - If one or more of the new values are invalid.
  - 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 or StartTLS communication.
    
    Returns:
    Returns the values of the "ssl-cipher-suite" property.
  - setSSLCipherSuite
```
void setSSLCipherSuite(Collection<String> values)
                       throws PropertyException
```
    Sets the "ssl-cipher-suite" property.
    Specifies the names of the SSL cipher suites that are allowed for use in SSL or StartTLS communication.
    
    Parameters:
    values - The values of the "ssl-cipher-suite" property.
    
    Throws:
    
    PropertyException - If one or more of the new values are invalid.
  - getSSLClientAuthPolicy
```
LDAPConnectionHandlerCfgDefn.SSLClientAuthPolicy getSSLClientAuthPolicy()
```
    Gets the "ssl-client-auth-policy" property.
    Specifies the policy that the LDAP 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.
    
    Returns:
    Returns the value of the "ssl-client-auth-policy" property.
  - setSSLClientAuthPolicy
```
void setSSLClientAuthPolicy(LDAPConnectionHandlerCfgDefn.SSLClientAuthPolicy value)
                            throws PropertyException
```
    Sets the "ssl-client-auth-policy" property.
    Specifies the policy that the LDAP 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.
    
    Parameters:
    value - The value of the "ssl-client-auth-policy" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - getSSLProtocol
```
SortedSet<String> getSSLProtocol()
```
    Gets the "ssl-protocol" property.
    Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication.
    
    Returns:
    Returns the values of the "ssl-protocol" property.
  - setSSLProtocol
```
void setSSLProtocol(Collection<String> values)
                    throws PropertyException
```
    Sets the "ssl-protocol" property.
    Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication.
    
    Parameters:
    values - The values of the "ssl-protocol" property.
    
    Throws:
    
    PropertyException - If one or more of the new values are invalid.
  - getTrustManagerProvider
```
String getTrustManagerProvider()
```
    Gets the "trust-manager-provider" property.
    Specifies the name of the trust manager that should be used with the LDAP Connection Handler .
    
    Returns:
    Returns the value of the "trust-manager-provider" property.
  - setTrustManagerProvider
```
void setTrustManagerProvider(String value)
                             throws PropertyException
```
    Sets the "trust-manager-provider" property.
    Specifies the name of the trust manager that should be used with the LDAP Connection Handler .
    
    Parameters:
    value - The value of the "trust-manager-provider" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - isUseSSL
```
boolean isUseSSL()
```
    Gets the "use-ssl" property.
    Indicates whether the LDAP Connection Handler should use SSL.
    If enabled, the LDAP Connection Handler will use SSL to encrypt communication with the clients.
    
    Returns:
    Returns the value of the "use-ssl" property.
  - setUseSSL
```
void setUseSSL(Boolean value)
               throws PropertyException
```
    Sets the "use-ssl" property.
    Indicates whether the LDAP Connection Handler should use SSL.
    If enabled, the LDAP Connection Handler will use SSL to encrypt communication with the clients.
    
    Parameters:
    value - The value of the "use-ssl" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - isUseTCPKeepAlive
```
boolean isUseTCPKeepAlive()
```
    Gets the "use-tcp-keep-alive" property.
    Indicates whether the LDAP 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.
    
    Returns:
    Returns the value of the "use-tcp-keep-alive" property.
  - setUseTCPKeepAlive
```
void setUseTCPKeepAlive(Boolean value)
                        throws PropertyException
```
    Sets the "use-tcp-keep-alive" property.
    Indicates whether the LDAP 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.
    
    Parameters:
    value - The value of the "use-tcp-keep-alive" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - isUseTCPNoDelay
```
boolean isUseTCPNoDelay()
```
    Gets the "use-tcp-no-delay" property.
    Indicates whether the LDAP 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.
    
    Returns:
    Returns the value of the "use-tcp-no-delay" property.
  - setUseTCPNoDelay
```
void setUseTCPNoDelay(Boolean value)
                      throws PropertyException
```
    Sets the "use-tcp-no-delay" property.
    Indicates whether the LDAP 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.
    
    Parameters:
    value - The value of the "use-tcp-no-delay" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.

Interface LDAPConnectionHandlerCfgClient

Method Summary

Methods inherited from interface org.opends.server.admin.std.client.ConnectionHandlerCfgClient

Methods inherited from interface org.opends.server.admin.ConfigurationClient

Method Detail

definition

getAcceptBacklog

setAcceptBacklog

isAllowLDAPV2

setAllowLDAPV2

isAllowStartTLS

setAllowStartTLS

isAllowTCPReuseAddress

setAllowTCPReuseAddress

getBufferSize

setBufferSize

getJavaClass

setJavaClass

isKeepStats

setKeepStats

getKeyManagerProvider

setKeyManagerProvider

getListenAddress

setListenAddress

getListenPort

setListenPort

getMaxBlockedWriteTimeLimit

setMaxBlockedWriteTimeLimit

getMaxRequestSize

setMaxRequestSize

getNumRequestHandlers

setNumRequestHandlers

isSendRejectionNotice

setSendRejectionNotice

getSSLCertNickname

setSSLCertNickname

getSSLCipherSuite

setSSLCipherSuite

getSSLClientAuthPolicy

setSSLClientAuthPolicy

getSSLProtocol

setSSLProtocol

getTrustManagerProvider

setTrustManagerProvider

isUseSSL

setUseSSL

isUseTCPKeepAlive

setUseTCPKeepAlive

isUseTCPNoDelay

setUseTCPNoDelay