Package com.unboundid.ldap.sdk.extensions

Class WhoAmIExtendedRequest

java.lang.Object
com.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.ExtendedRequest
com.unboundid.ldap.sdk.extensions.WhoAmIExtendedRequest
All Implemented Interfaces:
ProtocolOp, ReadOnlyLDAPRequest, Serializable
@NotMutable @ThreadSafety(level=NOT_THREADSAFE) public final class WhoAmIExtendedRequest extends ExtendedRequest
This class provides an implementation of the LDAP "Who Am I?" extended request as defined in RFC 4532. It may be used to request the current authorization identity associated with the client connection.

The "Who Am I?" extended operation is similar to the AuthorizationIdentityRequestControl in that it can be used to request the authorization identity for the connection. The primary difference between them is that the authorization identity request control can only be included in a bind request (and the corresponding response control will be included in the bind result), while the "Who Am I?" extended operation can be used at any time through a separate operation.

Example

The following example demonstrates the use of the "Who Am I?" extended operation. 
 // Use the "Who Am I?" extended request to determine the identity of the
 // currently-authenticated user.
 WhoAmIExtendedResult whoAmIResult;
 try
 {
   whoAmIResult = (WhoAmIExtendedResult)
        connection.processExtendedOperation(new WhoAmIExtendedRequest());
   // This doesn't necessarily mean that the operation was successful, since
   // some kinds of extended operations return non-success results under
   // normal conditions.
 }
 catch (LDAPException le)
 {
   // For an extended operation, this generally means that a problem was
   // encountered while trying to send the request or read the result.
   whoAmIResult = new WhoAmIExtendedResult(new ExtendedResult(le));
 }

 LDAPTestUtils.assertResultCodeEquals(whoAmIResult, ResultCode.SUCCESS);
 String authzID = whoAmIResult.getAuthorizationID();
 if (authzID.equals("") || authzID.equals("dn:"))
 {
   // The user is authenticated anonymously.
 }
 else if (authzID.startsWith("dn:"))
 {
   // The DN of the authenticated user should be authzID.substring(3)
 }
 else if (authzID.startsWith("u:"))
 {
   // The username of the authenticated user should be authzID.substring(2)
 }
 else
 {
   // The authorization ID isn't in any recognizable format.  Perhaps it's
   // a raw DN or a username?
 }
See Also:

  • Field Details

  • Constructor Details

    • WhoAmIExtendedRequest

      public WhoAmIExtendedRequest()
      Creates a new "Who Am I?" extended request.

    • WhoAmIExtendedRequest

      public WhoAmIExtendedRequest(@Nullable Control[] controls)
      Creates a new "Who Am I?" extended request.
      Parameters:
      controls - The set of controls to include in the request.

    • WhoAmIExtendedRequest

      public WhoAmIExtendedRequest(@NotNull ExtendedRequest extendedRequest) throws LDAPException
      Creates a new "Who Am I?" extended request from the provided generic extended request.
      Parameters:
      extendedRequest - The generic extended request to use to create this "Who Am I?" extended request.
      Throws:
      LDAPException - If a problem occurs while decoding the request.

  • Method Details

    • process

      @NotNull public WhoAmIExtendedResult process(@NotNull LDAPConnection connection, int depth) throws LDAPException
      Sends this extended request to the directory server over the provided connection and returns the associated response.
      Overrides:
      process in class ExtendedRequest
      Parameters:
      connection - The connection to use to communicate with the directory server.
      depth - The current referral depth for this request. It should always be one for the initial request, and should only be incremented when following referrals.
      Returns:
      An LDAP result object that provides information about the result of the extended operation processing.
      Throws:
      LDAPException - If a problem occurs while sending the request or reading the response.

    • duplicate

      @NotNull public WhoAmIExtendedRequest duplicate()
      Creates a new instance of this LDAP request that may be modified without impacting this request.. Subclasses should override this method to return a duplicate of the appropriate type.
      Specified by:
      duplicate in interface ReadOnlyLDAPRequest
      Overrides:
      duplicate in class ExtendedRequest
      Returns:
      A new instance of this LDAP request that may be modified without impacting this request.

    • duplicate

      @NotNull public WhoAmIExtendedRequest duplicate(@Nullable Control[] controls)
      Creates a new instance of this LDAP request that may be modified without impacting this request. The provided controls will be used for the new request instead of duplicating the controls from this request.. Subclasses should override this method to return a duplicate of the appropriate type.
      Specified by:
      duplicate in interface ReadOnlyLDAPRequest
      Overrides:
      duplicate in class ExtendedRequest
      Parameters:
      controls - The set of controls to include in the duplicate request.
      Returns:
      A new instance of this LDAP request that may be modified without impacting this request.

    • getExtendedRequestName

      @NotNull public String getExtendedRequestName()
      Retrieves the user-friendly name for the extended request, if available. If no user-friendly name has been defined, then the OID will be returned.
      Overrides:
      getExtendedRequestName in class ExtendedRequest
      Returns:
      The user-friendly name for this extended request, or the OID if no user-friendly name is available.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this request to the provided buffer.
      Specified by:
      toString in interface ProtocolOp
      Specified by:
      toString in interface ReadOnlyLDAPRequest
      Overrides:
      toString in class ExtendedRequest
      Parameters:
      buffer - The buffer to which to append a string representation of this request.