com.unboundid.ldap.sdk.unboundidds.controls

Class RetainIdentityRequestControl

java.lang.Object

com.unboundid.ldap.sdk.Control

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

All Implemented Interfaces:

java.io.Serializable

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

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.

NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

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 Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 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

Fields

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

Constructors

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

Modifier and Type	Method and Description
static RetainIdentityRequestControl	decodeJSONControl(JSONObject controlObject, boolean strict) Attempts to decode the provided object as a JSON representation of a retain identity request control.
java.lang.String	getControlName() Retrieves the user-friendly name for this control, if available.
JSONObject	toJSONControl() Retrieves a representation of this retain identity request 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

RETAIN_IDENTITY_REQUEST_OID

@NotNull
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(@NotNull
                                    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

@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 retain identity request control as a JSON object. The JSON object uses the following fields (note that since this control does not have a value, neither the value-base64 nor value-json fields may be present):

• oid -- A mandatory string field whose value is the object identifier for this control. For the retain identity request control, the OID is "1.3.6.1.4.1.30221.2.5.3".
• 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.

Overrides:

toJSONControl in class Control

Returns:

A JSON object that contains a representation of this control.

decodeJSONControl

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

Attempts to decode the provided object as a JSON representation of a retain identity request 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 retain identity request control that was decoded from the provided JSON object.

Throws:

LDAPException - If the provided JSON object cannot be parsed as a valid retain identity request 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.