|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.controls.AuthorizationIdentityRequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class AuthorizationIdentityRequestControl
This class provides an implementation of the authorization identity bind
request control as described in
RFC 3829. It may be
included in a bind request to request that the server include the
authorization identity associated with the client connection in the bind
response message, in the form of an
AuthorizationIdentityResponseControl
.
The authorization identity request control is similar to the "Who Am I?"
extended request as implemented in the
WhoAmIExtendedRequest
class. The
primary difference between them is that the "Who Am I?" extended request can
be used at any time but requires a separate operation, while the
authorization identity request control can be included only with a bind
request but does not require a separate operation.
String authzID = null; BindRequest bindRequest = new SimpleBindRequest("uid=test.user,ou=People,dc=example,dc=com", "password", new AuthorizationIdentityRequestControl()); BindResult bindResult = connection.bind(bindRequest); AuthorizationIdentityResponseControl authzIdentityResponse = AuthorizationIdentityResponseControl.get(bindResult); if (authzIdentityResponse != null) { authzID = authzIdentityResponse.getAuthorizationID(); }
Field Summary | |
---|---|
static java.lang.String |
AUTHORIZATION_IDENTITY_REQUEST_OID
The OID (2.16.840.1.113730.3.4.16) for the authorization identity request control. |
Constructor Summary | |
---|---|
AuthorizationIdentityRequestControl()
Creates a new authorization identity request control. |
|
AuthorizationIdentityRequestControl(boolean isCritical)
Creates a new authorization identity request control. |
|
AuthorizationIdentityRequestControl(Control control)
Creates a new authorization identity 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 |
---|
public static final java.lang.String AUTHORIZATION_IDENTITY_REQUEST_OID
Constructor Detail |
---|
public AuthorizationIdentityRequestControl()
public AuthorizationIdentityRequestControl(boolean isCritical)
isCritical
- Indicates whether the control should be marked
critical.public AuthorizationIdentityRequestControl(Control control) throws LDAPException
control
- The generic control to be decoded as an authorization
identity request control.
LDAPException
- If the provided control cannot be decoded as an
authorization identity request control.Method Detail |
---|
public java.lang.String getControlName()
getControlName
in class Control
public void toString(java.lang.StringBuilder buffer)
toString
in class Control
buffer
- The buffer to which to append the string representation of
this buffer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |