org.opends.server.admin.std.meta

Class CryptPasswordStorageSchemeCfgDefn

java.lang.Object

org.opends.server.admin.AbstractManagedObjectDefinition<C,S>

org.opends.server.admin.ManagedObjectDefinition<CryptPasswordStorageSchemeCfgClient,CryptPasswordStorageSchemeCfg>

org.opends.server.admin.std.meta.CryptPasswordStorageSchemeCfgDefn

public final class CryptPasswordStorageSchemeCfgDefn
extends ManagedObjectDefinition<CryptPasswordStorageSchemeCfgClient,CryptPasswordStorageSchemeCfg>

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

The Crypt Password Storage Scheme provides a mechanism for encoding user passwords like Unix crypt does. Like on most Unix systems, the password may be encrypted using different algorithms, either Unix crypt, md5, sha256 or sha512.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CryptPasswordStorageSchemeCfgDefn.CryptPasswordStorageEncryptionAlgorithm Defines the set of permissable values for the "crypt-password-storage-encryption-algorithm" property.

Method Summary

Methods

Modifier and Type	Method and Description
CryptPasswordStorageSchemeCfgClient	createClientConfiguration(ManagedObject<? extends CryptPasswordStorageSchemeCfgClient> impl) Creates a client configuration view of the provided managed object.
CryptPasswordStorageSchemeCfg	createServerConfiguration(ServerManagedObject<? extends CryptPasswordStorageSchemeCfg> impl) Creates a server configuration view of the provided server managed object.
EnumPropertyDefinition<CryptPasswordStorageSchemeCfgDefn.CryptPasswordStorageEncryptionAlgorithm>	getCryptPasswordStorageEncryptionAlgorithmPropertyDefinition() Get the "crypt-password-storage-encryption-algorithm" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition() Get the "enabled" property definition.
static CryptPasswordStorageSchemeCfgDefn	getInstance() Get the Crypt Password Storage Scheme configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition() Get the "java-class" property definition.
Class<CryptPasswordStorageSchemeCfg>	getServerConfigurationClass() Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.opends.server.admin.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 CryptPasswordStorageSchemeCfgDefn getInstance()

Get the Crypt Password Storage Scheme configuration definition singleton.

Returns:

Returns the Crypt Password Storage Scheme configuration definition singleton.

createClientConfiguration

public CryptPasswordStorageSchemeCfgClient createClientConfiguration(ManagedObject<? extends CryptPasswordStorageSchemeCfgClient> 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<CryptPasswordStorageSchemeCfgClient,CryptPasswordStorageSchemeCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<CryptPasswordStorageSchemeCfgClient,CryptPasswordStorageSchemeCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<CryptPasswordStorageSchemeCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<CryptPasswordStorageSchemeCfgClient,CryptPasswordStorageSchemeCfg>

Returns:

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

getCryptPasswordStorageEncryptionAlgorithmPropertyDefinition

public EnumPropertyDefinition<CryptPasswordStorageSchemeCfgDefn.CryptPasswordStorageEncryptionAlgorithm> getCryptPasswordStorageEncryptionAlgorithmPropertyDefinition()

Get the "crypt-password-storage-encryption-algorithm" property definition.

Specifies the algorithm to use to encrypt new passwords.

Select the crypt algorithm to use to encrypt new passwords. The value can either be "unix", which means the password is encrypted with the weak Unix crypt algorithm, or "md5" which means the password is encrypted with the BSD MD5 algorithm and has a $1$ prefix, or "sha256" which means the password is encrypted with the SHA256 algorithm and has a $5$ prefix, or "sha512" which means the password is encrypted with the SHA512 algorithm and has a $6$ prefix.

Returns:

Returns the "crypt-password-storage-encryption-algorithm" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Crypt 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 Crypt Password Storage Scheme implementation.

Returns:

Returns the "java-class" property definition.