Package org.opends.server.core

Class TrustManagerProviderConfigManager

java.lang.Object

org.opends.server.core.TrustManagerProviderConfigManager

All Implemented Interfaces:

ConfigurationAddListener<TrustManagerProviderCfg>, ConfigurationChangeListener<TrustManagerProviderCfg>, ConfigurationDeleteListener<TrustManagerProviderCfg>

public final class TrustManagerProviderConfigManager
extends Object
implements ConfigurationChangeListener<TrustManagerProviderCfg>, ConfigurationAddListener<TrustManagerProviderCfg>, ConfigurationDeleteListener<TrustManagerProviderCfg>

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

Method Summary

Modifier and Type	Method	Description
ConfigChangeResult	applyConfigurationAdd(TrustManagerProviderCfg configuration)	Adds a new configuration to this add listener.
ConfigChangeResult	applyConfigurationChange(TrustManagerProviderCfg configuration)	Applies the configuration changes to this change listener.
ConfigChangeResult	applyConfigurationDelete(TrustManagerProviderCfg configuration)	Deletes an existing configuration from this delete listener.
TrustManagerProvider<?>	getTrustManagerProvider(Dn dn)	Retrieves the trust manager provider registered with the provided entry DN.
void	initializeTrustManagerProviders()	Initializes all trust manager providers currently defined in the Directory Server configuration.
boolean	isConfigurationAddAcceptable(TrustManagerProviderCfg configuration, List<LocalizableMessage> unacceptableReasons)	Indicates whether the proposed addition of a new configuration is acceptable to this add listener.
boolean	isConfigurationChangeAcceptable(TrustManagerProviderCfg configuration, List<LocalizableMessage> unacceptableReasons)	Indicates whether the proposed change to the configuration is acceptable to this change listener.
boolean	isConfigurationDeleteAcceptable(TrustManagerProviderCfg 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

Method Detail

initializeTrustManagerProviders

public void initializeTrustManagerProviders()
                                     throws ConfigException

Initializes all trust manager providers currently defined in the Directory Server configuration. This should only be called at Directory Server startup.

Throws:

ConfigException - If a configuration problem causes the trust manager provider initialization process to fail.

getTrustManagerProvider

public TrustManagerProvider<?> getTrustManagerProvider(Dn dn)

Retrieves the trust manager provider registered with the provided entry DN.

Parameters:

dn - The DN with which the trust manager provider is registered.

Returns:

The TrustManagerProvider registered with the provided entry Dn, or null if there is no such TrustManagerProvider registered with the server.

isConfigurationAddAcceptable

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

Description copied from interface: ConfigurationAddListener

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

Specified by:

isConfigurationAddAcceptable in interface ConfigurationAddListener<TrustManagerProviderCfg>

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(TrustManagerProviderCfg configuration)

Description copied from interface: ConfigurationAddListener

Adds a new configuration to this add listener.

Specified by:

applyConfigurationAdd in interface ConfigurationAddListener<TrustManagerProviderCfg>

Parameters:

configuration - The configuration that will be added.

Returns:

Returns information about the result of adding the configuration.

isConfigurationDeleteAcceptable

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

Description copied from interface: ConfigurationDeleteListener

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

Specified by:

isConfigurationDeleteAcceptable in interface ConfigurationDeleteListener<TrustManagerProviderCfg>

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(TrustManagerProviderCfg configuration)

Description copied from interface: ConfigurationDeleteListener

Deletes an existing configuration from this delete listener.

Specified by:

applyConfigurationDelete in interface ConfigurationDeleteListener<TrustManagerProviderCfg>

Parameters:

configuration - The existing configuration that will be deleted.

Returns:

Returns information about the result of deleting the configuration.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(TrustManagerProviderCfg 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<TrustManagerProviderCfg>

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(TrustManagerProviderCfg configuration)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<TrustManagerProviderCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.