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

Class PasswordPolicyImportPluginCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<PasswordPolicyImportPluginCfgClient,PasswordPolicyImportPluginCfg>

org.forgerock.opendj.server.config.meta.PasswordPolicyImportPluginCfgDefn

public final class PasswordPolicyImportPluginCfgDefn
extends ManagedObjectDefinition<PasswordPolicyImportPluginCfgClient,PasswordPolicyImportPluginCfg>

An interface for querying the Password Policy Import Plugin managed object definition meta information.

The Password Policy Import Plugin ensures that clear-text passwords contained in LDIF entries are properly encoded before they are stored in the appropriate directory server backend.

Method Summary

Modifier and Type	Method	Description
PasswordPolicyImportPluginCfgClient	createClientConfiguration(ManagedObject<? extends PasswordPolicyImportPluginCfgClient> impl)	Creates a client configuration view of the provided managed object.
PasswordPolicyImportPluginCfg	createServerConfiguration(ServerManagedObject<? extends PasswordPolicyImportPluginCfg> impl)	Creates a server configuration view of the provided server managed object.
AggregationPropertyDefinition<PasswordStorageSchemeCfgClient,PasswordStorageSchemeCfg>	getDefaultAuthPasswordStorageSchemePropertyDefinition()	Get the "default-auth-password-storage-scheme" property definition.
AggregationPropertyDefinition<PasswordStorageSchemeCfgClient,PasswordStorageSchemeCfg>	getDefaultUserPasswordStorageSchemePropertyDefinition()	Get the "default-user-password-storage-scheme" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static PasswordPolicyImportPluginCfgDefn	getInstance()	Get the Password Policy Import Plugin configuration definition singleton.
BooleanPropertyDefinition	getInvokeForInternalOperationsPropertyDefinition()	Get the "invoke-for-internal-operations" property definition.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
EnumPropertyDefinition<PluginCfgDefn.PluginType>	getPluginTypePropertyDefinition()	Get the "plugin-type" property definition.
Class<PasswordPolicyImportPluginCfg>	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 PasswordPolicyImportPluginCfgDefn getInstance()

Get the Password Policy Import Plugin configuration definition singleton.

Returns:

Returns the Password Policy Import Plugin configuration definition singleton.

createClientConfiguration

public PasswordPolicyImportPluginCfgClient createClientConfiguration(ManagedObject<? extends PasswordPolicyImportPluginCfgClient> 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<PasswordPolicyImportPluginCfgClient,PasswordPolicyImportPluginCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<PasswordPolicyImportPluginCfgClient,PasswordPolicyImportPluginCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<PasswordPolicyImportPluginCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<PasswordPolicyImportPluginCfgClient,PasswordPolicyImportPluginCfg>

Returns:

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

getDefaultAuthPasswordStorageSchemePropertyDefinition

public AggregationPropertyDefinition<PasswordStorageSchemeCfgClient,PasswordStorageSchemeCfg> getDefaultAuthPasswordStorageSchemePropertyDefinition()

Get the "default-auth-password-storage-scheme" property definition.

Specifies the names of password storage schemes that to be used for encoding passwords contained in attributes with the auth password syntax for entries that do not include the ds-pwp-password-policy-dn attribute specifying which password policy should be used to govern them.

Returns:

Returns the "default-auth-password-storage-scheme" property definition.

getDefaultUserPasswordStorageSchemePropertyDefinition

public AggregationPropertyDefinition<PasswordStorageSchemeCfgClient,PasswordStorageSchemeCfg> getDefaultUserPasswordStorageSchemePropertyDefinition()

Get the "default-user-password-storage-scheme" property definition.

Specifies the names of the password storage schemes to be used for encoding passwords contained in attributes with the user password syntax for entries that do not include the ds-pwp-password-policy-dn attribute specifying which password policy is to be used to govern them.

Returns:

Returns the "default-user-password-storage-scheme" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the plug-in is enabled for use.

Returns:

Returns the "enabled" property definition.

getInvokeForInternalOperationsPropertyDefinition

public BooleanPropertyDefinition getInvokeForInternalOperationsPropertyDefinition()

Get the "invoke-for-internal-operations" property definition.

Indicates whether the plug-in should be invoked for internal operations.

Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.

Returns:

Returns the "invoke-for-internal-operations" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

Specifies the fully-qualified name of the Java class that provides the plug-in implementation.

Returns:

Returns the "java-class" property definition.

getPluginTypePropertyDefinition

public EnumPropertyDefinition<PluginCfgDefn.PluginType> getPluginTypePropertyDefinition()

Get the "plugin-type" property definition.

Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.

Returns:

Returns the "plugin-type" property definition.