org.opends.server.core
Class IdentityMapperConfigManager

java.lang.Object
  extended by org.opends.server.core.IdentityMapperConfigManager
All Implemented Interfaces:
ConfigurationAddListener<IdentityMapperCfg>, ConfigurationChangeListener<IdentityMapperCfg>, ConfigurationDeleteListener<IdentityMapperCfg>

public class IdentityMapperConfigManager
extends java.lang.Object
implements ConfigurationChangeListener<IdentityMapperCfg>, ConfigurationAddListener<IdentityMapperCfg>, ConfigurationDeleteListener<IdentityMapperCfg>

This class defines a utility that will be used to manage the set of identity mappers defined in the Directory Server. It will initialize the identity mappers when the server starts, and then will manage any additions, removals, or modifications to any identity mappers while the server is running.


Constructor Summary
IdentityMapperConfigManager()
          Creates a new instance of this identity mapper config manager.
 
Method Summary
 ConfigChangeResult applyConfigurationAdd(IdentityMapperCfg configuration)
          Adds a new configuration to this add listener.
 ConfigChangeResult applyConfigurationChange(IdentityMapperCfg configuration)
          Applies the configuration changes to this change listener.
 ConfigChangeResult applyConfigurationDelete(IdentityMapperCfg configuration)
          Deletes an existing configuration from this delete listener.
 void initializeIdentityMappers()
          Initializes all identity mappers currently defined in the Directory Server configuration.
 boolean isConfigurationAddAcceptable(IdentityMapperCfg configuration, java.util.List<Message> unacceptableReasons)
          Indicates whether the proposed addition of a new configuration is acceptable to this add listener.
 boolean isConfigurationChangeAcceptable(IdentityMapperCfg configuration, java.util.List<Message> unacceptableReasons)
          Indicates whether the proposed change to the configuration is acceptable to this change listener.
 boolean isConfigurationDeleteAcceptable(IdentityMapperCfg configuration, java.util.List<Message> unacceptableReasons)
          Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IdentityMapperConfigManager

public IdentityMapperConfigManager()
Creates a new instance of this identity mapper config manager.

Method Detail

initializeIdentityMappers

public void initializeIdentityMappers()
                               throws ConfigException,
                                      InitializationException
Initializes all identity mappers currently defined in the Directory Server configuration. This should only be called at Directory Server startup.

Throws:
ConfigException - If a configuration problem causes the identity mapper initialization process to fail.
InitializationException - If a problem occurs while initializing the identity mappers that is not related to the server configuration.

isConfigurationAddAcceptable

public boolean isConfigurationAddAcceptable(IdentityMapperCfg configuration,
                                            java.util.List<Message> unacceptableReasons)
Indicates whether the proposed addition of a new configuration is acceptable to this add listener.

Specified by:
isConfigurationAddAcceptable in interface ConfigurationAddListener<IdentityMapperCfg>
Parameters:
configuration - The configuration that will be added.
unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.
Returns:
Returns true if the proposed addition is acceptable, or false if it is not.

applyConfigurationAdd

public ConfigChangeResult applyConfigurationAdd(IdentityMapperCfg configuration)
Adds a new configuration to this add listener.

Specified by:
applyConfigurationAdd in interface ConfigurationAddListener<IdentityMapperCfg>
Parameters:
configuration - The configuration that will be added.
Returns:
Returns information about the result of adding the configuration.

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(IdentityMapperCfg configuration,
                                               java.util.List<Message> unacceptableReasons)
Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener.

Specified by:
isConfigurationDeleteAcceptable in interface ConfigurationDeleteListener<IdentityMapperCfg>
Parameters:
configuration - The configuration that will be deleted.
unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.
Returns:
Returns true if the proposed deletion is acceptable, or false if it is not.

applyConfigurationDelete

public ConfigChangeResult applyConfigurationDelete(IdentityMapperCfg configuration)
Deletes an existing configuration from this delete listener.

Specified by:
applyConfigurationDelete in interface ConfigurationDeleteListener<IdentityMapperCfg>
Parameters:
configuration - The existing configuration that will be deleted.
Returns:
Returns information about the result of deleting the configuration.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(IdentityMapperCfg configuration,
                                               java.util.List<Message> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:
isConfigurationChangeAcceptable in interface ConfigurationChangeListener<IdentityMapperCfg>
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(IdentityMapperCfg configuration)
Applies the configuration changes to this change listener.

Specified by:
applyConfigurationChange in interface ConfigurationChangeListener<IdentityMapperCfg>
Parameters:
configuration - The new configuration containing the changes.
Returns:
Returns information about the result of changing the configuration.