org.opends.server.core

Class CertificateMapperConfigManager

java.lang.Object

org.opends.server.core.CertificateMapperConfigManager

All Implemented Interfaces:

ConfigurationAddListener<CertificateMapperCfg>, ConfigurationChangeListener<CertificateMapperCfg>, ConfigurationDeleteListener<CertificateMapperCfg>

public class CertificateMapperConfigManager
extends Object
implements ConfigurationChangeListener<CertificateMapperCfg>, ConfigurationAddListener<CertificateMapperCfg>, ConfigurationDeleteListener<CertificateMapperCfg>

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

Constructor Summary

Constructors

Constructor and Description
CertificateMapperConfigManager(ServerContext serverContext) Creates a new instance of this certificate mapper config manager.

Method Summary

Methods

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationAdd(CertificateMapperCfg configuration) Adds a new configuration to this add listener.
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(CertificateMapperCfg configuration) Applies the configuration changes to this change listener.
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationDelete(CertificateMapperCfg configuration) Deletes an existing configuration from this delete listener.
void	initializeCertificateMappers() Initializes all certificate mappers currently defined in the Directory Server configuration.
boolean	isConfigurationAddAcceptable(CertificateMapperCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed addition of a new configuration is acceptable to this add listener.
boolean	isConfigurationChangeAcceptable(CertificateMapperCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed change to the configuration is acceptable to this change listener.
boolean	isConfigurationDeleteAcceptable(CertificateMapperCfg configuration, List<LocalizableMessage> 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

CertificateMapperConfigManager

public CertificateMapperConfigManager(ServerContext serverContext)

Creates a new instance of this certificate mapper config manager.

Parameters:

serverContext - The server context.

Method Detail

initializeCertificateMappers

public void initializeCertificateMappers()
                                  throws org.forgerock.opendj.config.server.ConfigException,
                                         InitializationException

Initializes all certificate mappers currently defined in the Directory Server configuration. This should only be called at Directory Server startup.

Throws:

org.forgerock.opendj.config.server.ConfigException - If a configuration problem causes the certificate mapper initialization process to fail.

InitializationException - If a problem occurs while initializing the certificate mappers that is not related to the server configuration.

isConfigurationAddAcceptable

public boolean isConfigurationAddAcceptable(CertificateMapperCfg configuration,
                                   List<LocalizableMessage> unacceptableReasons)

Indicates whether the proposed addition of a new configuration is acceptable to this add listener.

Specified by:

isConfigurationAddAcceptable in interface ConfigurationAddListener<CertificateMapperCfg>

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 org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationAdd(CertificateMapperCfg configuration)

Adds a new configuration to this add listener.

Specified by:

applyConfigurationAdd in interface ConfigurationAddListener<CertificateMapperCfg>

Parameters:

configuration - The configuration that will be added.

Returns:

Returns information about the result of adding the configuration.

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(CertificateMapperCfg configuration,
                                      List<LocalizableMessage> unacceptableReasons)

Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener.

Specified by:

isConfigurationDeleteAcceptable in interface ConfigurationDeleteListener<CertificateMapperCfg>

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 org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationDelete(CertificateMapperCfg configuration)

Deletes an existing configuration from this delete listener.

Specified by:

applyConfigurationDelete in interface ConfigurationDeleteListener<CertificateMapperCfg>

Parameters:

configuration - The existing configuration that will be deleted.

Returns:

Returns information about the result of deleting the configuration.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(CertificateMapperCfg configuration,
                                      List<LocalizableMessage> unacceptableReasons)

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<CertificateMapperCfg>

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 org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(CertificateMapperCfg configuration)

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<CertificateMapperCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.