|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.ExtendedRequest
com.unboundid.ldap.sdk.extensions.WhoAmIExtendedRequest
@NotMutable @ThreadSafety(level=NOT_THREADSAFE) public final class WhoAmIExtendedRequest
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.
// 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? }
Field Summary | |
---|---|
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. |
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest |
---|
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE |
Constructor Summary | |
---|---|
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. |
Method Summary | |
---|---|
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. |
Methods inherited from class com.unboundid.ldap.sdk.ExtendedRequest |
---|
encodeProtocolOp, getLastMessageID, getOID, getOperationType, getProtocolOpType, getValue, hasValue, responseReceived, toCode, writeTo |
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest |
---|
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setResponseTimeoutMillis, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String WHO_AM_I_REQUEST_OID
Constructor Detail |
---|
public WhoAmIExtendedRequest()
public WhoAmIExtendedRequest(Control[] controls)
controls
- The set of controls to include in the request.public WhoAmIExtendedRequest(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.Method Detail |
---|
public WhoAmIExtendedResult process(LDAPConnection connection, int depth) throws LDAPException
process
in class ExtendedRequest
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.
LDAPException
- If a problem occurs while sending the request or
reading the response.public WhoAmIExtendedRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
public WhoAmIExtendedRequest duplicate(Control[] controls)
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
controls
- The set of controls to include in the duplicate request.
public java.lang.String getExtendedRequestName()
getExtendedRequestName
in class ExtendedRequest
public void toString(java.lang.StringBuilder buffer)
toString
in interface ProtocolOp
toString
in interface ReadOnlyLDAPRequest
toString
in class ExtendedRequest
buffer
- The buffer to which to append a string representation of
this request.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |