Package org.opends.server.core

Class BindOperationWrapper

java.lang.Object

org.opends.server.core.OperationWrapper<BindOperation>

org.opends.server.core.BindOperationWrapper

All Implemented Interfaces:

Runnable, BindOperation, Operation

Direct Known Subclasses:

LocalBackendBindOperation

public abstract class BindOperationWrapper
extends OperationWrapper<BindOperation>
implements BindOperation

This abstract class wraps/decorates a given bind operation. This class will be extended by sub-classes to enhance the functionality of the BindOperationBasis.

Field Summary

Fields inherited from interface org.opends.server.types.Operation

LOCALBACKENDOPERATIONS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BindOperationWrapper(BindOperation bind)	Creates a new bind operation based on the provided bind operation.

Method Summary

Modifier and Type	Method	Description
AuthenticationInfo	getAuthenticationInfo()	Retrieves the authentication info that resulted from processing this bind operation.
AuthenticationType	getAuthenticationType()	Retrieves the authentication type for this bind operation.
org.forgerock.i18n.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.
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(org.forgerock.i18n.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(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	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.
String	toString()	Retrieves a string representation of this operation.

Methods inherited from class org.opends.server.core.OperationWrapper

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opends.server.types.Operation

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

Constructor Detail

BindOperationWrapper

protected BindOperationWrapper(BindOperation bind)

Creates a new bind operation based on the provided bind operation.

Parameters:

bind - The bind operation to wrap

Method Detail

getAuthenticationInfo

public AuthenticationInfo getAuthenticationInfo()

Description copied from interface: BindOperation

Retrieves the authentication info that resulted from processing this bind operation. It will only be valid if the bind processing was successful.

Specified by:

getAuthenticationInfo in interface BindOperation

Returns:

The authentication info that resulted from processing this bind operation.

getAuthenticationType

public AuthenticationType getAuthenticationType()

Description copied from interface: BindOperation

Retrieves the authentication type for this bind operation.

Specified by:

getAuthenticationType in interface BindOperation

Returns:

The authentication type for this bind operation.

getAuthFailureReason

public org.forgerock.i18n.LocalizableMessage getAuthFailureReason()

Description copied from interface: BindOperation

Retrieves a human-readable message providing the reason that the authentication failed, if available.

Specified by:

getAuthFailureReason in interface BindOperation

Returns:

A human-readable message providing the reason that the authentication failed, or null if none is available.

getBindDN

public DN getBindDN()

Description copied from interface: BindOperation

Retrieves the bind DN for this bind operation. This method should not be called by pre-parse plugins, as the raw value will not have been processed by that time. Instead, pre-parse plugins should call the getRawBindDN method.

Specified by:

getBindDN in interface BindOperation

Returns:

The bind DN for this bind operation, or null if the raw DN has not yet been processed.

getRawBindDN

public ByteString getRawBindDN()

Description copied from interface: BindOperation

Retrieves the raw, unprocessed bind DN for this bind operation as contained in the client request. The value may not actually contain a valid DN, as no validation will have been performed.

Specified by:

getRawBindDN in interface BindOperation

Returns:

The raw, unprocessed bind DN for this bind operation as contained in the client request.

getSASLAuthUserEntry

public Entry getSASLAuthUserEntry()

Description copied from interface: BindOperation

Retrieves the user entry associated with the SASL authentication attempt. This should be set by any SASL mechanism in which the processing was able to get far enough to make this determination, regardless of whether the authentication was ultimately successful.

Specified by:

getSASLAuthUserEntry in interface BindOperation

Returns:

The user entry associated with the SASL authentication attempt, or null if it was not a SASL authentication or the SASL processing was not able to map the request to a user.

getSASLCredentials

public ByteString getSASLCredentials()

Description copied from interface: BindOperation

Retrieves the SASL credentials for this bind operation.

Specified by:

getSASLCredentials in interface BindOperation

Returns:

The SASL credentials for this bind operation, or null if there are none or if the bind does not use SASL authentication.

getSASLMechanism

public String getSASLMechanism()

Description copied from interface: BindOperation

Retrieves the SASL mechanism for this bind operation.

Specified by:

getSASLMechanism in interface BindOperation

Returns:

The SASL mechanism for this bind operation, or null if the bind does not use SASL authentication.

getServerSASLCredentials

public ByteString getServerSASLCredentials()

Description copied from interface: BindOperation

Retrieves the set of server SASL credentials to include in the bind response.

Specified by:

getServerSASLCredentials in interface BindOperation

Returns:

The set of server SASL credentials to include in the bind response, or null if there are none.

getSimplePassword

public ByteString getSimplePassword()

Description copied from interface: BindOperation

Retrieves the simple authentication password for this bind operation.

Specified by:

getSimplePassword in interface BindOperation

Returns:

The simple authentication password for this bind operation.

getUserEntryDN

public DN getUserEntryDN()

Description copied from interface: BindOperation

Retrieves the user entry DN for this bind operation. It will only be available if the bind processing has proceeded far enough to identify the user attempting to authenticate.

Specified by:

getUserEntryDN in interface BindOperation

Returns:

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.

setAuthenticationInfo

public void setAuthenticationInfo(AuthenticationInfo authInfo)

Description copied from interface: BindOperation

Specifies the authentication info that resulted from processing this bind operation. This method must only be called by SASL mechanism handlers during the course of processing the processSASLBind method.

Specified by:

setAuthenticationInfo in interface BindOperation

Parameters:

authInfo - The authentication info that resulted from processing this bind operation.

setAuthFailureReason

public void setAuthFailureReason(org.forgerock.i18n.LocalizableMessage reason)

Description copied from interface: BindOperation

Specifies the reason that the authentication failed.

Specified by:

setAuthFailureReason in interface BindOperation

Parameters:

reason - providing the reason that the authentication failed.

setRawBindDN

public void setRawBindDN(ByteString rawBindDN)

Description copied from interface: BindOperation

Specifies the raw, unprocessed bind DN for this bind operation. This should only be called by pre-parse plugins.

Specified by:

setRawBindDN in interface BindOperation

Parameters:

rawBindDN - The raw, unprocessed bind DN for this bind operation.

setSASLAuthUserEntry

public void setSASLAuthUserEntry(Entry saslAuthUserEntry)

Description copied from interface: BindOperation

Specifies the user entry associated with the SASL authentication attempt. This should be set by any SASL mechanism in which the processing was able to get far enough to make this determination, regardless of whether the authentication was ultimately successful.

Specified by:

setSASLAuthUserEntry in interface BindOperation

Parameters:

saslAuthUserEntry - The user entry associated with the SASL authentication attempt.

setSASLCredentials

public void setSASLCredentials(String saslMechanism,
                               ByteString saslCredentials)

Description copied from interface: BindOperation

Specifies the SASL credentials for this bind operation.

Specified by:

setSASLCredentials in interface BindOperation

Parameters:

saslMechanism - The SASL mechanism for this bind operation.

saslCredentials - The SASL credentials for this bind operation, or null if there are none.

setServerSASLCredentials

public void setServerSASLCredentials(ByteString serverSASLCredentials)

Description copied from interface: BindOperation

Specifies the set of server SASL credentials to include in the bind response.

Specified by:

setServerSASLCredentials in interface BindOperation

Parameters:

serverSASLCredentials - The set of server SASL credentials to include in the bind response.

setSimplePassword

public void setSimplePassword(ByteString simplePassword)

Description copied from interface: BindOperation

Specifies the simple authentication password for this bind operation.

Specified by:

setSimplePassword in interface BindOperation

Parameters:

simplePassword - The simple authentication password for this bind operation.

setUserEntryDN

public void setUserEntryDN(DN userEntryDN)

Description copied from interface: BindOperation

Set the user entry DN for this bind operation.

Specified by:

setUserEntryDN in interface BindOperation

Parameters:

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.

toString

public String toString()

Description copied from interface: Operation

Retrieves a string representation of this operation.

Specified by:

toString in interface Operation

Overrides:

toString in class OperationWrapper<BindOperation>

Returns:

A string representation of this operation.

setProtocolVersion

public void setProtocolVersion(String protocolVersion)

Description copied from interface: BindOperation

Specifies the string representation of the protocol version associated with this bind request.

Specified by:

setProtocolVersion in interface BindOperation

Parameters:

protocolVersion - The string representation of the protocol version associated with this bind request.

getProtocolVersion

public String getProtocolVersion()

Description copied from interface: BindOperation

Retrieves a string representation of the protocol version associated with this bind request.

Specified by:

getProtocolVersion in interface BindOperation

Returns:

A string representation of the protocol version associated with this bind request.