Class AccountUsableRequestControl

  • All Implemented Interfaces:
    java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class AccountUsableRequestControl
    extends Control
    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.
    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.

    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
    • 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.