com.unboundid.ldap.sdk.controls

Class AuthorizationIdentityResponseControl

java.lang.Object

com.unboundid.ldap.sdk.Control

com.unboundid.ldap.sdk.controls.AuthorizationIdentityResponseControl

All Implemented Interfaces:

DecodeableControl, java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class AuthorizationIdentityResponseControl
extends Control
implements DecodeableControl

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.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
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

Modifier and Type	Method and Description
AuthorizationIdentityResponseControl	decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) Creates a new instance of this decodeable control from the provided information.
static AuthorizationIdentityResponseControl	decodeJSONControl(JSONObject controlObject, boolean strict) Attempts to decode the provided object as a JSON representation of an authorization identity response control.
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.
JSONObject	toJSONControl() Retrieves a representation of this authorization identity response control as a JSON object.
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, decodeJSONControl, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

AUTHORIZATION_IDENTITY_RESPONSE_OID

@NotNull
public static final java.lang.String AUTHORIZATION_IDENTITY_RESPONSE_OID

The OID (2.16.840.1.113730.3.4.15) for the authorization identity response control.

See Also:

Constant Field Values

Constructor Detail

AuthorizationIdentityResponseControl

public AuthorizationIdentityResponseControl(@NotNull
                                            java.lang.String authorizationID)

Creates a new authorization identity response control with the provided authorization ID.

Parameters:

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.

AuthorizationIdentityResponseControl

public AuthorizationIdentityResponseControl(@NotNull
                                            java.lang.String oid,
                                            boolean isCritical,
                                            @Nullable
                                            ASN1OctetString value)
                                     throws LDAPException

Creates a new authorization identity response control with the provided information.

Parameters:

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.

Throws:

LDAPException - If the provided control cannot be decoded as an authorization identity response control.

Method Detail

decodeControl

@NotNull
public AuthorizationIdentityResponseControl decodeControl(@NotNull
                                                                   java.lang.String oid,
                                                                   boolean isCritical,
                                                                   @Nullable
                                                                   ASN1OctetString value)
                                                            throws LDAPException

Creates a new instance of this decodeable control from the provided information.

Specified by:

decodeControl in interface DecodeableControl

Parameters:

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.

Returns:

The decoded representation of this control.

Throws:

LDAPException - If the provided information cannot be decoded as a valid instance of this decodeable control.

get

@Nullable
public static AuthorizationIdentityResponseControl get(@NotNull
                                                                 BindResult result)
                                                          throws LDAPException

Extracts an authorization identity response control from the provided result.

Parameters:

result - The result from which to retrieve the authorization identity response control.

Returns:

The authorization identity response control contained in the provided result, or null if the result did not contain an authorization identity response control.

Throws:

LDAPException - If a problem is encountered while attempting to decode the authorization identity response control contained in the provided result.

getAuthorizationID

@NotNull
public java.lang.String getAuthorizationID()

Retrieves the authorization ID string for this authorization identity response control. It may be a zero-length string if the associated authorization identity is that of the anonymous user.

Returns:

The authorization ID string for this authorization identity response control.

getControlName

@NotNull
public java.lang.String getControlName()

Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.

Overrides:

getControlName in class Control

Returns:

The user-friendly name for this control, or the OID if no user-friendly name is available.

toJSONControl

@NotNull
public JSONObject toJSONControl()

Retrieves a representation of this authorization identity response control as a JSON object. The JSON object uses the following fields:

• oid -- A mandatory string field whose value is the object identifier for this control. For the authorization identity response control, the OID is "2.16.840.1.113730.3.4.15".
• control-name -- An optional string field whose value is a human-readable name for this control. This field is only intended for descriptive purposes, and when decoding a control, the oid field should be used to identify the type of control.
• criticality -- A mandatory Boolean field used to indicate whether this control is considered critical.
• value-base64 -- An optional string field whose value is a base64-encoded representation of the raw value for this authorization identity response control. Exactly one of the value-base64 and value-json fields must be present.
• value-json -- An optional JSON object field whose value is a user-friendly representation of the value for this authorization identity response control. Exactly one of the value-base64 and value-json fields must be present, and if the value-json field is used, then it will use the following fields:
  • authorization-id -- A string field whose value is the authorization identity assigned during the bind operation.

Overrides:

toJSONControl in class Control

Returns:

A JSON object that contains a representation of this control.

decodeJSONControl

@NotNull
public static AuthorizationIdentityResponseControl decodeJSONControl(@NotNull
                                                                              JSONObject controlObject,
                                                                              boolean strict)
                                                                       throws LDAPException

Attempts to decode the provided object as a JSON representation of an authorization identity response control.

Parameters:

controlObject - The JSON object to be decoded. It must not be null.

strict - Indicates whether to use strict mode when decoding the provided JSON object. If this is true, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this is false, then unrecognized fields will be ignored.

Returns:

The authorization identity response control that was decoded from the provided JSON object.

Throws:

LDAPException - If the provided JSON object cannot be parsed as a valid authorization identity response control.

toString

public void toString(@NotNull
                     java.lang.StringBuilder buffer)

Appends a string representation of this LDAP control to the provided buffer.

Overrides:

toString in class Control

Parameters:

buffer - The buffer to which to append the string representation of this buffer.