Package com.unboundid.ldap.sdk.experimental

Class DraftBeheraLDAPPasswordPolicy10ResponseControl

java.lang.Object
com.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.experimental.DraftBeheraLDAPPasswordPolicy10ResponseControl
All Implemented Interfaces:
DecodeableControl, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class DraftBeheraLDAPPasswordPolicy10ResponseControl extends Control implements DecodeableControl
This class provides an implementation of the password policy response control as described in draft-behera-ldap-password-policy-10. It may be used to provide information related to a user's password policy. It may include at most one warning from the set of DraftBeheraLDAPPasswordPolicy10WarningType values and at most one error from the set of DraftBeheraLDAPPasswordPolicy10ErrorType values. See the documentation for those classes for more information on the information that may be included. See the DraftBeheraLDAPPasswordPolicy10RequestControl documentation for an example that demonstrates the use of the password policy request and response controls.
See Also:

  • Field Details

  • Constructor Details

    • DraftBeheraLDAPPasswordPolicy10ResponseControl

      public DraftBeheraLDAPPasswordPolicy10ResponseControl(@Nullable DraftBeheraLDAPPasswordPolicy10WarningType warningType, int warningValue, @Nullable DraftBeheraLDAPPasswordPolicy10ErrorType errorType)
      Creates a new password policy response control with the provided information. It will not be critical.
      Parameters:
      warningType - The password policy warning type for this response control, or null if there should be no warning type.
      warningValue - The value for the password policy warning type, or -1 if there is no warning type.
      errorType - The password policy error type for this response control, or null if there should be no error type.

    • DraftBeheraLDAPPasswordPolicy10ResponseControl

      public DraftBeheraLDAPPasswordPolicy10ResponseControl(@NotNull String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
      Creates a new password policy response control with the provided information.
      Parameters:
      oid - The OID for the control.
      isCritical - Indicates whether the control should be marked critical.
      value - The encoded value for the control. This may be null if no value was provided.
      Throws:
      LDAPException - If the provided control cannot be decoded as a password policy response control.

    • DraftBeheraLDAPPasswordPolicy10ResponseControl

      public DraftBeheraLDAPPasswordPolicy10ResponseControl(@Nullable DraftBeheraLDAPPasswordPolicy10WarningType warningType, int warningValue, @Nullable DraftBeheraLDAPPasswordPolicy10ErrorType errorType, boolean isCritical)
      Creates a new password policy response control with the provided information.
      Parameters:
      warningType - The password policy warning type for this response control, or null if there should be no warning type.
      warningValue - The value for the password policy warning type, or -1 if there is no warning type.
      errorType - The password policy error type for this response control, or null if there should be no error type.
      isCritical - Indicates whether this control should be marked critical.

  • Method Details

    • decodeControl

      @NotNull public DraftBeheraLDAPPasswordPolicy10ResponseControl decodeControl(@NotNull String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
      Creates a new instance of this decodeable control from the provided information.
      Specified by:
      decodeControl in interface DecodeableControl
      Parameters:
      oid - The OID for the control.
      isCritical - Indicates whether the control should be marked critical.
      value - The encoded value for the control. This may be null if no value was provided.
      Returns:
      The decoded representation of this control.
      Throws:
      LDAPException - If the provided information cannot be decoded as a valid instance of this decodeable control.

    • get

      @Nullable public static DraftBeheraLDAPPasswordPolicy10ResponseControl get(@NotNull LDAPResult result) throws LDAPException
      Extracts a password policy response control from the provided result.
      Parameters:
      result - The result from which to retrieve the password policy response control.
      Returns:
      The password policy response control contained in the provided result, or null if the result did not contain a password policy response control.
      Throws:
      LDAPException - If a problem is encountered while attempting to decode the password policy response control contained in the provided result.

    • getWarningType

      @Nullable public DraftBeheraLDAPPasswordPolicy10WarningType getWarningType()
      Retrieves the warning type for this password policy response control, if available.
      Returns:
      The warning type for this password policy response control, or null if there is no warning type.

    • getWarningValue

      public int getWarningValue()
      Retrieves the warning value for this password policy response control, if available.
      Returns:
      The warning value for this password policy response control, or -1 if there is no warning type.

    • getErrorType

      @Nullable public DraftBeheraLDAPPasswordPolicy10ErrorType getErrorType()
      Retrieves the error type for this password policy response control, if available.
      Returns:
      The error type for this password policy response control, or null if there is no error type.

    • getControlName

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

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this LDAP control to the provided buffer.
      Overrides:
      toString in class Control
      Parameters:
      buffer - The buffer to which to append the string representation of this buffer.