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

Class RandomPasswordGeneratorCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<RandomPasswordGeneratorCfgClient,RandomPasswordGeneratorCfg>

org.forgerock.opendj.server.config.meta.RandomPasswordGeneratorCfgDefn

public final class RandomPasswordGeneratorCfgDefn
extends ManagedObjectDefinition<RandomPasswordGeneratorCfgClient,RandomPasswordGeneratorCfg>

An interface for querying the Random Password Generator managed object definition meta information.

The Random Password Generator creates random passwords based on fixed-length strings built from one or more character sets.

Method Summary

Modifier and Type	Method	Description
RandomPasswordGeneratorCfgClient	createClientConfiguration(ManagedObject<? extends RandomPasswordGeneratorCfgClient> impl)	Creates a client configuration view of the provided managed object.
RandomPasswordGeneratorCfg	createServerConfiguration(ServerManagedObject<? extends RandomPasswordGeneratorCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static RandomPasswordGeneratorCfgDefn	getInstance()	Get the Random Password Generator configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
StringPropertyDefinition	getPasswordCharacterSetPropertyDefinition()	Get the "password-character-set" property definition.
StringPropertyDefinition	getPasswordFormatPropertyDefinition()	Get the "password-format" property definition.
Class<RandomPasswordGeneratorCfg>	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 RandomPasswordGeneratorCfgDefn getInstance()

Get the Random Password Generator configuration definition singleton.

Returns:

Returns the Random Password Generator configuration definition singleton.

createClientConfiguration

public RandomPasswordGeneratorCfgClient createClientConfiguration(ManagedObject<? extends RandomPasswordGeneratorCfgClient> 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<RandomPasswordGeneratorCfgClient,RandomPasswordGeneratorCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<RandomPasswordGeneratorCfgClient,RandomPasswordGeneratorCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<RandomPasswordGeneratorCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<RandomPasswordGeneratorCfgClient,RandomPasswordGeneratorCfg>

Returns:

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

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Random Password Generator 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 Random Password Generator implementation.

Returns:

Returns the "java-class" property definition.

getPasswordCharacterSetPropertyDefinition

public StringPropertyDefinition getPasswordCharacterSetPropertyDefinition()

Get the "password-character-set" property definition.

Specifies one or more named character sets.

This is a multi-valued property, with each value defining a different character set. The format of the character set is the name of the set followed by a colon and the characters that are in that set. For example, the value "alpha:abcdefghijklmnopqrstuvwxyz" defines a character set named "alpha" containing all of the lower-case ASCII alphabetic characters.

Returns:

Returns the "password-character-set" property definition.

getPasswordFormatPropertyDefinition

public StringPropertyDefinition getPasswordFormatPropertyDefinition()

Get the "password-format" property definition.

Specifies the format to use for the generated password.

The value is a comma-delimited list of elements in which each of those elements is comprised of the name of a character set defined in the password-character-set property, a colon, and the number of characters to include from that set. For example, a value of "alpha:3,numeric:2,alpha:3" generates an 8-character password in which the first three characters are from the "alpha" set, the next two are from the "numeric" set, and the final three are from the "alpha" set.

Returns:

Returns the "password-format" property definition.