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

Class PasswordGeneratorCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<PasswordGeneratorCfgClient,PasswordGeneratorCfg>

org.forgerock.opendj.server.config.meta.PasswordGeneratorCfgDefn

public final class PasswordGeneratorCfgDefn
extends ManagedObjectDefinition<PasswordGeneratorCfgClient,PasswordGeneratorCfg>

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

Password Generators are used by the password modify extended operation to construct a new password for the user.

Method Summary

Modifier and Type	Method	Description
PasswordGeneratorCfgClient	createClientConfiguration(ManagedObject<? extends PasswordGeneratorCfgClient> impl)	Creates a client configuration view of the provided managed object.
PasswordGeneratorCfg	createServerConfiguration(ServerManagedObject<? extends PasswordGeneratorCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static PasswordGeneratorCfgDefn	getInstance()	Get the Password Generator configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<PasswordGeneratorCfg>	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 PasswordGeneratorCfgDefn getInstance()

Get the Password Generator configuration definition singleton.

Returns:

Returns the Password Generator configuration definition singleton.

createClientConfiguration

public PasswordGeneratorCfgClient createClientConfiguration(ManagedObject<? extends PasswordGeneratorCfgClient> 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<PasswordGeneratorCfgClient,PasswordGeneratorCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<PasswordGeneratorCfgClient,PasswordGeneratorCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<PasswordGeneratorCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<PasswordGeneratorCfgClient,PasswordGeneratorCfg>

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 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 Password Generator implementation.

Returns:

Returns the "java-class" property definition.