org.opends.server.protocols.ldap

Class LDAPConnectionHandler

java.lang.Object

org.opends.server.api.ConnectionHandler<LdapConnectionHandlerCfg>

org.opends.server.protocols.ldap.LDAPConnectionHandler

All Implemented Interfaces:

Closeable, AutoCloseable, ConfigurationChangeListener<LdapConnectionHandlerCfg>, AlertGenerator, ServerShutdownListener, HealthStatusProvider

public final class LDAPConnectionHandler
extends ConnectionHandler<LdapConnectionHandlerCfg>
implements ConfigurationChangeListener<LdapConnectionHandlerCfg>, ServerShutdownListener, AlertGenerator

This class defines a connection handler that will be used for communicating with clients over LDAP. It is actually implemented in two parts: as a connection handler and one or more request handlers. The connection handler is responsible for accepting new connections and registering each of them with a request handler. The request handlers then are responsible for reading requests from the clients and parsing them as operations. A single request handler may be used, but having multiple handlers might provide better performance in a multi-CPU system.

Constructor Summary

Constructors

Constructor and Description
LDAPConnectionHandler() Creates a new instance of this LDAP connection handler.
LDAPConnectionHandler(QueueingStrategy strategy, String friendlyName) Creates a new instance of this LDAP connection handler, using a queueing strategy.

Method Summary

Modifier and Type	Method and Description
protected void	addAdditionalMeters(MeterRegistryHolder registry) Computes additional meters that is specific to the connection handler implementation.
protected void	addAdditionalMonitorObjectClassNames(Attribute ocAttr) Adds the object class names that should be included in the monitor entry related to this connection handler to the provided attribute.
ConfigChangeResult	applyConfigurationChange(LdapConnectionHandlerCfg config) Applies the configuration changes to this change listener.
void	bind() Operates in a loop, accepting new connections and ensuring that requests on those connections are handled properly.
void	doClose() Closes this connection handler so that it will no longer accept new client connections.
void	doInitializeConnectionHandler(ServerContext serverContext, LdapConnectionHandlerCfg config) Initializes this connection handler provider based on the information in the provided connection handler configuration.
Map<String,String>	getAlerts() Retrieves information about the set of alerts that this generator may produce.
Collection<ClientConnection>	getClientConnections() Retrieves the set of active client connections that have been established through this connection handler.
Dn	getComponentEntryDN() Retrieves the DN of the configuration entry with which this alert generator is associated.
String	getConfigurationName() Returns the name used for identifying this LDAP connection handler in the server configuration.
String	getConnectionHandlerName() Retrieves a name that may be used to refer to this connection handler.
String	getConnectionHandlerType() Returns the type of this connection handler.
Collection<String>	getEnabledSSLCipherSuites() Retrieves an unmodifiable set of enabled SSL cipher suites configured for this connection handler, if applicable.
Collection<String>	getEnabledSSLProtocols() Retrieves the set of enabled SSL protocols configured for this connection handler.
HealthStatus	getHealthStatus() Returns the Ldap connection handler's health status based on the listen addresses.
Collection<HostPort>	getListeners() Retrieves information about the listener(s) that will be used to accept client connections.
String	getProtocol() Retrieves the name of the protocol used to communicate with clients.
LdapStatistics	getStatTracker() Retrieves the set of statistics maintained by this connection handler.
boolean	isConfigurationAcceptable(LdapConnectionHandlerCfg config, List<LocalizableMessage> unacceptableReasons) Indicates whether the provided configuration is acceptable for this connection handler.
boolean	isConfigurationChangeAcceptable(LdapConnectionHandlerCfg config, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed change to the configuration is acceptable to this change listener.
void	processServerShutdown(LocalizableMessage reason) Indicates that the Directory Server has received a request to stop running and that this shutdown listener should take any action necessary to prepare for it.
void	toString(StringBuilder buffer) Appends a string representation of this connection handler to the provided buffer.
boolean	useSsl() Indicates whether this connection handler should use SSL to communicate with clients.

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

close, getNumRequestHandlers, initializeConnectionHandler, setAdminConnectionHandler, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opends.server.api.AlertGenerator

getClassName

Constructor Detail

LDAPConnectionHandler

public LDAPConnectionHandler()

Creates a new instance of this LDAP connection handler. It must be initialized before it may be used.

LDAPConnectionHandler

public LDAPConnectionHandler(QueueingStrategy strategy,
                             String friendlyName)

Creates a new instance of this LDAP connection handler, using a queueing strategy. It must be initialized before it may be used.

Parameters:

strategy - Request handling strategy.

friendlyName - The name of of this connection handler, or null if the name should be taken from the configuration.

Method Detail

applyConfigurationChange

public ConfigChangeResult applyConfigurationChange(LdapConnectionHandlerCfg config)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<LdapConnectionHandlerCfg>

Parameters:

config - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

doClose

public void doClose()

Description copied from class: ConnectionHandler

Closes this connection handler so that it will no longer accept new client connections. Implementations should disconnect any existing connections and release any other resources associated with the connection handler.

Overrides:

doClose in class ConnectionHandler<LdapConnectionHandlerCfg>

getAlerts

public Map<String,String> getAlerts()

Description copied from interface: AlertGenerator

Retrieves information about the set of alerts that this generator may produce. The map returned should be between the notification type for a particular notification and the human-readable description for that notification. This alert generator must not generate any alerts with types that are not contained in this list.

Specified by:

getAlerts in interface AlertGenerator

Returns:

Information about the set of alerts that this generator may produce.

getClientConnections

public Collection<ClientConnection> getClientConnections()

Description copied from class: ConnectionHandler

Retrieves the set of active client connections that have been established through this connection handler.

Specified by:

getClientConnections in class ConnectionHandler<LdapConnectionHandlerCfg>

Returns:

The set of active client connections that have been established through this connection handler.

getComponentEntryDN

public Dn getComponentEntryDN()

Description copied from class: ConnectionHandler

Retrieves the DN of the configuration entry with which this alert generator is associated.

Specified by:

getComponentEntryDN in interface AlertGenerator

Specified by:

getComponentEntryDN in class ConnectionHandler<LdapConnectionHandlerCfg>

Returns:

The DN of the configuration entry with which this alert generator is associated.

getConnectionHandlerName

public String getConnectionHandlerName()

Description copied from class: ConnectionHandler

Retrieves a name that may be used to refer to this connection handler. Every connection handler instance (even handlers of the same type) must have a unique name.

Specified by:

getConnectionHandlerName in class ConnectionHandler<LdapConnectionHandlerCfg>

Returns:

A unique name that may be used to refer to this connection handler.

getConnectionHandlerType

public String getConnectionHandlerType()

Description copied from class: ConnectionHandler

Returns the type of this connection handler. By default this returns ConnectionHandler.getProtocol(). It should be returning the insecure protocol version.

Overrides:

getConnectionHandlerType in class ConnectionHandler<LdapConnectionHandlerCfg>

Returns:

The type of this connection handler.

getConfigurationName

public String getConfigurationName()

Returns the name used for identifying this LDAP connection handler in the server configuration.

The configuration name does not contain IP addressed neither port number. getConnectionHandlerName() can be use to have such information amended to the configuration name.

Returns:

A String representing the name used for identifying this LDAPConnectionHandler in the server configuration.

See Also:

getConnectionHandlerName()

getEnabledSSLCipherSuites

public Collection<String> getEnabledSSLCipherSuites()

Description copied from class: ConnectionHandler

Retrieves an unmodifiable set of enabled SSL cipher suites configured for this connection handler, if applicable. Implementations must return an empty set if use of SSL/TLS is not possible.

Overrides:

getEnabledSSLCipherSuites in class ConnectionHandler<LdapConnectionHandlerCfg>

Returns:

The set of enabled SSL cipher suites configured for this connection handler.

getEnabledSSLProtocols

public Collection<String> getEnabledSSLProtocols()

Description copied from class: ConnectionHandler

Retrieves the set of enabled SSL protocols configured for this connection handler. Implementations must return an empty set if use of SSL/TLS is not possible.

Overrides:

getEnabledSSLProtocols in class ConnectionHandler<LdapConnectionHandlerCfg>

Returns:

The set of enabled SSL protocols configured for this connection handler.

getListeners

public Collection<HostPort> getListeners()

Description copied from class: ConnectionHandler

Retrieves information about the listener(s) that will be used to accept client connections.

Specified by:

getListeners in class ConnectionHandler<LdapConnectionHandlerCfg>

Returns:

Information about the listener(s) that will be used to accept client connections, or an empty list if this connection handler does not accept connections from network clients.

getProtocol

public String getProtocol()

Description copied from class: ConnectionHandler

Retrieves the name of the protocol used to communicate with clients. It should take into account any special naming that may be needed to express any security mechanisms or other constraints in place (e.g., "LDAPS" for LDAP over SSL).

Specified by:

getProtocol in class ConnectionHandler<LdapConnectionHandlerCfg>

Returns:

The name of the protocol used to communicate with clients.

getStatTracker

public LdapStatistics getStatTracker()

Retrieves the set of statistics maintained by this connection handler.

Returns:

The set of statistics maintained by this connection handler.

addAdditionalMeters

protected void addAdditionalMeters(MeterRegistryHolder registry)

Description copied from class: ConnectionHandler

Computes additional meters that is specific to the connection handler implementation. The default implementation is to do nothing.

Overrides:

addAdditionalMeters in class ConnectionHandler<LdapConnectionHandlerCfg>

Parameters:

registry - where additional meters should be added.

addAdditionalMonitorObjectClassNames

protected void addAdditionalMonitorObjectClassNames(Attribute ocAttr)

Description copied from class: ConnectionHandler

Adds the object class names that should be included in the monitor entry related to this connection handler to the provided attribute.

Overrides:

addAdditionalMonitorObjectClassNames in class ConnectionHandler<LdapConnectionHandlerCfg>

Parameters:

ocAttr - The object class attribute on which the object class names are added.

doInitializeConnectionHandler

public void doInitializeConnectionHandler(ServerContext serverContext,
                                          LdapConnectionHandlerCfg config)
                                   throws InitializationException

Description copied from class: ConnectionHandler

Initializes this connection handler provider based on the information in the provided connection handler configuration.

Specified by:

doInitializeConnectionHandler in class ConnectionHandler<LdapConnectionHandlerCfg>

Parameters:

serverContext - The server context.

config - The connection handler configuration that contains the information to use to initialize this connection handler.

Throws:

InitializationException - If a problem occurs during initialization that is not related to the server configuration.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(LdapConnectionHandlerCfg config,
                                         List<LocalizableMessage> unacceptableReasons)

Description copied from class: ConnectionHandler

Indicates whether the provided configuration is acceptable for this connection handler. It should be possible to call this method on an uninitialized connection handler instance in order to determine whether the connection handler would be able to use the provided configuration.

Overrides:

isConfigurationAcceptable in class ConnectionHandler<LdapConnectionHandlerCfg>

Parameters:

config - The connection handler configuration for which to make the determination.

unacceptableReasons - A list that may be used to hold the reasons that the provided configuration is not acceptable.

Returns:

true if the provided configuration is acceptable for this connection handler, or false if not.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(LdapConnectionHandlerCfg config,
                                               List<LocalizableMessage> unacceptableReasons)

Description copied from interface: ConfigurationChangeListener

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<LdapConnectionHandlerCfg>

Parameters:

config - The new configuration containing the changes.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed change is acceptable, or false if it is not.

processServerShutdown

public void processServerShutdown(LocalizableMessage reason)

Description copied from interface: ServerShutdownListener

Indicates that the Directory Server has received a request to stop running and that this shutdown listener should take any action necessary to prepare for it.

Specified by:

processServerShutdown in interface ServerShutdownListener

Parameters:

reason - The human-readable reason for the shutdown.

bind

public void bind()
          throws IOException

Description copied from class: ConnectionHandler

Operates in a loop, accepting new connections and ensuring that requests on those connections are handled properly.

Specified by:

bind in class ConnectionHandler<LdapConnectionHandlerCfg>

Throws:

IOException - If the ConnectionHandler cannot be bound.

getHealthStatus

public HealthStatus getHealthStatus()

Returns the Ldap connection handler's health status based on the listen addresses. This method returns ALIVE and HEALTHY if the connection handler has at least one listen address and has no unresolved host names, NOT ALIVE otherwise.

Specified by:

getHealthStatus in interface HealthStatusProvider

Overrides:

getHealthStatus in class ConnectionHandler<LdapConnectionHandlerCfg>

Returns:

The Ldap connection handler's health status.

toString

public void toString(StringBuilder buffer)

Description copied from class: ConnectionHandler

Appends a string representation of this connection handler to the provided buffer.

Specified by:

toString in class ConnectionHandler<LdapConnectionHandlerCfg>

Parameters:

buffer - The buffer to which the information should be appended.

useSsl

public boolean useSsl()

Indicates whether this connection handler should use SSL to communicate with clients.

Returns:

true if this connection handler should use SSL to communicate with clients, or false if not.