|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.experimental.DraftBeheraLDAPPasswordPolicy10ResponseControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class DraftBeheraLDAPPasswordPolicy10ResponseControl
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.
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 | |
---|---|
DraftBeheraLDAPPasswordPolicy10ResponseControl(DraftBeheraLDAPPasswordPolicy10WarningType warningType,
int warningValue,
DraftBeheraLDAPPasswordPolicy10ErrorType errorType)
Creates a new password policy response control with the provided information. |
|
DraftBeheraLDAPPasswordPolicy10ResponseControl(DraftBeheraLDAPPasswordPolicy10WarningType warningType,
int warningValue,
DraftBeheraLDAPPasswordPolicy10ErrorType errorType,
boolean isCritical)
Creates a new password policy response control with the provided information. |
|
DraftBeheraLDAPPasswordPolicy10ResponseControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new password policy response control with the provided information. |
Method Summary | |
---|---|
DraftBeheraLDAPPasswordPolicy10ResponseControl |
decodeControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new instance of this decodeable control from the provided information. |
static DraftBeheraLDAPPasswordPolicy10ResponseControl |
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. |
DraftBeheraLDAPPasswordPolicy10ErrorType |
getErrorType()
Retrieves the error type for this password policy response control, if available. |
DraftBeheraLDAPPasswordPolicy10WarningType |
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 |
---|
public static final java.lang.String PASSWORD_POLICY_RESPONSE_OID
Constructor Detail |
---|
public DraftBeheraLDAPPasswordPolicy10ResponseControl(DraftBeheraLDAPPasswordPolicy10WarningType warningType, int warningValue, DraftBeheraLDAPPasswordPolicy10ErrorType errorType)
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.public DraftBeheraLDAPPasswordPolicy10ResponseControl(DraftBeheraLDAPPasswordPolicy10WarningType warningType, int warningValue, DraftBeheraLDAPPasswordPolicy10ErrorType errorType, boolean isCritical)
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.public DraftBeheraLDAPPasswordPolicy10ResponseControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
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.
LDAPException
- If the provided control cannot be decoded as a
password policy response control.Method Detail |
---|
public DraftBeheraLDAPPasswordPolicy10ResponseControl decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
decodeControl
in interface DecodeableControl
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.
LDAPException
- If the provided information cannot be decoded as a
valid instance of this decodeable control.public static DraftBeheraLDAPPasswordPolicy10ResponseControl get(LDAPResult result) throws LDAPException
result
- The result from which to retrieve the password policy
response control.
null
if the result did not contain a password
policy response control.
LDAPException
- If a problem is encountered while attempting to
decode the password policy response control
contained in the provided result.public DraftBeheraLDAPPasswordPolicy10WarningType getWarningType()
null
if there is no warning type.public int getWarningValue()
public DraftBeheraLDAPPasswordPolicy10ErrorType getErrorType()
null
if there is no error type.public java.lang.String getControlName()
getControlName
in class Control
public void toString(java.lang.StringBuilder buffer)
toString
in class Control
buffer
- The buffer to which to append the string representation of
this buffer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |