public abstract class BindOperationWrapper extends OperationWrapper<BindOperation> implements BindOperation
LOCALBACKENDOPERATIONS
Modifier | Constructor and Description |
---|---|
protected |
BindOperationWrapper(BindOperation bind)
Creates a new bind operation based on the provided bind operation.
|
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.
|
org.forgerock.opendj.ldap.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.
|
org.forgerock.opendj.ldap.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.
|
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 |
setAuthenticationInfo(AuthenticationInfo authInfo)
Specifies the authentication info that resulted from processing this bind
operation.
|
void |
setAuthFailureReason(LocalizableMessage reason)
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(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.
|
String |
toString()
Retrieves a string representation of this operation.
|
abort, addAdditionalLogItem, addRequestControl, addResponseControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, equals, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperation, getOperationID, getOperationType, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getProxiedAuthorizationDN, getReferralURLs, getRequestControl, getRequestControls, getResponseControls, getResultCode, hashCode, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, registerPostResponseCallback, removeAttachment, removeResponseControl, run, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setProxiedAuthorizationDN, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
abort, addAdditionalLogItem, addRequestControl, addResponseControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, 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, setResultCode, setSynchronizationOperation, toString
protected BindOperationWrapper(BindOperation bind)
bind
- The bind operation to wrappublic AuthenticationInfo getAuthenticationInfo()
BindOperation
getAuthenticationInfo
in interface BindOperation
public AuthenticationType getAuthenticationType()
BindOperation
getAuthenticationType
in interface BindOperation
public LocalizableMessage getAuthFailureReason()
BindOperation
getAuthFailureReason
in interface BindOperation
null
if none is available.public org.forgerock.opendj.ldap.Dn getBindDN()
BindOperation
getRawBindDN
method.getBindDN
in interface BindOperation
null
if the
raw DN has not yet been processed.public org.forgerock.opendj.ldap.ByteString getRawBindDN()
BindOperation
getRawBindDN
in interface BindOperation
public 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 org.forgerock.opendj.ldap.ByteString getSASLCredentials()
BindOperation
getSASLCredentials
in interface BindOperation
null
if there are none or if the bind does not use SASL authentication.public String getSASLMechanism()
BindOperation
getSASLMechanism
in interface BindOperation
null
if the bind does not use SASL authentication.public org.forgerock.opendj.ldap.ByteString getServerSASLCredentials()
BindOperation
getServerSASLCredentials
in interface BindOperation
null
if there are none.public org.forgerock.opendj.ldap.ByteString getSimplePassword()
BindOperation
getSimplePassword
in interface BindOperation
public 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 void setAuthenticationInfo(AuthenticationInfo authInfo)
BindOperation
processSASLBind
method.setAuthenticationInfo
in interface BindOperation
authInfo
- The authentication info that resulted from processing
this bind operation.public void setAuthFailureReason(LocalizableMessage reason)
BindOperation
setAuthFailureReason
in interface BindOperation
reason
- providing the reason that the
authentication failed.public void setRawBindDN(org.forgerock.opendj.ldap.ByteString rawBindDN)
BindOperation
setRawBindDN
in interface BindOperation
rawBindDN
- The raw, unprocessed bind DN for this bind operation.public void setSASLAuthUserEntry(Entry saslAuthUserEntry)
BindOperation
setSASLAuthUserEntry
in interface BindOperation
saslAuthUserEntry
- The user entry associated with the SASL
authentication attempt.public void setSASLCredentials(String saslMechanism, org.forgerock.opendj.ldap.ByteString saslCredentials)
BindOperation
setSASLCredentials
in interface BindOperation
saslMechanism
- The SASL mechanism for this bind operation.saslCredentials
- The SASL credentials for this bind operation, or
null
if there are none.public void setServerSASLCredentials(org.forgerock.opendj.ldap.ByteString serverSASLCredentials)
BindOperation
setServerSASLCredentials
in interface BindOperation
serverSASLCredentials
- The set of server SASL credentials to
include in the bind response.public void setSimplePassword(org.forgerock.opendj.ldap.ByteString simplePassword)
BindOperation
setSimplePassword
in interface BindOperation
simplePassword
- The simple authentication password for this bind
operation.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 toString()
Operation
toString
in interface Operation
toString
in class OperationWrapper<BindOperation>
public void setProtocolVersion(String protocolVersion)
BindOperation
setProtocolVersion
in interface BindOperation
protocolVersion
- The string representation of the protocol version
associated with this bind request.public String getProtocolVersion()
BindOperation
getProtocolVersion
in interface BindOperation
Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.