@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.
|
org.forgerock.opendj.ldap.ByteString |
getRawBindDN()
Retrieves the raw, unprocessed bind DN for this bind operation as
contained in the client request.
|
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 |
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(org.forgerock.opendj.ldap.ByteString rawBindDN)
Specifies the raw, unprocessed bind DN for this bind operation.
|
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.
|
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.org.forgerock.opendj.ldap.ByteString getRawBindDN()
void setRawBindDN(org.forgerock.opendj.ldap.ByteString rawBindDN)
rawBindDN
- The raw, unprocessed bind DN for this bindorg.forgerock.opendj.ldap.ByteString getSimplePassword()
void setSimplePassword(org.forgerock.opendj.ldap.ByteString simplePassword)
simplePassword
- The simple authentication password for
this bind operation.String getSASLMechanism()
null
if the bind does not use SASL
authentication.org.forgerock.opendj.ldap.ByteString getSASLCredentials()
null
if there are none or if the bind does
not use SASL authentication.void setSASLCredentials(String saslMechanism, org.forgerock.opendj.ldap.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(org.forgerock.opendj.ldap.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. All Rights Reserved.