public final class AdministrationConnector extends Object implements ConfigurationChangeListener<AdministrationConnectorCfg>
Constructor and Description |
---|
AdministrationConnector(ServerContext serverContext)
Creates an instance of the administration connector.
|
Modifier and Type | Method and Description |
---|---|
ConfigChangeResult |
applyConfigurationChange(AdministrationConnectorCfg configuration)
Applies the configuration changes to this change listener.
|
LDAPConnectionHandler |
getConnectionHandler()
Retrieves the connection handler linked to this administration connector.
|
void |
initializeAdministrationConnector(AdministrationConnectorCfg configuration)
Initializes this administration connector provider based on the information in the provided administration
connector configuration.
|
boolean |
isConfigurationChangeAcceptable(AdministrationConnectorCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable
to this change listener.
|
public AdministrationConnector(ServerContext serverContext)
serverContext
- The server context.public void initializeAdministrationConnector(AdministrationConnectorCfg configuration) throws ConfigException, InitializationException
configuration
- The connection handler configuration that contains the information to use to initialize this
connection handler.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 LDAPConnectionHandler getConnectionHandler()
public boolean isConfigurationChangeAcceptable(AdministrationConnectorCfg configuration, List<LocalizableMessage> unacceptableReasons)
ConfigurationChangeListener
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<AdministrationConnectorCfg>
configuration
- The new configuration containing the changes.unacceptableReasons
- A list that can be used to hold messages about why the
provided configuration is not acceptable.true
if the proposed change is acceptable,
or false
if it is not.public ConfigChangeResult applyConfigurationChange(AdministrationConnectorCfg configuration)
ConfigurationChangeListener
applyConfigurationChange
in interface ConfigurationChangeListener<AdministrationConnectorCfg>
configuration
- The new configuration containing the changes.Copyright 2010-2022 ForgeRock AS.