|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.unboundidds.extensions.PasswordQualityRequirement
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class PasswordQualityRequirement
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 a data structure that describes a requirement that passwords must satisfy in order to be accepted by the server.
PasswordQualityRequirement ::= SEQUENCE { description OCTET STRING, clientSideValidationInfo [0] SEQUENCE { validationType OCTET STRING, properties [0] SET OF SEQUENCE { name OCTET STRING, value OCTET STRING } OPTIONAL } OPTIONAL }
Constructor Summary | |
---|---|
PasswordQualityRequirement(java.lang.String description)
Creates a new password quality requirement object without any support for client-side validation. |
|
PasswordQualityRequirement(java.lang.String description,
java.lang.String clientSideValidationType,
java.util.Map<java.lang.String,java.lang.String> clientSideValidationProperties)
Creates a new password quality requirement object with optional support for client-side validation. |
Method Summary | |
---|---|
static PasswordQualityRequirement |
decode(ASN1Element element)
Decodes the provided ASN.1 element as a password quality requirement. |
ASN1Element |
encode()
Encodes this password quality requirement to an ASN.1 element that may be included in LDAP protocol elements that may need to include it (e.g., a get password quality requirements extended response or a password validation details response control). |
java.util.Map<java.lang.String,java.lang.String> |
getClientSideValidationProperties()
Retrieves a set of properties that may be used in the course of performing client-side validation for a proposed password. |
java.lang.String |
getClientSideValidationType()
Retrieves a string that identifies the type of client-side validation that may be performed by applications in order to identify potential problems with a proposed password before sending it to the server. |
java.lang.String |
getDescription()
Retrieves a user-friendly description of the constraints that a proposed password must satisfy in order to meet this requirement and be accepted by the server. |
java.lang.String |
toString()
Retrieves a string representation of this password quality requirement. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this password quality requirement to the provided buffer. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public PasswordQualityRequirement(java.lang.String description)
description
- A user-friendly description of the constraints that a
proposed password must satisfy in order to meet this
requirement and be accepted by the server. This must
not be null
.public PasswordQualityRequirement(java.lang.String description, java.lang.String clientSideValidationType, java.util.Map<java.lang.String,java.lang.String> clientSideValidationProperties)
description
- A user-friendly description of the
constraints that a proposed
password must satisfy in order to
meet this requirement and be
accepted by the server. This must
not be null
.clientSideValidationType
- An optional string that identifies
the type of validation associated
with this requirement.
Applications that support
client-side validation and
recognize this validation type can
attempt to use their own logic in
attempt to determine whether a
proposed password may be rejected
by the server because it does not
satisfy this requirement. This may
be null
if no client-side
validation is available for this
requirement.clientSideValidationProperties
- An optional map of property names
and values that may provide
additional information that can be
used for client-side validation.
The properties that may be included
depend on the validation type.
This must be empty or null
if the provided validation type is
null
. It may also be empty
or null
if no additional
properties are required for the
associated type of client-side
validation.Method Detail |
---|
public java.lang.String getDescription()
public java.lang.String getClientSideValidationType()
null
if client-side validation is not
supported for this password quality requirement.public java.util.Map<java.lang.String,java.lang.String> getClientSideValidationProperties()
public ASN1Element encode()
public static PasswordQualityRequirement decode(ASN1Element element) throws LDAPException
element
- The ASN.1 element to decode as a password quality
requirement. It must not be null
.
LDAPException
- If a problem was encountered while attempting to
decode the provided ASN.1 element as a password
quality requirement.public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer)
buffer
- The buffer to which the information should be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |