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

Interface BcryptPasswordStorageSchemeCfgClient

All Superinterfaces:

ConfigurationClient, PasswordStorageSchemeCfgClient

public interface BcryptPasswordStorageSchemeCfgClient
extends PasswordStorageSchemeCfgClient

A client-side interface for reading and modifying Bcrypt Password Storage Scheme settings.

The Bcrypt Password Storage Scheme provides a mechanism for encoding user passwords using the bcrypt message digest algorithm.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends BcryptPasswordStorageSchemeCfgClient,? extends BcryptPasswordStorageSchemeCfg>	definition()	Get the configuration definition associated with this Bcrypt Password Storage Scheme.
int	getBcryptCost()	Gets the "bcrypt-cost" property.
String	getJavaClass()	Gets the "java-class" property.
void	setBcryptCost(Integer value)	Sets the "bcrypt-cost" property.
void	setJavaClass(String value)	Sets the "java-class" property.

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

commit, properties

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

isEnabled, setEnabled

Method Detail

definition

ManagedObjectDefinition<? extends BcryptPasswordStorageSchemeCfgClient,? extends BcryptPasswordStorageSchemeCfg> definition()

Get the configuration definition associated with this Bcrypt Password Storage Scheme.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface PasswordStorageSchemeCfgClient

Returns:

Returns the configuration definition associated with this Bcrypt Password Storage Scheme.

getBcryptCost

int getBcryptCost()

Gets the "bcrypt-cost" property.

The cost parameter specifies a key expansion iteration count as a power of two. A default value of 12 (2^12 iterations) is considered in 2016 as a reasonable balance between responsiveness and security for regular users.

Returns:

Returns the value of the "bcrypt-cost" property.

setBcryptCost

void setBcryptCost(Integer value)
            throws PropertyException

Sets the "bcrypt-cost" property.

The cost parameter specifies a key expansion iteration count as a power of two. A default value of 12 (2^12 iterations) is considered in 2016 as a reasonable balance between responsiveness and security for regular users.

Parameters:

value - The value of the "bcrypt-cost" property.

Throws:

PropertyException - If the new value is invalid.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Bcrypt Password Storage Scheme implementation.

Specified by:

getJavaClass in interface PasswordStorageSchemeCfgClient

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 Bcrypt Password Storage Scheme implementation.

Specified by:

setJavaClass in interface PasswordStorageSchemeCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.