Package org.forgerock.opendj.server.config.meta

Class BcryptPasswordStorageSchemeCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<BcryptPasswordStorageSchemeCfgClient,BcryptPasswordStorageSchemeCfg>

org.forgerock.opendj.server.config.meta.BcryptPasswordStorageSchemeCfgDefn

public final class BcryptPasswordStorageSchemeCfgDefn
extends ManagedObjectDefinition<BcryptPasswordStorageSchemeCfgClient,BcryptPasswordStorageSchemeCfg>

An interface for querying the Bcrypt Password Storage Scheme managed object definition meta information.

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
BcryptPasswordStorageSchemeCfgClient	createClientConfiguration(ManagedObject<? extends BcryptPasswordStorageSchemeCfgClient> impl)	Creates a client configuration view of the provided managed object.
BcryptPasswordStorageSchemeCfg	createServerConfiguration(ServerManagedObject<? extends BcryptPasswordStorageSchemeCfg> impl)	Creates a server configuration view of the provided server managed object.
IntegerPropertyDefinition	getBcryptCostPropertyDefinition()	Get the "bcrypt-cost" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static BcryptPasswordStorageSchemeCfgDefn	getInstance()	Get the Bcrypt Password Storage Scheme configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<BcryptPasswordStorageSchemeCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static BcryptPasswordStorageSchemeCfgDefn getInstance()

Get the Bcrypt Password Storage Scheme configuration definition singleton.

Returns:

Returns the Bcrypt Password Storage Scheme configuration definition singleton.

createClientConfiguration

public BcryptPasswordStorageSchemeCfgClient createClientConfiguration(ManagedObject<? extends BcryptPasswordStorageSchemeCfgClient> impl)

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<BcryptPasswordStorageSchemeCfgClient,BcryptPasswordStorageSchemeCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public BcryptPasswordStorageSchemeCfg createServerConfiguration(ServerManagedObject<? extends BcryptPasswordStorageSchemeCfg> impl)

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<BcryptPasswordStorageSchemeCfgClient,BcryptPasswordStorageSchemeCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<BcryptPasswordStorageSchemeCfg> getServerConfigurationClass()

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<BcryptPasswordStorageSchemeCfgClient,BcryptPasswordStorageSchemeCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getBcryptCostPropertyDefinition

public IntegerPropertyDefinition getBcryptCostPropertyDefinition()

Get the "bcrypt-cost" property definition.

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 "bcrypt-cost" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Bcrypt Password Storage Scheme is enabled for use.

Returns:

Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.