public class BindOperationBasis extends AbstractOperation implements BindOperation, PreParseBindOperation
setAuthFailureReason method, which
can provide a reason for a failure in a form that will not be returned to the
client but may be written to a log file.cancelRequest, cancelResult, clientConnection, messageID, NO_RESPONSE_CONTROLS, operationIDLOCALBACKENDOPERATIONS| Constructor and Description |
|---|
BindOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
List<Control> requestControls,
String protocolVersion,
org.forgerock.opendj.ldap.ByteString rawBindDN,
org.forgerock.opendj.ldap.ByteString simplePassword)
Creates a new simple bind operation with the provided information.
|
BindOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
List<Control> requestControls,
String protocolVersion,
org.forgerock.opendj.ldap.ByteString rawBindDN,
String saslMechanism,
org.forgerock.opendj.ldap.ByteString saslCredentials)
Creates a new SASL bind operation with the provided information.
|
BindOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
List<Control> requestControls,
String protocolVersion,
DN bindDN,
org.forgerock.opendj.ldap.ByteString simplePassword)
Creates a new simple bind operation with the provided information.
|
BindOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
List<Control> requestControls,
String protocolVersion,
DN bindDN,
String saslMechanism,
org.forgerock.opendj.ldap.ByteString saslCredentials)
Creates a new SASL bind operation with the provided information.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addResponseControl(Control control)
Adds the provided control to the set of controls to include in
the response to the client.
|
AuthenticationInfo |
getAuthenticationInfo()
Retrieves the authentication info that resulted from processing this bind
operation.
|
AuthenticationType |
getAuthenticationType()
Retrieves the authentication type for this bind operation.
|
LocalizableMessage |
getAuthFailureReason()
Retrieves a human-readable message providing the reason that the
authentication failed, if available.
|
DN |
getBindDN()
Retrieves the bind DN for this bind operation.
|
OperationType |
getOperationType()
Retrieves the operation type for this operation.
|
String |
getProtocolVersion()
Retrieves a string representation of the protocol version associated with
this bind request.
|
DN |
getProxiedAuthorizationDN()
Retrieves the proxied authorization DN for this operation if proxied
authorization has been requested.
|
org.forgerock.opendj.ldap.ByteString |
getRawBindDN()
Retrieves the raw, unprocessed bind DN for this bind operation as contained
in the client request.
|
List<Control> |
getResponseControls()
Retrieves the set of controls to include in the response to the
client.
|
Entry |
getSASLAuthUserEntry()
Retrieves the user entry associated with the SASL authentication attempt.
|
org.forgerock.opendj.ldap.ByteString |
getSASLCredentials()
Retrieves the SASL credentials for this bind operation.
|
String |
getSASLMechanism()
Retrieves the SASL mechanism for this bind operation.
|
org.forgerock.opendj.ldap.ByteString |
getServerSASLCredentials()
Retrieves the set of server SASL credentials to include in the bind
response.
|
org.forgerock.opendj.ldap.ByteString |
getSimplePassword()
Retrieves the simple authentication password for this bind operation.
|
DN |
getUserEntryDN()
Retrieves the user entry DN for this bind operation.
|
void |
removeResponseControl(Control control)
Removes the provided control from the set of controls to include
in the response to the client.
|
void |
run()
Performs the work of actually processing this operation.
|
void |
setAuthenticationInfo(AuthenticationInfo authInfo)
Specifies the authentication info that resulted from processing this bind
operation.
|
void |
setAuthFailureReason(LocalizableMessage message)
Specifies the reason that the authentication failed.
|
void |
setProtocolVersion(String protocolVersion)
Specifies the string representation of the protocol version associated with
this bind request.
|
void |
setProxiedAuthorizationDN(DN proxiedAuthorizationDN)
Set the proxied authorization DN for this operation if proxied
authorization has been requested.
|
void |
setRawBindDN(org.forgerock.opendj.ldap.ByteString rawBindDN)
Specifies the raw, unprocessed bind DN for this bind operation.
|
void |
setSASLAuthUserEntry(Entry saslAuthUserEntry)
Specifies the user entry associated with the SASL authentication attempt.
|
void |
setSASLCredentials(String saslMechanism,
org.forgerock.opendj.ldap.ByteString saslCredentials)
Specifies the SASL credentials for this bind operation.
|
void |
setServerSASLCredentials(org.forgerock.opendj.ldap.ByteString serverSASLCredentials)
Specifies the set of server SASL credentials to include in the bind
response.
|
void |
setSimplePassword(org.forgerock.opendj.ldap.ByteString simplePassword)
Specifies the simple authentication password for this bind operation.
|
void |
setUserEntryDN(DN userEntryDN)
Set the user entry DN for this bind operation.
|
void |
toString(StringBuilder buffer)
Appends a string representation of this operation to the provided
buffer.
|
void |
updateOperationErrMsgAndResCode()
Updates the error message and the result code of the operation.
|
abort, addAdditionalLogItem, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, equals, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResultCode, hashCode, invokePostResponseCallbacks, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, processOperationResult, processOperationResult, registerPostResponseCallback, removeAttachment, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setProcessingStartTime, setProcessingStopTime, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, toStringclone, finalize, getClass, notify, notifyAll, wait, wait, waitabort, addAdditionalLogItem, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResultCode, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, registerPostResponseCallback, removeAttachment, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, toStringaddAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, setErrorMessagecheckIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getProcessingStartTime, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toStringpublic BindOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, String protocolVersion, org.forgerock.opendj.ldap.ByteString rawBindDN, org.forgerock.opendj.ldap.ByteString simplePassword)
clientConnection - The client connection with which this operation
is associated.operationID - The operation ID for this operation.messageID - The message ID of the request with which this
operation is associated.requestControls - The set of controls included in the request.protocolVersion - The string representation of the protocol version
associated with this bind request.rawBindDN - The raw, unprocessed bind DN as provided in the
request from the client.simplePassword - The password to use for the simple
authentication.public BindOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, String protocolVersion, org.forgerock.opendj.ldap.ByteString rawBindDN, String saslMechanism, org.forgerock.opendj.ldap.ByteString saslCredentials)
clientConnection - The client connection with which this operation
is associated.operationID - The operation ID for this operation.messageID - The message ID of the request with which this
operation is associated.requestControls - The set of controls included in the request.protocolVersion - The string representation of the protocol version
associated with this bind request.rawBindDN - The raw, unprocessed bind DN as provided in the
request from the client.saslMechanism - The SASL mechanism included in the request.saslCredentials - The optional SASL credentials included in the
request.public BindOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, String protocolVersion, DN bindDN, org.forgerock.opendj.ldap.ByteString simplePassword)
clientConnection - The client connection with which this operation
is associated.operationID - The operation ID for this operation.messageID - The message ID of the request with which this
operation is associated.requestControls - The set of controls included in the request.protocolVersion - The string representation of the protocol version
associated with this bind request.bindDN - The bind DN for this bind operation.simplePassword - The password to use for the simple
authentication.public BindOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, String protocolVersion, DN bindDN, String saslMechanism, org.forgerock.opendj.ldap.ByteString saslCredentials)
clientConnection - The client connection with which this operation
is associated.operationID - The operation ID for this operation.messageID - The message ID of the request with which this
operation is associated.requestControls - The set of controls included in the request.protocolVersion - The string representation of the protocol version
associated with this bind request.bindDN - The bind DN for this bind operation.saslMechanism - The SASL mechanism included in the request.saslCredentials - The optional SASL credentials included in the
request.public DN getProxiedAuthorizationDN()
getProxiedAuthorizationDN in interface Operationnull if proxied
authorization has not been requested.public void setProxiedAuthorizationDN(DN proxiedAuthorizationDN)
setProxiedAuthorizationDN in interface OperationproxiedAuthorizationDN - The proxied authorization DN for this operation if proxied
authorization has been requested, or null if proxied
authorization has not been requested.public final AuthenticationType getAuthenticationType()
getAuthenticationType in interface BindOperationgetAuthenticationType in interface PreParseBindOperationpublic final org.forgerock.opendj.ldap.ByteString getRawBindDN()
getRawBindDN in interface BindOperationgetRawBindDN in interface PreParseBindOperationpublic final void setRawBindDN(org.forgerock.opendj.ldap.ByteString rawBindDN)
setRawBindDN in interface BindOperationsetRawBindDN in interface PreParseBindOperationrawBindDN - The raw, unprocessed bind DN for this bind operation.public final DN getBindDN()
getRawBindDN method.getBindDN in interface BindOperationnull if the
raw DN has not yet been processed.public final org.forgerock.opendj.ldap.ByteString getSimplePassword()
getSimplePassword in interface BindOperationgetSimplePassword in interface PreParseBindOperationpublic final void setSimplePassword(org.forgerock.opendj.ldap.ByteString simplePassword)
setSimplePassword in interface BindOperationsetSimplePassword in interface PreParseBindOperationsimplePassword - The simple authentication password for this bind
operation.public final String getSASLMechanism()
getSASLMechanism in interface BindOperationgetSASLMechanism in interface PreParseBindOperationnull
if the bind does not use SASL authentication.public final org.forgerock.opendj.ldap.ByteString getSASLCredentials()
getSASLCredentials in interface BindOperationgetSASLCredentials in interface PreParseBindOperationnull
if there are none or if the bind does not use SASL authentication.public final void setSASLCredentials(String saslMechanism, org.forgerock.opendj.ldap.ByteString saslCredentials)
setSASLCredentials in interface BindOperationsetSASLCredentials in interface PreParseBindOperationsaslMechanism - The SASL mechanism for this bind operation.saslCredentials - The SASL credentials for this bind operation, or
null if there are none.public final org.forgerock.opendj.ldap.ByteString getServerSASLCredentials()
getServerSASLCredentials in interface BindOperationnull if there are none.public final void setServerSASLCredentials(org.forgerock.opendj.ldap.ByteString serverSASLCredentials)
setServerSASLCredentials in interface BindOperationsetServerSASLCredentials in interface PreParseBindOperationserverSASLCredentials - The set of server SASL credentials to
include in the bind response.public final Entry getSASLAuthUserEntry()
getSASLAuthUserEntry in interface BindOperationnull if it was not a SASL authentication or the SASL
processing was not able to map the request to a user.public final void setSASLAuthUserEntry(Entry saslAuthUserEntry)
setSASLAuthUserEntry in interface BindOperationsaslAuthUserEntry - The user entry associated with the SASL
authentication attempt.public final LocalizableMessage getAuthFailureReason()
getAuthFailureReason in interface BindOperationnull if none is available.public final void setAuthFailureReason(LocalizableMessage message)
setAuthFailureReason in interface BindOperationsetAuthFailureReason in interface PreParseBindOperationmessage - providing the reason that the
authentication failed.public final DN getUserEntryDN()
getUserEntryDN in interface BindOperationnull if
the bind processing has not progressed far enough to identify the
user or if the user DN could not be determined.public final AuthenticationInfo getAuthenticationInfo()
getAuthenticationInfo in interface BindOperationpublic final void setAuthenticationInfo(AuthenticationInfo authInfo)
processSASLBind method.setAuthenticationInfo in interface BindOperationauthInfo - The authentication info that resulted from processing
this bind operation.public final OperationType getOperationType()
getOperationType in interface OperationgetOperationType in interface PluginOperationpublic final List<Control> getResponseControls()
getResponseControls in interface OperationgetResponseControls in interface PluginOperationpublic final void addResponseControl(Control control)
addResponseControl in interface OperationaddResponseControl in interface PreParseOperationcontrol - The control to add to the set of controls to
include in the response to the client.public final void removeResponseControl(Control control)
removeResponseControl in interface OperationremoveResponseControl in interface PreParseOperationcontrol - The control to remove from the set of controls
to include in the response to the client.public final void toString(StringBuilder buffer)
toString in interface OperationtoString in interface PluginOperationbuffer - The buffer into which a string representation of
this operation should be appended.public void setUserEntryDN(DN userEntryDN)
setUserEntryDN in interface BindOperationuserEntryDN - The user entry DN for this bind operation, or
null if the bind processing has not
progressed far enough to identify the user or if
the user DN could not be determined.public String getProtocolVersion()
getProtocolVersion in interface BindOperationgetProtocolVersion in interface PreParseBindOperationpublic void setProtocolVersion(String protocolVersion)
setProtocolVersion in interface BindOperationsetProtocolVersion in interface PreParseBindOperationprotocolVersion - The string representation of the protocol version
associated with this bind request.public final void run()
public void updateOperationErrMsgAndResCode()
updateOperationErrMsgAndResCode in class AbstractOperationCopyright © 2010-2015 ForgeRock AS. All Rights Reserved.