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, operationID
LOCALBACKENDOPERATIONS
Constructor and Description |
---|
BindOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
org.forgerock.opendj.ldap.messages.BindRequest request)
Creates a new bind operation with the provided information.
|
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.
|
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.
|
org.forgerock.opendj.ldap.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.
|
org.forgerock.opendj.ldap.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.
|
org.forgerock.opendj.ldap.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(org.forgerock.opendj.ldap.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(org.forgerock.opendj.ldap.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, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
abort, 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, toString
addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, setErrorMessage
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getProcessingStartTime, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString
public 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, org.forgerock.opendj.ldap.messages.BindRequest request)
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.request
- The bind request.public org.forgerock.opendj.ldap.Dn getProxiedAuthorizationDN()
Operation
getProxiedAuthorizationDN
in interface Operation
null
if proxied
authorization has not been requested.public void setProxiedAuthorizationDN(org.forgerock.opendj.ldap.Dn proxiedAuthorizationDN)
Operation
setProxiedAuthorizationDN
in interface Operation
proxiedAuthorizationDN
- 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()
BindOperation
getAuthenticationType
in interface BindOperation
getAuthenticationType
in interface PreParseBindOperation
public final org.forgerock.opendj.ldap.ByteString getRawBindDN()
BindOperation
getRawBindDN
in interface BindOperation
getRawBindDN
in interface PreParseBindOperation
public final void setRawBindDN(org.forgerock.opendj.ldap.ByteString rawBindDN)
BindOperation
setRawBindDN
in interface BindOperation
setRawBindDN
in interface PreParseBindOperation
rawBindDN
- The raw, unprocessed bind DN for this bind operation.public final org.forgerock.opendj.ldap.Dn getBindDN()
BindOperation
getRawBindDN
method.getBindDN
in interface BindOperation
null
if the
raw DN has not yet been processed.public final org.forgerock.opendj.ldap.ByteString getSimplePassword()
BindOperation
getSimplePassword
in interface BindOperation
getSimplePassword
in interface PreParseBindOperation
public final void setSimplePassword(org.forgerock.opendj.ldap.ByteString simplePassword)
BindOperation
setSimplePassword
in interface BindOperation
setSimplePassword
in interface PreParseBindOperation
simplePassword
- The simple authentication password for this bind
operation.public final String getSASLMechanism()
BindOperation
getSASLMechanism
in interface BindOperation
getSASLMechanism
in interface PreParseBindOperation
null
if the bind does not use SASL authentication.public final org.forgerock.opendj.ldap.ByteString getSASLCredentials()
BindOperation
getSASLCredentials
in interface BindOperation
getSASLCredentials
in interface PreParseBindOperation
null
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)
BindOperation
setSASLCredentials
in interface BindOperation
setSASLCredentials
in interface PreParseBindOperation
saslMechanism
- 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()
BindOperation
getServerSASLCredentials
in interface BindOperation
null
if there are none.public final void setServerSASLCredentials(org.forgerock.opendj.ldap.ByteString serverSASLCredentials)
BindOperation
setServerSASLCredentials
in interface BindOperation
setServerSASLCredentials
in interface PreParseBindOperation
serverSASLCredentials
- The set of server SASL credentials to
include in the bind response.public final Entry getSASLAuthUserEntry()
BindOperation
getSASLAuthUserEntry
in interface BindOperation
null
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)
BindOperation
setSASLAuthUserEntry
in interface BindOperation
saslAuthUserEntry
- The user entry associated with the SASL
authentication attempt.public final LocalizableMessage getAuthFailureReason()
BindOperation
getAuthFailureReason
in interface BindOperation
null
if none is available.public final void setAuthFailureReason(LocalizableMessage message)
BindOperation
setAuthFailureReason
in interface BindOperation
setAuthFailureReason
in interface PreParseBindOperation
message
- providing the reason that the
authentication failed.public final org.forgerock.opendj.ldap.Dn getUserEntryDN()
BindOperation
getUserEntryDN
in interface BindOperation
null
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()
BindOperation
getAuthenticationInfo
in interface BindOperation
public final void setAuthenticationInfo(AuthenticationInfo authInfo)
BindOperation
processSASLBind
method.setAuthenticationInfo
in interface BindOperation
authInfo
- The authentication info that resulted from processing
this bind operation.public final OperationType getOperationType()
Operation
getOperationType
in interface Operation
getOperationType
in interface PluginOperation
public final List<Control> getResponseControls()
Operation
getResponseControls
in interface Operation
getResponseControls
in interface PluginOperation
public final void addResponseControl(Control control)
Operation
addResponseControl
in interface Operation
addResponseControl
in interface PreParseOperation
control
- The control to add to the set of controls to
include in the response to the client.public final void removeResponseControl(Control control)
Operation
removeResponseControl
in interface Operation
removeResponseControl
in interface PreParseOperation
control
- The control to remove from the set of controls
to include in the response to the client.public final void toString(StringBuilder buffer)
Operation
toString
in interface Operation
toString
in interface PluginOperation
buffer
- The buffer into which a string representation of
this operation should be appended.public void setUserEntryDN(org.forgerock.opendj.ldap.Dn userEntryDN)
BindOperation
setUserEntryDN
in interface BindOperation
userEntryDN
- 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()
BindOperation
getProtocolVersion
in interface BindOperation
getProtocolVersion
in interface PreParseBindOperation
public void setProtocolVersion(String protocolVersion)
BindOperation
setProtocolVersion
in interface BindOperation
setProtocolVersion
in interface PreParseBindOperation
protocolVersion
- The string representation of the protocol version
associated with this bind request.public final void run()
Operation
public void updateOperationErrMsgAndResCode()
AbstractOperation
updateOperationErrMsgAndResCode
in class AbstractOperation
Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.