com.unboundid.ldap.sdk.unboundidds.controls
Class PasswordPolicyResponseControl

java.lang.Object
  extended by com.unboundid.ldap.sdk.Control
      extended by com.unboundid.ldap.sdk.unboundidds.controls.PasswordPolicyResponseControl
All Implemented Interfaces:
DecodeableControl, java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class PasswordPolicyResponseControl
extends Control
implements DecodeableControl

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class provides an implementation of the password policy response control as described in draft-behera-ldap-password-policy. 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 PasswordPolicyWarningType values and at most one error from the set of PasswordPolicyErrorType values. See the documentation for those classes for more information on the information that may be included. See the PasswordPolicyRequestControl documentation for an example that demonstrates the use of the password policy request and response controls.

See Also:
Serialized Form

Field Summary
static java.lang.String PASSWORD_POLICY_RESPONSE_OID
          The OID (1.3.6.1.4.1.42.2.27.8.5.1) for the password policy response control.
 
Constructor Summary
PasswordPolicyResponseControl(PasswordPolicyWarningType warningType, int warningValue, PasswordPolicyErrorType errorType)
          Creates a new password policy response control with the provided information.
PasswordPolicyResponseControl(PasswordPolicyWarningType warningType, int warningValue, PasswordPolicyErrorType errorType, boolean isCritical)
          Creates a new password policy response control with the provided information.
PasswordPolicyResponseControl(java.lang.String oid, boolean isCritical, ASN1OctetString value)
          Creates a new password policy response control with the provided information.
 
Method Summary
 PasswordPolicyResponseControl decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value)
          Creates a new instance of this decodeable control from the provided information.
static PasswordPolicyResponseControl get(LDAPResult result)
          Extracts a password policy response control from the provided result.
 java.lang.String getControlName()
          Retrieves the user-friendly name for this control, if available.
 PasswordPolicyErrorType getErrorType()
          Retrieves the error type for this password policy response control, if available.
 PasswordPolicyWarningType getWarningType()
          Retrieves the warning type for this password policy response control, if available.
 int getWarningValue()
          Retrieves the warning value for this password policy response control, if available.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this LDAP control to the provided buffer.
 
Methods inherited from class com.unboundid.ldap.sdk.Control
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

PASSWORD_POLICY_RESPONSE_OID

public static final java.lang.String PASSWORD_POLICY_RESPONSE_OID
The OID (1.3.6.1.4.1.42.2.27.8.5.1) for the password policy response control.

See Also:
Constant Field Values
Constructor Detail

PasswordPolicyResponseControl

public PasswordPolicyResponseControl(PasswordPolicyWarningType warningType,
                                     int warningValue,
                                     PasswordPolicyErrorType 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.

PasswordPolicyResponseControl

public PasswordPolicyResponseControl(PasswordPolicyWarningType warningType,
                                     int warningValue,
                                     PasswordPolicyErrorType 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.

PasswordPolicyResponseControl

public PasswordPolicyResponseControl(java.lang.String oid,
                                     boolean isCritical,
                                     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.
Method Detail

decodeControl

public PasswordPolicyResponseControl decodeControl(java.lang.String oid,
                                                   boolean isCritical,
                                                   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

public static PasswordPolicyResponseControl get(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

public PasswordPolicyWarningType 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

public PasswordPolicyErrorType 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

public java.lang.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(java.lang.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.