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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ManagedObjectDefinition<? extends PasswordPolicyImportPluginCfgClient,? extends PasswordPolicyImportPluginCfg>
definition()
Get the configuration definition associated with this Password Policy Import Plugin.SortedSet<ValueOrExpression<String>>
getDefaultAuthPasswordStorageScheme()
Gets the "default-auth-password-storage-scheme" property.SortedSet<ValueOrExpression<String>>
getDefaultUserPasswordStorageScheme()
Gets the "default-user-password-storage-scheme" property.ValueOrExpression<String>
getJavaClass()
Gets the "java-class" property.SortedSet<ValueOrExpression<PluginCfgDefn.PluginType>>
getPluginType()
Gets the "plugin-type" property.ValueOrExpression<Boolean>
isInvokeForInternalOperations()
Gets the "invoke-for-internal-operations" property.void
setDefaultAuthPasswordStorageScheme(Collection<ValueOrExpression<String>> values)
Sets the "default-auth-password-storage-scheme" property.void
setDefaultUserPasswordStorageScheme(Collection<ValueOrExpression<String>> values)
Sets the "default-user-password-storage-scheme" property.void
setInvokeForInternalOperations(ValueOrExpression<Boolean> value)
Sets the "invoke-for-internal-operations" property.void
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.void
setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values)
Sets the "plugin-type" property.-
Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient
commit, properties
-
Methods inherited from interface org.forgerock.opendj.server.config.client.PluginCfgClient
isEnabled, setEnabled
-
-
-
-
Method Detail
-
definition
ManagedObjectDefinition<? extends PasswordPolicyImportPluginCfgClient,? extends PasswordPolicyImportPluginCfg> definition()
Get the configuration definition associated with this Password Policy Import Plugin.- Specified by:
definition
in interfaceConfigurationClient
- Specified by:
definition
in interfacePluginCfgClient
- Returns:
- Returns the configuration definition associated with this Password Policy Import Plugin.
-
getDefaultAuthPasswordStorageScheme
SortedSet<ValueOrExpression<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(Collection<ValueOrExpression<String>> values) throws PropertyException
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:
PropertyException
- If one or more of the new values are invalid.
-
getDefaultUserPasswordStorageScheme
SortedSet<ValueOrExpression<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(Collection<ValueOrExpression<String>> values) throws PropertyException
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:
PropertyException
- If one or more of the new values are invalid.
-
isInvokeForInternalOperations
ValueOrExpression<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.
Default value:
false
- Specified by:
isInvokeForInternalOperations
in interfacePluginCfgClient
- Returns:
- Returns the value of the "invoke-for-internal-operations" property.
-
setInvokeForInternalOperations
void setInvokeForInternalOperations(ValueOrExpression<Boolean> value) throws PropertyException
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 interfacePluginCfgClient
- Parameters:
value
- The value of the "invoke-for-internal-operations" property.- Throws:
PropertyException
- If the new value is invalid.
-
getJavaClass
@MandatoryProperty ValueOrExpression<String> getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
Default value:
org.opends.server.plugins.PasswordPolicyImportPlugin
- Specified by:
getJavaClass
in interfacePluginCfgClient
- Returns:
- Returns the value of the "java-class" property.
-
setJavaClass
@MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
Sets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
- Specified by:
setJavaClass
in interfacePluginCfgClient
- Parameters:
value
- The value of the "java-class" property.- Throws:
PropertyException
- If the new value is invalid.
-
getPluginType
@MandatoryProperty SortedSet<ValueOrExpression<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.
Default value:
ldifimport
- Specified by:
getPluginType
in interfacePluginCfgClient
- Returns:
- Returns the values of the "plugin-type" property.
-
setPluginType
@MandatoryProperty void setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values) throws PropertyException
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 interfacePluginCfgClient
- Parameters:
values
- The values of the "plugin-type" property.- Throws:
PropertyException
- If one or more of the new values are invalid.
-
-