Package org.opends.server.config

Class AdministrationConnector

java.lang.Object
org.opends.server.config.AdministrationConnector
All Implemented Interfaces:
ConfigurationChangeListener<AdministrationConnectorCfg>
public final class AdministrationConnector extends Object implements ConfigurationChangeListener<AdministrationConnectorCfg>
This class is a wrapper on top of LDAPConnectionHandler to manage the administration connector, which is an LDAPConnectionHandler with specific (limited) configuration properties.

  • Constructor Details

    • AdministrationConnector

      public AdministrationConnector(ServerContext serverContext)
      Creates an instance of the administration connector.
      Parameters:
      serverContext - The server context.

  • Method Details

    • initializeAdministrationConnector

      public void initializeAdministrationConnector(AdministrationConnectorCfg configuration) throws InitializationException
      Initializes this administration connector provider based on the information in the provided administration connector configuration.
      Parameters:
      configuration - 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.

    • getConnectionHandler

      public LDAPConnectionHandler getConnectionHandler()
      Retrieves the connection handler linked to this administration connector.
      Returns:
      The connection handler linked to this administration connector.

    • isConfigurationChangeAcceptable

      public boolean isConfigurationChangeAcceptable(AdministrationConnectorCfg configuration, 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<AdministrationConnectorCfg>
      Parameters:
      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.
      Returns:
      Returns true if the proposed change is acceptable, or false if it is not.

    • applyConfigurationChange

      public ConfigChangeResult applyConfigurationChange(AdministrationConnectorCfg configuration)
      Description copied from interface: ConfigurationChangeListener
      Applies the configuration changes to this change listener.
      Specified by:
      applyConfigurationChange in interface ConfigurationChangeListener<AdministrationConnectorCfg>
      Parameters:
      configuration - The new configuration containing the changes.
      Returns:
      Returns information about the result of changing the configuration.