Package com.unboundid.ldap.sdk.unboundidds.extensions

Class GetPasswordQualityRequirementsExtendedRequest

java.lang.Object
com.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.ExtendedRequest
com.unboundid.ldap.sdk.unboundidds.extensions.GetPasswordQualityRequirementsExtendedRequest
All Implemented Interfaces:
ProtocolOp, ReadOnlyLDAPRequest, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetPasswordQualityRequirementsExtendedRequest extends ExtendedRequest
This class provides an implementation of an extended request that may be used to retrieve the set of password quality requirements that the Directory Server will impose for a specified operation, which may include adding a new user (including a password), a user changing his/her own password (a self change), or one user changing the password for another user (an administrative reset).
NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

This extended request has an OID of 1.3.6.1.4.1.30221.2.6.43 and a value with the following encoding: 
   GetPasswordQualityRequirementsRequestValue ::= SEQUENCE {
        target     CHOICE {
             addWithDefaultPasswordPolicy           [0] NULL,
             addWithSpecifiedPasswordPolicy         [1] LDAPDN,
             selfChangeForAuthorizationIdentity     [2] NULL,
             selfChangeForSpecifiedUser             [3] LDAPDN,
             administrativeResetForUser             [4] LDAPDN,
             ... },
        ... }
See Also:

  • Field Details

  • Constructor Details

    • GetPasswordQualityRequirementsExtendedRequest

      public GetPasswordQualityRequirementsExtendedRequest(@NotNull ExtendedRequest r) throws LDAPException
      Creates a new get password quality requirements extended request decoded from the provided generic extended request.
      Parameters:
      r - The extended request to decode as a get password quality requirements request.
      Throws:
      LDAPException - If a problem is encountered while attempting to decoded the provided extended request as a get password quality requirements request.

  • Method Details

    • createAddWithDefaultPasswordPolicyRequest

      @NotNull public static GetPasswordQualityRequirementsExtendedRequest createAddWithDefaultPasswordPolicyRequest(@Nullable Control... controls)
      Creates a new get password quality requirements extended request that will retrieve the password requirements for an add operation governed by the server's default password policy.
      Parameters:
      controls - The set of controls to include in the request. It may be null or empty if no controls should be included in the request.
      Returns:
      A new get password quality requirements extended request that will retrieve the password requirements for an add operation governed by the server's default password policy.

    • createAddWithSpecifiedPasswordPolicyRequest

      @NotNull public static GetPasswordQualityRequirementsExtendedRequest createAddWithSpecifiedPasswordPolicyRequest(@NotNull String policyDN, @Nullable Control... controls)
      Creates a new get password quality requirements extended request that will retrieve the password requirements for an add operation governed by the specified password policy.
      Parameters:
      policyDN - The DN of the entry that defines the password policy from which to determine the password quality requirements.
      controls - The set of controls to include in the request. It may be null or empty if no controls should be included in the request.
      Returns:
      A new get password quality requirements extended request that will retrieve the password requirements for an add operation governed by the specified password policy.

    • createSelfChangeWithSameAuthorizationIdentityRequest

      @NotNull public static GetPasswordQualityRequirementsExtendedRequest createSelfChangeWithSameAuthorizationIdentityRequest(@Nullable Control... controls)
      Creates a new get password quality requirements extended request that will retrieve the password requirements for a self change requested with the same authorization identity as this extended request.
      Parameters:
      controls - The set of controls to include in the request. It may be null or empty if no controls should be included in the request.
      Returns:
      A new get password quality requirements extended request that will retrieve the password requirements for a self change requested with the same authorization identity as this extended request.

    • createSelfChangeForSpecifiedUserRequest

      @NotNull public static GetPasswordQualityRequirementsExtendedRequest createSelfChangeForSpecifiedUserRequest(@NotNull String userDN, @Nullable Control... controls)
      Creates a new get password quality requirements extended request that will retrieve the password requirements for a self change requested by the specified user.
      Parameters:
      userDN - The DN of the user for whom to retrieve the self change password requirements.
      controls - The set of controls to include in the request. It may be null or empty if no controls should be included in the request.
      Returns:
      A new get password quality requirements extended request that will retrieve the password requirements for a self change requested by the specified user.

    • createAdministrativeResetForSpecifiedUserRequest

      @NotNull public static GetPasswordQualityRequirementsExtendedRequest createAdministrativeResetForSpecifiedUserRequest(@NotNull String userDN, @Nullable Control... controls)
      Creates a new get password quality requirements extended request that will retrieve the password requirements for an administrative reset targeting the specified user.
      Parameters:
      userDN - The DN of the user for whom to retrieve the administrative reset password requirements.
      controls - The set of controls to include in the request. It may be null or empty if no controls should be included in the request.
      Returns:
      A new get password quality requirements extended request that will retrieve the password requirements for an administrative reset targeting the specified user.

    • getTargetType

      @NotNull public GetPasswordQualityRequirementsTargetType getTargetType()
      Retrieves the target type for this get password quality requirements request.
      Returns:
      The target type for this get password quality requirements request.

    • getTargetDN

      @Nullable public String getTargetDN()
      Retrieves the target DN for this get password quality requirements request. For a request with a target type of ADD_WITH_SPECIFIED_PASSWORD_POLICY, this will be the DN of the password policy from which to obtain the password quality requirements. For a request with a target type of either SELF_CHANGE_FOR_SPECIFIED_USER or ADMINISTRATIVE_RESET_FOR_SPECIFIED_USER, this will be the DN of the user for which to obtain the password quality requirements. For a request with a target type of either ADD_WITH_DEFAULT_PASSWORD_POLICY or SELF_CHANGE_FOR_AUTHORIZATION_IDENTITY, no target DN is required and the value returned will be null.
      Returns:
      The target DN for this get password quality requirements request.

    • process

      @NotNull public GetPasswordQualityRequirementsExtendedResult process(@NotNull LDAPConnection connection, int depth) throws LDAPException
      Sends this extended request to the directory server over the provided connection and returns the associated response.
      Overrides:
      process in class ExtendedRequest
      Parameters:
      connection - The connection to use to communicate with the directory server.
      depth - The current referral depth for this request. It should always be one for the initial request, and should only be incremented when following referrals.
      Returns:
      An LDAP result object that provides information about the result of the extended operation processing.
      Throws:
      LDAPException - If a problem occurs while sending the request or reading the response.

    • duplicate

      @NotNull public GetPasswordQualityRequirementsExtendedRequest duplicate()
      Creates a new instance of this LDAP request that may be modified without impacting this request.. Subclasses should override this method to return a duplicate of the appropriate type.
      Specified by:
      duplicate in interface ReadOnlyLDAPRequest
      Overrides:
      duplicate in class ExtendedRequest
      Returns:
      A new instance of this LDAP request that may be modified without impacting this request.

    • duplicate

      @NotNull public GetPasswordQualityRequirementsExtendedRequest duplicate(@Nullable Control[] controls)
      Creates a new instance of this LDAP request that may be modified without impacting this request. The provided controls will be used for the new request instead of duplicating the controls from this request.. Subclasses should override this method to return a duplicate of the appropriate type.
      Specified by:
      duplicate in interface ReadOnlyLDAPRequest
      Overrides:
      duplicate in class ExtendedRequest
      Parameters:
      controls - The set of controls to include in the duplicate request.
      Returns:
      A new instance of this LDAP request that may be modified without impacting this request.

    • getExtendedRequestName

      @NotNull public String getExtendedRequestName()
      Retrieves the user-friendly name for the extended request, if available. If no user-friendly name has been defined, then the OID will be returned.
      Overrides:
      getExtendedRequestName in class ExtendedRequest
      Returns:
      The user-friendly name for this extended request, or the OID if no user-friendly name is available.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this request to the provided buffer.
      Specified by:
      toString in interface ProtocolOp
      Specified by:
      toString in interface ReadOnlyLDAPRequest
      Overrides:
      toString in class ExtendedRequest
      Parameters:
      buffer - The buffer to which to append a string representation of this request.