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

Interface LengthBasedPasswordValidatorCfgClient

All Superinterfaces:

ConfigurationClient, PasswordValidatorCfgClient

public interface LengthBasedPasswordValidatorCfgClient
extends PasswordValidatorCfgClient

A client-side interface for reading and modifying Length Based Password Validator settings.

The Length Based Password Validator is used to determine whether a proposed password is acceptable based on whether the number of characters it contains falls within an acceptable range of values.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends LengthBasedPasswordValidatorCfgClient,? extends LengthBasedPasswordValidatorCfg>	definition()	Get the configuration definition associated with this Length Based Password Validator.
String	getJavaClass()	Gets the "java-class" property.
int	getMaxPasswordLength()	Gets the "max-password-length" property.
int	getMinPasswordLength()	Gets the "min-password-length" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setMaxPasswordLength(Integer value)	Sets the "max-password-length" property.
void	setMinPasswordLength(Integer value)	Sets the "min-password-length" property.

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

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.PasswordValidatorCfgClient

isEnabled, setEnabled

Method Detail

definition

ManagedObjectDefinition<? extends LengthBasedPasswordValidatorCfgClient,? extends LengthBasedPasswordValidatorCfg> definition()

Get the configuration definition associated with this Length Based Password Validator.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface PasswordValidatorCfgClient

Returns:

Returns the configuration definition associated with this Length Based Password Validator.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the password validator implementation.

Specified by:

getJavaClass in interface PasswordValidatorCfgClient

Returns:

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

setJavaClass

void setJavaClass(String value)
           throws PropertyException

Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the password validator implementation.

Specified by:

setJavaClass in interface PasswordValidatorCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getMaxPasswordLength

int getMaxPasswordLength()

Gets the "max-password-length" property.

Specifies the maximum number of characters that can be included in a proposed password.

A value of zero indicates that there will be no upper bound enforced. If both minimum and maximum lengths are defined, then the minimum length must be less than or equal to the maximum length.

Returns:

Returns the value of the "max-password-length" property.

setMaxPasswordLength

void setMaxPasswordLength(Integer value)
                   throws PropertyException

Sets the "max-password-length" property.

Specifies the maximum number of characters that can be included in a proposed password.

A value of zero indicates that there will be no upper bound enforced. If both minimum and maximum lengths are defined, then the minimum length must be less than or equal to the maximum length.

Parameters:

value - The value of the "max-password-length" property.

Throws:

PropertyException - If the new value is invalid.

getMinPasswordLength

int getMinPasswordLength()

Gets the "min-password-length" property.

Specifies the minimum number of characters that must be included in a proposed password.

A value of zero indicates that there will be no lower bound enforced. If both minimum and maximum lengths are defined, then the minimum length must be less than or equal to the maximum length.

Returns:

Returns the value of the "min-password-length" property.

setMinPasswordLength

void setMinPasswordLength(Integer value)
                   throws PropertyException

Sets the "min-password-length" property.

Specifies the minimum number of characters that must be included in a proposed password.

A value of zero indicates that there will be no lower bound enforced. If both minimum and maximum lengths are defined, then the minimum length must be less than or equal to the maximum length.

Parameters:

value - The value of the "min-password-length" property.

Throws:

PropertyException - If the new value is invalid.