|
|||||||||
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.AuthorizationIdentityResponseControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class AuthorizationIdentityResponseControl
This class provides an implementation of the authorization identity bind
response control as defined in
RFC 3829. It may be used
to provide the primary authorization identity associated with the client
connection after processing of the associated bind operation has completed.
The authorization identity value returned may be empty if the resulting
authorization identity is that of the anonymous user. Otherwise, it should
be an "authzId" value as described in section 5.2.1.8 of
RFC 4513. That is, it
should be either "dn:" followed by the distinguished name of the target user,
or "u:" followed by the username.
Note that the authorization identity response control should only be included
in a bind response message if the corresponding request included the
AuthorizationIdentityRequestControl
, and only if the bind was
successful.
Field Summary | |
---|---|
static java.lang.String |
AUTHORIZATION_IDENTITY_RESPONSE_OID
The OID (2.16.840.1.113730.3.4.15) for the authorization identity response control. |
Constructor Summary | |
---|---|
AuthorizationIdentityResponseControl(java.lang.String authorizationID)
Creates a new authorization identity response control with the provided authorization ID. |
|
AuthorizationIdentityResponseControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new authorization identity response control with the provided information. |
Method Summary | |
---|---|
AuthorizationIdentityResponseControl |
decodeControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new instance of this decodeable control from the provided information. |
static AuthorizationIdentityResponseControl |
get(BindResult result)
Extracts an authorization identity response control from the provided result. |
java.lang.String |
getAuthorizationID()
Retrieves the authorization ID string for this authorization identity response control. |
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_RESPONSE_OID
Constructor Detail |
---|
public AuthorizationIdentityResponseControl(java.lang.String authorizationID)
authorizationID
- The authorization identity associated with the
client connection. It must not be null
,
although it may be a zero-length string to
indicate that the authorization identity is the
anonymous user.public AuthorizationIdentityResponseControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.
LDAPException
- If the provided control cannot be decoded as an
authorization identity response control.Method Detail |
---|
public AuthorizationIdentityResponseControl decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
decodeControl
in interface DecodeableControl
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.
LDAPException
- If the provided information cannot be decoded as a
valid instance of this decodeable control.public static AuthorizationIdentityResponseControl get(BindResult result) throws LDAPException
result
- The result from which to retrieve the authorization
identity response control.
null
if the result did not contain an
authorization identity response control.
LDAPException
- If a problem is encountered while attempting to
decode the authorization identity response control
contained in the provided result.public java.lang.String getAuthorizationID()
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 |