org.opends.server.core
Class PasswordPolicyConfigManager

java.lang.Object
  extended by org.opends.server.core.PasswordPolicyConfigManager
All Implemented Interfaces:
ConfigurationAddListener<PasswordPolicyCfg>, ConfigurationDeleteListener<PasswordPolicyCfg>

public class PasswordPolicyConfigManager
extends java.lang.Object
implements ConfigurationAddListener<PasswordPolicyCfg>, ConfigurationDeleteListener<PasswordPolicyCfg>

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


Constructor Summary
PasswordPolicyConfigManager()
          Creates a new instance of this password policy config manager.
 
Method Summary
 ConfigChangeResult applyConfigurationAdd(PasswordPolicyCfg configuration)
          Adds a new configuration to this add listener.
 ConfigChangeResult applyConfigurationDelete(PasswordPolicyCfg configuration)
          Deletes an existing configuration from this delete listener.
 void initializePasswordPolicies()
          Initializes all password policies currently defined in the Directory Server configuration.
 boolean isConfigurationAddAcceptable(PasswordPolicyCfg configuration, java.util.List<Message> unacceptableReason)
          Indicates whether the proposed addition of a new configuration is acceptable to this add listener.
 boolean isConfigurationDeleteAcceptable(PasswordPolicyCfg configuration, java.util.List<Message> unacceptableReason)
          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

PasswordPolicyConfigManager

public PasswordPolicyConfigManager()
Creates a new instance of this password policy config manager.

Method Detail

initializePasswordPolicies

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

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

isConfigurationAddAcceptable

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

Specified by:
isConfigurationAddAcceptable in interface ConfigurationAddListener<PasswordPolicyCfg>
Parameters:
configuration - The configuration that will be added.
unacceptableReason - 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(PasswordPolicyCfg configuration)
Adds a new configuration to this add listener.

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

isConfigurationDeleteAcceptable

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

Specified by:
isConfigurationDeleteAcceptable in interface ConfigurationDeleteListener<PasswordPolicyCfg>
Parameters:
configuration - The configuration that will be deleted.
unacceptableReason - 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(PasswordPolicyCfg configuration)
Deletes an existing configuration from this delete listener.

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