@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class AccountUsableRequestControl extends Control
AccountUsableResponseControl
for information about the information
that is taken into account.
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.
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(); } }
Modifier and Type | Field and Description |
---|---|
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 and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo
@NotNull public static final java.lang.String ACCOUNT_USABLE_REQUEST_OID
public AccountUsableRequestControl()
public AccountUsableRequestControl(boolean isCritical)
isCritical
- Indicates whether this control should be marked
critical.public AccountUsableRequestControl(@NotNull 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.@NotNull public java.lang.String getControlName()
getControlName
in class Control