org.opends.server.controls

Class AuthorizationIdentityResponseControl

java.lang.Object

org.opends.server.types.Control

org.opends.server.controls.AuthorizationIdentityResponseControl

public class AuthorizationIdentityResponseControl
extends Control

This class implements the authorization identity response control as defined in RFC 3829. It may be included in a bind response message to provide the authorization ID resulting for a client after the bind operation as completed.

Field Summary

Fields

Modifier and Type	Field and Description
static ControlDecoder<AuthorizationIdentityResponseControl>	DECODER The Control Decoder that can be used to decode this control.

Constructor Summary

Constructors

Constructor and Description
AuthorizationIdentityResponseControl() Creates a new authorization identity response control using the default settings to indicate an anonymous authentication.
AuthorizationIdentityResponseControl(boolean isCritical) Creates a new authorization identity response control using the default settings to indicate an anonymous authentication.
AuthorizationIdentityResponseControl(boolean isCritical, String authorizationID) Creates a new authorization identity response control with the provided information.
AuthorizationIdentityResponseControl(DN authorizationDN) Creates a new authorization identity response control with the provided information.
AuthorizationIdentityResponseControl(String authorizationID) Creates a new authorization identity response control with the provided information.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAuthorizationID() Retrieves the authorization ID for this authorization identity response control.
void	toString(StringBuilder buffer) Appends a string representation of this authorization identity response control to the provided buffer.
void	writeValue(org.forgerock.opendj.io.ASN1Writer writer) Writes this control's value to an ASN.1 writer.

Methods inherited from class org.opends.server.types.Control

getOID, isCritical, toString, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DECODER

public static final ControlDecoder<AuthorizationIdentityResponseControl> DECODER

The Control Decoder that can be used to decode this control.

Constructor Detail

AuthorizationIdentityResponseControl

public AuthorizationIdentityResponseControl()

Creates a new authorization identity response control using the default settings to indicate an anonymous authentication.

AuthorizationIdentityResponseControl

public AuthorizationIdentityResponseControl(boolean isCritical)

Creates a new authorization identity response control using the default settings to indicate an anonymous authentication.

Parameters:

isCritical - Indicates whether this control should be considered critical in processing the request.

AuthorizationIdentityResponseControl

public AuthorizationIdentityResponseControl(String authorizationID)

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

Parameters:

authorizationID - The authorization ID for this control.

AuthorizationIdentityResponseControl

public AuthorizationIdentityResponseControl(boolean isCritical,
                                    String authorizationID)

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

Parameters:

isCritical - Indicates whether this control should be considered critical in processing the request.

authorizationID - The authorization ID for this control.

AuthorizationIdentityResponseControl

public AuthorizationIdentityResponseControl(DN authorizationDN)

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

Parameters:

authorizationDN - The authorization DN for this control.

Method Detail

writeValue

public void writeValue(org.forgerock.opendj.io.ASN1Writer writer)
                throws IOException

Writes this control's value to an ASN.1 writer. The value (if any) must be written as an ASN1OctetString.

Specified by:

writeValue in class Control

Parameters:

writer - The ASN.1 output stream to write to.

Throws:

IOException - If a problem occurs while writing to the stream.

getAuthorizationID

public String getAuthorizationID()

Retrieves the authorization ID for this authorization identity response control.

Returns:

The authorization ID for this authorization identity response control.

toString

public void toString(StringBuilder buffer)

Appends a string representation of this authorization identity response control to the provided buffer.

Overrides:

toString in class Control

Parameters:

buffer - The buffer to which the information should be appended.