public final class LDAPConnectionHandler extends ConnectionHandler<org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg> implements org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg>, ServerShutdownListener, AlertGenerator
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.
|
Modifier and Type | Method and Description |
---|---|
boolean |
allowLDAPv2()
Indicates whether this connection handler should allow interaction with LDAPv2 clients.
|
boolean |
allowStartTLS()
Indicates whether this connection handler should allow the use of the StartTLS extended operation.
|
org.forgerock.opendj.config.server.ConfigChangeResult |
applyConfigurationChange(org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg config) |
void |
bind()
Operates in a loop, accepting new connections and ensuring that requests on those connections are handled
properly.
|
void |
close()
Closes this connection handler so that it will no longer accept new client connections.
|
Map<String,String> |
getAlerts()
Retrieves information about the set of alerts that this generator may produce.
|
String |
getClassName()
Retrieves the fully-qualified name of the Java class for this alert generator implementation.
|
Collection<ClientConnection> |
getClientConnections()
Retrieves the set of active client connections that have been established through this connection handler.
|
org.forgerock.opendj.ldap.Dn |
getComponentEntryDN()
Retrieves the DN of the configuration entry with which this alert generator is associated.
|
String |
getConnectionHandlerName()
Retrieves a name that may be used to refer to 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.
|
Collection<HostPort> |
getListeners()
Retrieves information about the listener(s) that will be used to accept client connections.
|
long |
getMaxBlockedWriteTimeLimit()
Retrieves the maximum length of time in milliseconds that attempts to write to LDAP client connections should be
allowed to block.
|
int |
getMaxRequestSize()
Retrieves the maximum ASN.1 element value length that will be allowed by this connection handler.
|
String |
getProtocol()
Retrieves the name of the protocol used to communicate with clients.
|
String |
getShutdownListenerName()
Retrieves the human-readable name for this shutdown listener.
|
SSLClientAuthPolicy |
getSSLClientAuthPolicy()
Retrieves the SSL client authentication policy for this connection handler.
|
LDAPStatistics |
getStatTracker()
Retrieves the set of statistics maintained by this connection handler.
|
void |
initializeConnectionHandler(ServerContext serverContext,
org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg config)
Initializes this connection handler provider based on the information in the provided connection handler
configuration.
|
boolean |
isConfigurationAcceptable(org.forgerock.opendj.server.config.server.ConnectionHandlerCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this connection handler.
|
boolean |
isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg config,
List<LocalizableMessage> unacceptableReasons) |
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.
|
getConnectionHandlerMonitor, getNumRequestHandlers, isAdminConnectionHandler, setAdminConnectionHandler, setConnectionHandlerMonitor, toString
public LDAPConnectionHandler()
public LDAPConnectionHandler(QueueingStrategy strategy, String friendlyName)
strategy
- Request handling strategy.friendlyName
- The name of of this connection handler, or null
if the name should be taken from the
configuration.public boolean allowLDAPv2()
true
if LDAPv2 is allowed, or false
if not.public boolean allowStartTLS()
true
if StartTLS is allowed, or false
if not.public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg config)
applyConfigurationChange
in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg>
public void close()
ConnectionHandler
close
in interface Closeable
close
in interface AutoCloseable
close
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg>
public Map<String,String> getAlerts()
getAlerts
in interface AlertGenerator
public String getClassName()
getClassName
in interface AlertGenerator
public Collection<ClientConnection> getClientConnections()
getClientConnections
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg>
public org.forgerock.opendj.ldap.Dn getComponentEntryDN()
getComponentEntryDN
in interface AlertGenerator
getComponentEntryDN
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg>
public String getConnectionHandlerName()
ConnectionHandler
getConnectionHandlerName
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg>
public Collection<String> getEnabledSSLCipherSuites()
ConnectionHandler
getEnabledSSLCipherSuites
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg>
public Collection<String> getEnabledSSLProtocols()
ConnectionHandler
getEnabledSSLProtocols
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg>
public Collection<HostPort> getListeners()
ConnectionHandler
getListeners
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg>
public long getMaxBlockedWriteTimeLimit()
public int getMaxRequestSize()
public String getProtocol()
ConnectionHandler
getProtocol
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg>
public String getShutdownListenerName()
ServerShutdownListener
getShutdownListenerName
in interface ServerShutdownListener
public SSLClientAuthPolicy getSSLClientAuthPolicy()
public LDAPStatistics getStatTracker()
public void initializeConnectionHandler(ServerContext serverContext, org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg config) throws org.forgerock.opendj.config.server.ConfigException, InitializationException
ConnectionHandler
initializeConnectionHandler
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg>
serverContext
- The server context.config
- The connection handler configuration that contains the information to use to initialize this
connection handler.org.forgerock.opendj.config.server.ConfigException
- If an unrecoverable problem arises in the process of performing the initialization as a result of the
server configuration.InitializationException
- If a problem occurs during initialization that is not related to the server configuration.public boolean isConfigurationAcceptable(org.forgerock.opendj.server.config.server.ConnectionHandlerCfg configuration, List<LocalizableMessage> unacceptableReasons)
ConnectionHandler
isConfigurationAcceptable
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg>
configuration
- 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.true
if the provided configuration is acceptable for this connection handler, or false
if
not.public boolean isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg config, List<LocalizableMessage> unacceptableReasons)
isConfigurationChangeAcceptable
in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg>
public void processServerShutdown(LocalizableMessage reason)
ServerShutdownListener
processServerShutdown
in interface ServerShutdownListener
reason
- The human-readable reason for the shutdown.public void bind() throws IOException
ConnectionHandler
bind
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg>
IOException
- If the ConnectionHandler
cannot be bound.public void toString(StringBuilder buffer)
toString
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdapConnectionHandlerCfg>
buffer
- The buffer to which the information should be appended.public boolean useSsl()
true
if this connection handler should use SSL to communicate with clients, or false
if
not.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.