org.opends.server.extensions

Class LDAPPassThroughAuthenticationPolicyFactory

java.lang.Object

org.opends.server.extensions.LDAPPassThroughAuthenticationPolicyFactory

All Implemented Interfaces:

AuthenticationPolicyFactory<LDAPPassThroughAuthenticationPolicyCfg>

public final class LDAPPassThroughAuthenticationPolicyFactory
extends Object
implements AuthenticationPolicyFactory<LDAPPassThroughAuthenticationPolicyCfg>

LDAP pass through authentication policy implementation.

Constructor Summary

Constructors

Constructor and Description
LDAPPassThroughAuthenticationPolicyFactory() Public default constructor used by the admin framework.

Method Summary

Methods

Modifier and Type	Method and Description
AuthenticationPolicy	createAuthenticationPolicy(LDAPPassThroughAuthenticationPolicyCfg configuration) Creates a new authentication policy using the provided configuration.
boolean	isConfigurationAcceptable(LDAPPassThroughAuthenticationPolicyCfg cfg, List<LocalizableMessage> unacceptableReasons) Indicates whether the provided authentication policy configuration is acceptable.
void	setServerContext(ServerContext serverContext) Sets the server context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LDAPPassThroughAuthenticationPolicyFactory

public LDAPPassThroughAuthenticationPolicyFactory()

Public default constructor used by the admin framework. This will use the default LDAP connection factory provider.

Method Detail

setServerContext

public void setServerContext(ServerContext serverContext)

Sets the server context.

Specified by:

setServerContext in interface AuthenticationPolicyFactory<LDAPPassThroughAuthenticationPolicyCfg>

Parameters:

serverContext - The server context.

createAuthenticationPolicy

public AuthenticationPolicy createAuthenticationPolicy(LDAPPassThroughAuthenticationPolicyCfg configuration)
                                                throws org.forgerock.opendj.config.server.ConfigException,
                                                       InitializationException

Creates a new authentication policy using the provided configuration.

Specified by:

createAuthenticationPolicy in interface AuthenticationPolicyFactory<LDAPPassThroughAuthenticationPolicyCfg>

Parameters:

configuration - The configuration.

Returns:

The new authentication policy configured using the provided configuration.

Throws:

org.forgerock.opendj.config.server.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

public boolean isConfigurationAcceptable(LDAPPassThroughAuthenticationPolicyCfg cfg,
                                List<LocalizableMessage> unacceptableReasons)

Indicates whether the provided authentication policy configuration is acceptable.

Specified by:

isConfigurationAcceptable in interface AuthenticationPolicyFactory<LDAPPassThroughAuthenticationPolicyCfg>

Parameters:

cfg - 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.