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

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

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class RetainIdentityRequestControl
extends Control

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 defines a request control that may be used to indicate that the server should process all aspects of the associated bind request (including password policy processing) but should not actually change the identity for the client connection, regardless of whether the authentication is successful.

This control can be very useful for applications that perform binds to authenticate users but also use connection pooling to re-use connections for multiple operations. Bind operations are normally not well-suited for use on pooled connections because they change the identity of that connection, but the retain identity request control solves that problem by performing all bind processing but does not change the identity associated with the client connection.

There is no corresponding response control. If the bind is successful, then the server should return a bind response with the ResultCode#SUCCESS result code just as if the bind request had not included the retain identity request control.

This control is not based on any public standard. It was originally developed for use with the UnboundID Directory Server. It does not have a value.

Example

The following example demonstrates the use of the retain identity request control:
 SimpleBindRequest bindRequest = new SimpleBindRequest(
      "uid=john.doe,ou=People,dc=example,dc=com", "password",
      new RetainIdentityRequestControl());

 BindResult bindResult;
 try
 {
   bindResult = connection.bind(bindRequest);
   // The bind was successful and the account is usable, but the identity
   // associated with the client connection hasn't changed.
 }
 catch (LDAPException le)
 {
   bindResult = new BindResult(le.toLDAPResult());
   // The bind was unsuccessful, potentially because the credentials were
   // invalid or the account is unusable for some reason (e.g., disabled,
   // locked, expired password, etc.).  The identity associated with the
   // client connection hasn't changed.
 }
 

See Also:
Serialized Form

Field Summary
static java.lang.String RETAIN_IDENTITY_REQUEST_OID
          The OID (1.3.6.1.4.1.30221.2.5.3) for the retain identity request control.
 
Constructor Summary
RetainIdentityRequestControl()
          Creates a new retain identity request control.
RetainIdentityRequestControl(Control control)
          Creates a new retain identity request control which is decoded from the provided generic control.
 
Method Summary
 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

RETAIN_IDENTITY_REQUEST_OID

public static final java.lang.String RETAIN_IDENTITY_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.3) for the retain identity request control.

See Also:
Constant Field Values
Constructor Detail

RetainIdentityRequestControl

public RetainIdentityRequestControl()
Creates a new retain identity request control. It will be marked critical.


RetainIdentityRequestControl

public RetainIdentityRequestControl(Control control)
                             throws LDAPException
Creates a new retain identity request control which is decoded from the provided generic control.

Parameters:
control - The generic control to be decoded as a retain identity request control.
Throws:
LDAPException - If the provided control cannot be decoded as a retain identity request control.
Method Detail

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.