com.unboundid.ldap.sdk.unboundidds.controls
Class AccountUsableRequestControl

java.lang.Object
  extended by com.unboundid.ldap.sdk.Control
      extended by com.unboundid.ldap.sdk.unboundidds.controls.AccountUsableRequestControl
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class AccountUsableRequestControl
extends Control

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.

This control was designed by Sun Microsystems and is not based on any RFC or Internet draft. It does not include a value.

Example

The following example demonstrates the use of the account usable controls to determine whether the account for user with uid "john.doe" is usable:
 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();
   }
 }
 

See Also:
Serialized Form

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

ACCOUNT_USABLE_REQUEST_OID

public static final 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.

See Also:
Constant Field Values
Constructor Detail

AccountUsableRequestControl

public AccountUsableRequestControl()
Creates a new account usable request control. It will not be marked critical.


AccountUsableRequestControl

public AccountUsableRequestControl(boolean isCritical)
Creates a new account usable request control with the specified criticality.

Parameters:
isCritical - Indicates whether this control should be marked critical.

AccountUsableRequestControl

public AccountUsableRequestControl(Control control)
                            throws LDAPException
Creates a new account usable request control which is decoded from the provided generic control.

Parameters:
control - The generic control to be decoded as an account usable request control.
Throws:
LDAPException - If the provided control cannot be decoded as an account usable request control.
Method Detail

getControlName

public java.lang.String getControlName()
Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.

Overrides:
getControlName in class Control
Returns:
The user-friendly name for this control, or the OID if no user-friendly name is available.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided buffer.

Overrides:
toString in class Control
Parameters:
buffer - The buffer to which to append the string representation of this buffer.