com.unboundid.ldap.sdk.unboundidds.controls
Class GetAuthorizationEntryResponseControl

java.lang.Object
  extended by com.unboundid.ldap.sdk.Control
      extended by com.unboundid.ldap.sdk.unboundidds.controls.GetAuthorizationEntryResponseControl
All Implemented Interfaces:
DecodeableControl, java.io.Serializable

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

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class provides an implementation of an LDAP control that may be included in a bind response to provide information about the authenticated and/or authorized user. The value of this control will be encoded as follows:
   GetAuthorizationEntryResponse ::= SEQUENCE {
     isAuthenticated     [0] BOOLEAN,
     identitiesMatch     [1] BOOLEAN,
     authNEntry          [2] AuthEntry OPTIONAL,
     authZEntry          [3] AuthEntry OPTIONAL }

   AuthEntry ::= SEQUENCE {
     authID         [0] AuthzId OPTIONAL,
     authDN         [1] LDAPDN,
     attributes     [2] PartialAttributeList }
 


See the documentation for the GetAuthorizationEntryRequestControl class for more information and an example demonstrating the use of these controls.

See Also:
Serialized Form

Field Summary
static java.lang.String GET_AUTHORIZATION_ENTRY_RESPONSE_OID
          The OID (1.3.6.1.4.1.30221.2.5.6) for the get authorization entry response control.
 
Constructor Summary
GetAuthorizationEntryResponseControl(boolean isAuthenticated, boolean identitiesMatch, java.lang.String authNID, ReadOnlyEntry authNEntry, java.lang.String authZID, ReadOnlyEntry authZEntry)
          Creates a new get authorization entry response control with the provided information.
GetAuthorizationEntryResponseControl(java.lang.String oid, boolean isCritical, ASN1OctetString value)
          Creates a new get authorization entry response control with the provided information.
 
Method Summary
 GetAuthorizationEntryResponseControl decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value)
          Creates a new instance of this decodeable control from the provided information.
static GetAuthorizationEntryResponseControl get(BindResult result)
          Extracts a get authorization entry response control from the provided result.
 ReadOnlyEntry getAuthNEntry()
          Retrieves the entry for the user specified as the authentication identity, if it is available.
 java.lang.String getAuthNID()
          Retrieves the identifier that may be used to reference the authentication identity in the directory server, if it is available.
 ReadOnlyEntry getAuthZEntry()
          Retrieves the entry for the user specified as the authorization identity, if it is available.
 java.lang.String getAuthZID()
          Retrieves the identifier that may be used to reference the authorization identity in the directory server, if it is available.
 java.lang.String getControlName()
          Retrieves the user-friendly name for this control, if available.
 boolean identitiesMatch()
          Indicates whether the authentication identity and the authorization identity reference the same user.
 boolean isAuthenticated()
          Indicates whether the client is authenticated.
 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

GET_AUTHORIZATION_ENTRY_RESPONSE_OID

public static final java.lang.String GET_AUTHORIZATION_ENTRY_RESPONSE_OID
The OID (1.3.6.1.4.1.30221.2.5.6) for the get authorization entry response control.

See Also:
Constant Field Values
Constructor Detail

GetAuthorizationEntryResponseControl

public GetAuthorizationEntryResponseControl(boolean isAuthenticated,
                                            boolean identitiesMatch,
                                            java.lang.String authNID,
                                            ReadOnlyEntry authNEntry,
                                            java.lang.String authZID,
                                            ReadOnlyEntry authZEntry)
Creates a new get authorization entry response control with the provided information.

Parameters:
isAuthenticated - Indicates whether the client is authenticated.
identitiesMatch - Indicates whether the authentication identity is the same as the authorization identity.
authNID - The string that may be used to reference the authentication identity. It may be null if information about the authentication identity is not to be included, or if the identifier should be derived from the DN.
authNEntry - The entry for the authentication identity. It may be null if the information about the authentication identity is not to be included.
authZID - The string that may be used to reference the authorization identity. It may be null if information about the authentication identity is not to be included, if the identifier should be derived from the DN, or if the authentication and authorization identities are the same.
authZEntry - The entry for the authentication identity. It may be null if the information about the authentication identity is not to be included, or if the authentication and authorization identities are the same.

GetAuthorizationEntryResponseControl

public GetAuthorizationEntryResponseControl(java.lang.String oid,
                                            boolean isCritical,
                                            ASN1OctetString value)
                                     throws LDAPException
Creates a new get authorization entry 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 a get authorization entry response control.
Method Detail

decodeControl

public GetAuthorizationEntryResponseControl decodeControl(java.lang.String oid,
                                                          boolean isCritical,
                                                          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

public static GetAuthorizationEntryResponseControl get(BindResult result)
                                                throws LDAPException
Extracts a get authorization entry response control from the provided result.

Parameters:
result - The result from which to retrieve the get authorization entry response control.
Returns:
The get authorization entry response control contained in the provided result, or null if the result did not contain a get authorization entry response control.
Throws:
LDAPException - If a problem is encountered while attempting to decode the get authorization entry response control contained in the provided result.

isAuthenticated

public boolean isAuthenticated()
Indicates whether the client is authenticated.

Returns:
true if the client is authenticated, or false if not.

identitiesMatch

public boolean identitiesMatch()
Indicates whether the authentication identity and the authorization identity reference the same user.

Returns:
true if both the authentication identity and the authorization identity reference the same user, or false if not.

getAuthNID

public java.lang.String getAuthNID()
Retrieves the identifier that may be used to reference the authentication identity in the directory server, if it is available.

Returns:
The identifier that may be used to reference the authentication identity in the directory server, or null if it is not available.

getAuthNEntry

public ReadOnlyEntry getAuthNEntry()
Retrieves the entry for the user specified as the authentication identity, if it is available.

Returns:
The entry for the user specified as the authentication identity, or null if it is not available.

getAuthZID

public java.lang.String getAuthZID()
Retrieves the identifier that may be used to reference the authorization identity in the directory server, if it is available.

Returns:
The identifier that may be used to reference the authorization identity in the directory server, or null if it is not available.

getAuthZEntry

public ReadOnlyEntry getAuthZEntry()
Retrieves the entry for the user specified as the authorization identity, if it is available.

Returns:
The entry for the user specified as the authorization identity, or null if it is not available.

getControlName

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.

toString

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