@NotMutable @ThreadSafety(level=NOT_THREADSAFE) public final class WhoAmIExtendedRequest extends ExtendedRequest
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.
// 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?
}
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
WHO_AM_I_REQUEST_OID
The OID (1.3.6.1.4.1.4203.1.11.3) for the "Who Am I?" extended request.
|
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE| Constructor and Description |
|---|
WhoAmIExtendedRequest()
Creates a new "Who Am I?" extended request.
|
WhoAmIExtendedRequest(Control[] controls)
Creates a new "Who Am I?" extended request.
|
WhoAmIExtendedRequest(ExtendedRequest extendedRequest)
Creates a new "Who Am I?" extended request from the provided generic
extended request.
|
| Modifier and Type | Method and Description |
|---|---|
WhoAmIExtendedRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without
impacting this request.
|
WhoAmIExtendedRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without
impacting this request.
|
java.lang.String |
getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available.
|
WhoAmIExtendedResult |
process(LDAPConnection connection,
int depth)
Sends this extended request to the directory server over the provided
connection and returns the associated response.
|
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer.
|
encodeProtocolOp, getLastMessageID, getOID, getOperationType, getProtocolOpType, getValue, hasValue, responseReceived, toCode, writeTofollowReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getReferralConnector, getReferralConnectorInternal, getReferralDepth, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setReferralDepth, setResponseTimeoutMillis, toString@NotNull public static final java.lang.String WHO_AM_I_REQUEST_OID
public WhoAmIExtendedRequest()
public WhoAmIExtendedRequest(@Nullable Control[] controls)
controls - The set of controls to include in the request.public WhoAmIExtendedRequest(@NotNull ExtendedRequest extendedRequest) throws LDAPException
extendedRequest - The generic extended request to use to create this
"Who Am I?" extended request.LDAPException - If a problem occurs while decoding the request.@NotNull public WhoAmIExtendedResult process(@NotNull LDAPConnection connection, int depth) throws LDAPException
process in class ExtendedRequestconnection - 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.LDAPException - If a problem occurs while sending the request or
reading the response.@NotNull public WhoAmIExtendedRequest duplicate()
duplicate in interface ReadOnlyLDAPRequestduplicate in class ExtendedRequest@NotNull public WhoAmIExtendedRequest duplicate(@Nullable Control[] controls)
duplicate in interface ReadOnlyLDAPRequestduplicate in class ExtendedRequestcontrols - The set of controls to include in the duplicate request.@NotNull public java.lang.String getExtendedRequestName()
getExtendedRequestName in class ExtendedRequestpublic void toString(@NotNull java.lang.StringBuilder buffer)
toString in interface ProtocolOptoString in interface ReadOnlyLDAPRequesttoString in class ExtendedRequestbuffer - The buffer to which to append a string representation of
this request.