public interface BindOperation extends Operation
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.Modifier and Type | Method and Description |
---|---|
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.
|
String |
getProtocolVersion()
Retrieves a string representation of the protocol version associated with this bind request.
|
ByteString |
getRawBindDN()
Retrieves the raw, unprocessed bind DN for this bind operation as contained in the client request.
|
Entry |
getSASLAuthUserEntry()
Retrieves the user entry associated with the SASL authentication attempt.
|
ByteString |
getSASLCredentials()
Retrieves the SASL credentials for this bind operation.
|
String |
getSASLMechanism()
Retrieves the SASL mechanism for this bind operation.
|
SaslServer |
getSaslServer()
Returns the
SaslServer to use by the underlying connection, or null if SASL integrity and/or
privacy protection must not be enabled. |
ByteString |
getServerSASLCredentials()
Retrieves the set of server SASL credentials to include in the bind response.
|
ByteString |
getSimplePassword()
Retrieves the simple authentication password for this bind operation.
|
Dn |
getUserEntryDN()
Retrieves the user entry DN for this bind 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 |
setRawBindDN(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,
ByteString saslCredentials)
Specifies the SASL credentials for this bind operation.
|
void |
setSaslServer(SaslServer saslServer)
Sets the SASL server.
|
void |
setServerSASLCredentials(ByteString serverSASLCredentials)
Specifies the set of server SASL credentials to include in the bind response.
|
void |
setSimplePassword(ByteString simplePassword)
Specifies the simple authentication password for this bind operation.
|
void |
setUserEntryDN(Dn userEntryDN)
Set the user entry DN for this bind operation.
|
addAdditionalLogItem, addRequestControl, addResponseControl, appendErrorMessage, appendMaskedErrorMessage, disconnectClient, dontSynchronize, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getContext, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getOperationType, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getProxiedAuthorizationDN, getReferralURLs, getRequestControl, getRequestControls, getResponseControls, getResultCode, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, registerPostResponseCallback, removeAttachment, removeResponseControl, run, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setProxiedAuthorizationDN, setReferralURLs, setResponseData, setResult, setResultCode, setSynchronizationOperation, toString, toString
AuthenticationType getAuthenticationType()
ByteString getRawBindDN()
void setRawBindDN(ByteString rawBindDN)
rawBindDN
- The raw, unprocessed bind DN for this bind operation.String getProtocolVersion()
void setProtocolVersion(String protocolVersion)
protocolVersion
- The string representation of the protocol version associated with this bind request.Dn getBindDN()
getRawBindDN
method.null
if the raw DN has not yet been processed.ByteString getSimplePassword()
void setSimplePassword(ByteString simplePassword)
simplePassword
- The simple authentication password for this bind operation.String getSASLMechanism()
null
if the bind does not use SASL
authentication.ByteString getSASLCredentials()
null
if there are none or if the bind does
not use SASL authentication.void setSASLCredentials(String saslMechanism, ByteString saslCredentials)
saslMechanism
- The SASL mechanism for this bind operation.saslCredentials
- The SASL credentials for this bind operation, or null
if there are none.ByteString getServerSASLCredentials()
null
if there are
none.void setServerSASLCredentials(ByteString serverSASLCredentials)
serverSASLCredentials
- The set of server SASL credentials to include in the bind response.Entry getSASLAuthUserEntry()
null
if it was not a SASL
authentication or the SASL processing was not able to map the request to a user.void setSASLAuthUserEntry(Entry saslAuthUserEntry)
saslAuthUserEntry
- The user entry associated with the SASL authentication attempt.LocalizableMessage getAuthFailureReason()
null
if
none is available.void setAuthFailureReason(LocalizableMessage message)
message
- providing the reason that the authentication failed.Dn getUserEntryDN()
null
if the bind processing has not progressed
far enough to identify the user or if the user DN could not be determined.AuthenticationInfo getAuthenticationInfo()
SaslServer getSaslServer()
SaslServer
to use by the underlying connection, or null
if SASL integrity and/or
privacy protection must not be enabled.SaslServer
to use by the underlying connection, or null
if SASL integrity and/or
privacy protection must not enabled.void setAuthenticationInfo(AuthenticationInfo authInfo)
processSASLBind
method.authInfo
- The authentication info that resulted from processing this bind operation.void setUserEntryDN(Dn userEntryDN)
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.void setSaslServer(SaslServer saslServer)
saslServer
- the SASL server to setCopyright 2010-2020 ForgeRock AS.