Interface PasswordPolicyImportPluginCfg

  • All Superinterfaces:
    Configuration, PluginCfg

    public interface PasswordPolicyImportPluginCfg
    extends PluginCfg
    A server-side interface for querying 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 Detail

      • addPasswordPolicyImportChangeListener

        void addPasswordPolicyImportChangeListener​(ConfigurationChangeListener<PasswordPolicyImportPluginCfg> listener)
        Register to be notified when this Password Policy Import Plugin is changed.
        Parameters:
        listener - The Password Policy Import Plugin configuration change listener.
      • removePasswordPolicyImportChangeListener

        void removePasswordPolicyImportChangeListener​(ConfigurationChangeListener<PasswordPolicyImportPluginCfg> listener)
        Deregister an existing Password Policy Import Plugin configuration change listener.
        Parameters:
        listener - The Password Policy Import Plugin configuration change listener.
      • getDefaultAuthPasswordStorageScheme

        SortedSet<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 an unmodifiable set containing the values of the "default-auth-password-storage-scheme" property.
      • getDefaultAuthPasswordStorageSchemeDns

        SortedSet<Dn> getDefaultAuthPasswordStorageSchemeDns()
        Gets the "default-auth-password-storage-scheme" property as a set of DNs.

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

        SortedSet<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 an unmodifiable set containing the values of the "default-user-password-storage-scheme" property.
      • getDefaultUserPasswordStorageSchemeDns

        SortedSet<Dn> getDefaultUserPasswordStorageSchemeDns()
        Gets the "default-user-password-storage-scheme" property as a set of DNs.

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

        Default value: false

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

        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 interface PluginCfg
        Returns:
        Returns the value of the "java-class" property.
      • getPluginType

        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.

        Default value: ldifimport

        Specified by:
        getPluginType in interface PluginCfg
        Returns:
        Returns an unmodifiable set containing the values of the "plugin-type" property.