|
|||||||||
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.unboundidds.controls.AccountUsableRequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class AccountUsableRequestControl
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 account usable request control. It may be included in search requests, in which case each search result entry matching that request should include the corresponding response control to obtain information about the usability of the user account associated with that entry. In particular, it indicates whether a bind with valid credentials would likely succeed and the resulting connection would be usable, and if not the reason for the potential failure. See the
AccountUsableResponseControl
for information about the information
that is taken into account.
SearchRequest searchRequest = new SearchRequest("dc=example,dc=com", SearchScope.SUB, Filter.createEqualityFilter("uid", "john.doe")); searchRequest.addControl(new AccountUsableRequestControl()); SearchResult searchResult = connection.search(searchRequest); boolean isUsable = false; for (SearchResultEntry entry : searchResult.getSearchEntries()) { AccountUsableResponseControl c = AccountUsableResponseControl.get(entry); isUsable = c.isUsable(); if (isUsable) { // The account is usable. } else { // The account is not usable. List<String> unusableReasons = c.getUnusableReasons(); } }
Field Summary | |
---|---|
static java.lang.String |
ACCOUNT_USABLE_REQUEST_OID
The OID (1.3.6.1.4.1.42.2.27.9.5.8) for the account usable request control. |
Constructor Summary | |
---|---|
AccountUsableRequestControl()
Creates a new account usable request control. |
|
AccountUsableRequestControl(boolean isCritical)
Creates a new account usable request control with the specified criticality. |
|
AccountUsableRequestControl(Control control)
Creates a new account usable request control which is decoded from the provided generic control. |
Method Summary | |
---|---|
java.lang.String |
getControlName()
Retrieves the user-friendly name for this 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 ACCOUNT_USABLE_REQUEST_OID
Constructor Detail |
---|
public AccountUsableRequestControl()
public AccountUsableRequestControl(boolean isCritical)
isCritical
- Indicates whether this control should be marked
critical.public AccountUsableRequestControl(Control control) throws LDAPException
control
- The generic control to be decoded as an account usable
request control.
LDAPException
- If the provided control cannot be decoded as an
account usable request control.Method Detail |
---|
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 |