com.unboundid.ldap.sdk.unboundidds.controls

Class PasswordQualityRequirementValidationResult

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.controls.PasswordQualityRequirementValidationResult

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class PasswordQualityRequirementValidationResult
extends java.lang.Object
implements java.io.Serializable

This class provides a data structure that holds information about the result of attempting validation with a proposed password against a password quality requirement.

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.

If it appears in an LDAP protocol element (e.g., in a password validation details response control), then the password quality validation result object should have the following ASN.1 encoding:

   PasswordQualityRequirementValidationResult ::= SEQUENCE {
        passwordRequirement      PasswordQualityRequirement,
        requirementSatisfied     BOOLEAN,
        additionalInfo           [0] OCTET STRING OPTIONAL }
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PasswordQualityRequirementValidationResult(PasswordQualityRequirement passwordRequirement, boolean requirementSatisfied, java.lang.String additionalInfo) Creates a new password quality requirement validation result object with the provided information.

Method Summary

Modifier and Type	Method and Description
static PasswordQualityRequirementValidationResult	decode(ASN1Element element) Decodes the provided ASN.1 element as a password quality requirement validation result.
ASN1Element	encode() Encodes this password quality requirement validation result object to an ASN.1 element.
java.lang.String	getAdditionalInfo() Retrieves a message with additional information about the result of the validation of the proposed password with respect to the associated password quality requirement.
PasswordQualityRequirement	getPasswordRequirement() Retrieves the password quality requirement to which this validation result applies.
boolean	requirementSatisfied() Indicates whether the proposed password satisfied the constraints of the associated password quality requirement.
java.lang.String	toString() Retrieves a string representation of this password quality requirement validation result.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this password quality requirement validation result to the provided buffer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PasswordQualityRequirementValidationResult

public PasswordQualityRequirementValidationResult(@NotNull
                                                  PasswordQualityRequirement passwordRequirement,
                                                  boolean requirementSatisfied,
                                                  @Nullable
                                                  java.lang.String additionalInfo)

Creates a new password quality requirement validation result object with the provided information.

Parameters:

passwordRequirement - The password quality requirement to which this validation result applies. This must not be null.

requirementSatisfied - Indicates whether the proposed password satisfied the constraints of the associated password quality requirement.

additionalInfo - An optional message with additional information about the result of the validation for the proposed password with respect to the associated password quality requirement.

Method Detail

getPasswordRequirement

@NotNull
public PasswordQualityRequirement getPasswordRequirement()

Retrieves the password quality requirement to which this validation result applies.

Returns:

The password quality requirement to which this validation result applies.

requirementSatisfied

public boolean requirementSatisfied()

Indicates whether the proposed password satisfied the constraints of the associated password quality requirement.

Returns:

true if the proposed password satisfied the constraints of the associated password quality requirement, or false if not.

getAdditionalInfo

@Nullable
public java.lang.String getAdditionalInfo()

Retrieves a message with additional information about the result of the validation of the proposed password with respect to the associated password quality requirement.

Returns:

A message with additional information about the result of the validation, or null if no additional information is available.

encode

@NotNull
public ASN1Element encode()

Encodes this password quality requirement validation result object to an ASN.1 element.

Returns:

The ASN.1 element that provides an encoded representation of this object.

decode

@NotNull
public static PasswordQualityRequirementValidationResult decode(@NotNull
                                                                         ASN1Element element)
                                                                  throws LDAPException

Decodes the provided ASN.1 element as a password quality requirement validation result.

Parameters:

element - The ASN.1 element to be decoded as a password quality requirement validation result.

Returns:

The ASN.1 element containing the encoded password quality requirement validation result.

Throws:

LDAPException - If a problem is encountered while attempting to decode the provided ASN.1 element.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation of this password quality requirement validation result.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this password quality requirement validation result.

toString

public void toString(@NotNull
                     java.lang.StringBuilder buffer)

Appends a string representation of this password quality requirement validation result to the provided buffer.

Parameters:

buffer - The buffer to which the information should be appended.