org.opends.server.admin.std.client
Interface PasswordPolicyImportPluginCfgClient

All Superinterfaces:
ConfigurationClient, PluginCfgClient

public interface PasswordPolicyImportPluginCfgClient
extends PluginCfgClient

A client-side interface for reading and modifying Password Policy Import Plugin settings.

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
 ManagedObjectDefinition<? extends PasswordPolicyImportPluginCfgClient,? extends PasswordPolicyImportPluginCfg> definition()
          Get the configuration definition associated with this Password Policy Import Plugin.
 java.util.SortedSet<java.lang.String> getDefaultAuthPasswordStorageScheme()
          Gets the "default-auth-password-storage-scheme" property.
 java.util.SortedSet<java.lang.String> getDefaultUserPasswordStorageScheme()
          Gets the "default-user-password-storage-scheme" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.util.SortedSet<PluginCfgDefn.PluginType> getPluginType()
          Gets the "plugin-type" property.
 boolean isInvokeForInternalOperations()
          Gets the "invoke-for-internal-operations" property.
 void setDefaultAuthPasswordStorageScheme(java.util.Collection<java.lang.String> values)
          Sets the "default-auth-password-storage-scheme" property.
 void setDefaultUserPasswordStorageScheme(java.util.Collection<java.lang.String> values)
          Sets the "default-user-password-storage-scheme" property.
 void setInvokeForInternalOperations(java.lang.Boolean value)
          Sets the "invoke-for-internal-operations" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setPluginType(java.util.Collection<PluginCfgDefn.PluginType> values)
          Sets the "plugin-type" property.
 
Methods inherited from interface org.opends.server.admin.std.client.PluginCfgClient
isEnabled, setEnabled
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends PasswordPolicyImportPluginCfgClient,? extends PasswordPolicyImportPluginCfg> definition()
Get the configuration definition associated with this Password Policy Import Plugin.

Specified by:
definition in interface ConfigurationClient
Specified by:
definition in interface PluginCfgClient
Returns:
Returns the configuration definition associated with this Password Policy Import Plugin.

getDefaultAuthPasswordStorageScheme

java.util.SortedSet<java.lang.String> getDefaultAuthPasswordStorageScheme()
Gets the "default-auth-password-storage-scheme" property.

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 values of the "default-auth-password-storage-scheme" property.

setDefaultAuthPasswordStorageScheme

void setDefaultAuthPasswordStorageScheme(java.util.Collection<java.lang.String> values)
                                         throws IllegalPropertyValueException
Sets the "default-auth-password-storage-scheme" property.

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.

Parameters:
values - The values of the "default-auth-password-storage-scheme" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.

getDefaultUserPasswordStorageScheme

java.util.SortedSet<java.lang.String> getDefaultUserPasswordStorageScheme()
Gets the "default-user-password-storage-scheme" property.

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 values of the "default-user-password-storage-scheme" property.

setDefaultUserPasswordStorageScheme

void setDefaultUserPasswordStorageScheme(java.util.Collection<java.lang.String> values)
                                         throws IllegalPropertyValueException
Sets the "default-user-password-storage-scheme" property.

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.

Parameters:
values - The values of the "default-user-password-storage-scheme" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.

isInvokeForInternalOperations

boolean isInvokeForInternalOperations()
Gets the "invoke-for-internal-operations" property.

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.

Specified by:
isInvokeForInternalOperations in interface PluginCfgClient
Returns:
Returns the value of the "invoke-for-internal-operations" property.

setInvokeForInternalOperations

void setInvokeForInternalOperations(java.lang.Boolean value)
                                    throws IllegalPropertyValueException
Sets the "invoke-for-internal-operations" property.

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.

Specified by:
setInvokeForInternalOperations in interface PluginCfgClient
Parameters:
value - The value of the "invoke-for-internal-operations" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

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

Specified by:
getJavaClass in interface PluginCfgClient
Returns:
Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

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

Specified by:
setJavaClass in interface PluginCfgClient
Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getPluginType

java.util.SortedSet<PluginCfgDefn.PluginType> getPluginType()
Gets the "plugin-type" property.

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

Specified by:
getPluginType in interface PluginCfgClient
Returns:
Returns the values of the "plugin-type" property.

setPluginType

void setPluginType(java.util.Collection<PluginCfgDefn.PluginType> values)
                   throws IllegalPropertyValueException
Sets the "plugin-type" property.

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

Specified by:
setPluginType in interface PluginCfgClient
Parameters:
values - The values of the "plugin-type" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.