org.opends.server.api

Interface AuthenticationPolicyFactory<T extends AuthenticationPolicyCfg>

Type Parameters:

T - The type of authentication policy configuration handled by this factory.

All Known Implementing Classes:

LDAPPassThroughAuthenticationPolicyFactory, PasswordPolicyFactory

public interface AuthenticationPolicyFactory<T extends AuthenticationPolicyCfg>

A factory for creating configurable authentication policies.

All implementations must have a default constructor, i.e. one that does not require and arguments.

Method Summary

Modifier and Type	Method and Description
AuthenticationPolicy	createAuthenticationPolicy(T configuration) Creates a new authentication policy using the provided configuration.
boolean	isConfigurationAcceptable(T configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the provided authentication policy configuration is acceptable.

Method Detail

createAuthenticationPolicy

AuthenticationPolicy createAuthenticationPolicy(T configuration)
                                         throws ConfigException,
                                                InitializationException

Creates a new authentication policy using the provided configuration.

Parameters:

configuration - The configuration.

Returns:

The new authentication policy configured using the provided configuration.

Throws:

ConfigException - If an unrecoverable problem arises during initialization of the authentication policy as a result of the server configuration.

InitializationException - If a problem occurs during initialization of the authentication policy.

isConfigurationAcceptable

boolean isConfigurationAcceptable(T configuration,
                                  List<LocalizableMessage> unacceptableReasons)

Indicates whether the provided authentication policy configuration is acceptable.

Parameters:

configuration - The authentication policy configuration.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the provided authentication policy configuration is acceptable, or false if it is not.