public final class LDIFConnectionHandler extends ConnectionHandler<org.forgerock.opendj.server.config.server.LdifConnectionHandlerCfg> implements Runnable, org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.LdifConnectionHandlerCfg>, AlertGenerator
Constructor and Description |
---|
LDIFConnectionHandler()
Creates a new instance of this connection handler.
|
Modifier and Type | Method and Description |
---|---|
org.forgerock.opendj.config.server.ConfigChangeResult |
applyConfigurationChange(org.forgerock.opendj.server.config.server.LdifConnectionHandlerCfg configuration) |
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.
|
LinkedHashMap<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<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.
|
void |
initializeConnectionHandler(ServerContext serverContext,
org.forgerock.opendj.server.config.server.LdifConnectionHandlerCfg configuration)
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.LdifConnectionHandlerCfg configuration,
List<LocalizableMessage> unacceptableReasons) |
void |
run() |
void |
toString(StringBuilder buffer)
Appends a string representation of this connection handler to the provided buffer.
|
getConnectionHandlerMonitor, getEnabledSSLCipherSuites, getEnabledSSLProtocols, getNumRequestHandlers, isAdminConnectionHandler, setAdminConnectionHandler, setConnectionHandlerMonitor, toString
public LDIFConnectionHandler()
initializeConnectionHandler
method.public void initializeConnectionHandler(ServerContext serverContext, org.forgerock.opendj.server.config.server.LdifConnectionHandlerCfg configuration)
ConnectionHandler
initializeConnectionHandler
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdifConnectionHandlerCfg>
serverContext
- The server context.configuration
- The connection handler configuration that contains the information to use to initialize this
connection handler.public void bind() throws IOException
ConnectionHandler
bind
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdifConnectionHandlerCfg>
IOException
- If the ConnectionHandler
cannot be bound.public void close()
ConnectionHandler
close
in interface Closeable
close
in interface AutoCloseable
close
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdifConnectionHandlerCfg>
public String getConnectionHandlerName()
ConnectionHandler
getConnectionHandlerName
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdifConnectionHandlerCfg>
public String getProtocol()
ConnectionHandler
getProtocol
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdifConnectionHandlerCfg>
public Collection<HostPort> getListeners()
ConnectionHandler
getListeners
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdifConnectionHandlerCfg>
public Collection<ClientConnection> getClientConnections()
ConnectionHandler
getClientConnections
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdifConnectionHandlerCfg>
public void toString(StringBuilder buffer)
ConnectionHandler
toString
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdifConnectionHandlerCfg>
buffer
- The buffer to which the information should be appended.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.LdifConnectionHandlerCfg>
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.LdifConnectionHandlerCfg configuration, List<LocalizableMessage> unacceptableReasons)
isConfigurationChangeAcceptable
in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.LdifConnectionHandlerCfg>
public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(org.forgerock.opendj.server.config.server.LdifConnectionHandlerCfg configuration)
applyConfigurationChange
in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.LdifConnectionHandlerCfg>
public org.forgerock.opendj.ldap.Dn getComponentEntryDN()
ConnectionHandler
getComponentEntryDN
in interface AlertGenerator
getComponentEntryDN
in class ConnectionHandler<org.forgerock.opendj.server.config.server.LdifConnectionHandlerCfg>
public String getClassName()
AlertGenerator
getClassName
in interface AlertGenerator
public LinkedHashMap<String,String> getAlerts()
AlertGenerator
getAlerts
in interface AlertGenerator
Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.