org.opends.server.controls
Class AuthorizationIdentityResponseControl

java.lang.Object
  extended by org.opends.server.types.Control
      extended by 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.


Constructor Summary
AuthorizationIdentityResponseControl()
          Creates a new authorization identity response control using the default settings to indicate an anonymous authentication.
AuthorizationIdentityResponseControl(DN authorizationDN)
          Creates a new authorization identity response control with the provided information.
AuthorizationIdentityResponseControl(java.lang.String authorizationID)
          Creates a new authorization identity response control with the provided information.
AuthorizationIdentityResponseControl(java.lang.String oid, boolean isCritical, DN authorizationDN)
          Creates a new authorization identity response control with the provided information.
AuthorizationIdentityResponseControl(java.lang.String oid, boolean isCritical, java.lang.String authorizationID)
          Creates a new authorization identity response control with the provided information.
 
Method Summary
static AuthorizationIdentityResponseControl decodeControl(Control control)
          Creates a new authorization identity response control from the contents of the provided control.
 java.lang.String getAuthorizationID()
          Retrieves the authorization ID for this authorization identity response control.
 void setAuthorizationID(java.lang.String authorizationID)
          Specifies the authorization ID for this authorization identity response control.
 java.lang.String toString()
          Retrieves a string representation of this authorization identity response control.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this authorization identity response control to the provided buffer.
 
Methods inherited from class org.opends.server.types.Control
getOID, getValue, hasValue, isCritical, setCritical, setOID, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AuthorizationIdentityResponseControl

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


AuthorizationIdentityResponseControl

public AuthorizationIdentityResponseControl(java.lang.String authorizationID)
Creates a new authorization identity response control with the provided information.

Parameters:
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.

AuthorizationIdentityResponseControl

public AuthorizationIdentityResponseControl(java.lang.String oid,
                                            boolean isCritical,
                                            java.lang.String authorizationID)
Creates a new authorization identity response control with the provided information.

Parameters:
oid - The OID to use for this control.
isCritical - Indicates whether this control should be considered a critical part of the response processing.
authorizationID - The authorization ID for this control.

AuthorizationIdentityResponseControl

public AuthorizationIdentityResponseControl(java.lang.String oid,
                                            boolean isCritical,
                                            DN authorizationDN)
Creates a new authorization identity response control with the provided information.

Parameters:
oid - The OID to use for this control.
isCritical - Indicates whether this control should be considered a critical part of the response processing.
authorizationDN - The authorization DN for this control.
Method Detail

decodeControl

public static AuthorizationIdentityResponseControl decodeControl(Control control)
                                                          throws LDAPException
Creates a new authorization identity response control from the contents of the provided control.

Parameters:
control - The generic control containing the information to use to create this authorization identity response control.
Returns:
The authorization identity response control decoded from the provided control.
Throws:
LDAPException - If this control cannot be decoded as a valid authorization identity response control.

getAuthorizationID

public java.lang.String getAuthorizationID()
Retrieves the authorization ID for this authorization identity response control.

Returns:
The authorization ID for this authorization identity response control.

setAuthorizationID

public void setAuthorizationID(java.lang.String authorizationID)
Specifies the authorization ID for this authorization identity response control.

Parameters:
authorizationID - The authorization ID for this authorization identity response control.

toString

public java.lang.String toString()
Retrieves a string representation of this authorization identity response control.

Overrides:
toString in class Control
Returns:
A string representation of this authorization identity response control.

toString

public void toString(java.lang.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.