@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface PreParseBindOperation extends PreParseOperation
Modifier and Type | Method and Description |
---|---|
AuthenticationType |
getAuthenticationType()
Retrieves the authentication type 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.
|
ByteString |
getSASLCredentials()
Retrieves the SASL credentials for this bind operation.
|
String |
getSASLMechanism()
Retrieves the SASL mechanism for this bind operation.
|
ByteString |
getSimplePassword()
Retrieves the simple authentication password for 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(ByteString rawBindDN)
Specifies the raw, unprocessed bind DN for this bind operation.
|
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.
|
addAdditionalLogItem, addRequestControl, addResponseControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, removeResponseControl, setErrorMessage
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getProcessingStartTime, getRequestControl, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString
AuthenticationType getAuthenticationType()
String getProtocolVersion()
void setProtocolVersion(String protocolVersion)
protocolVersion
- The string representation of the
protocol version associated with this
bind request.ByteString getRawBindDN()
void setRawBindDN(ByteString rawBindDN)
rawBindDN
- The raw, unprocessed bind DN for this bindByteString 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.void setServerSASLCredentials(ByteString serverSASLCredentials)
serverSASLCredentials
- The set of server SASL credentials
to include in the bind response.void setAuthFailureReason(LocalizableMessage reason)
reason
- A human-readable message providing the reason
that the authentication failed.Copyright 2010-2017 ForgeRock AS.