|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.RetainIdentityRequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class RetainIdentityRequestControl
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.
ResultCode#SUCCESS
result code just as if the bind request had not included 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. }
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 |
---|
public static final java.lang.String RETAIN_IDENTITY_REQUEST_OID
Constructor Detail |
---|
public RetainIdentityRequestControl()
public RetainIdentityRequestControl(Control control) throws LDAPException
control
- The generic control to be decoded as a retain identity
request control.
LDAPException
- If the provided control cannot be decoded as a
retain identity request control.Method Detail |
---|
public java.lang.String getControlName()
getControlName
in class Control
public void toString(java.lang.StringBuilder buffer)
toString
in class Control
buffer
- The buffer to which to append the string representation of
this buffer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |