Package org.forgerock.opendj.server.config.client

Interface AuthenticationPolicyCfgClient

All Superinterfaces:

ConfigurationClient

All Known Subinterfaces:

LdapPassThroughAuthenticationPolicyCfgClient, PasswordPolicyCfgClient

public interface AuthenticationPolicyCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying Authentication Policy settings.

Authentication Policies define the policies which should be used for authenticating users and managing the password and other account related state.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends AuthenticationPolicyCfgClient,? extends AuthenticationPolicyCfg>	definition()	Get the configuration definition associated with this Authentication Policy.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Method Details

definition

ManagedObjectDefinition<? extends AuthenticationPolicyCfgClient,? extends AuthenticationPolicyCfg> definition()

Get the configuration definition associated with this Authentication Policy.

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this Authentication Policy.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class which provides the Authentication Policy implementation.

Returns:

Returns the value of the "java-class" property.

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

Specifies the fully-qualified name of the Java class which provides the Authentication Policy implementation.

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.