@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface PreOperationBindOperation extends PreOperationOperation
Modifier and Type | Method and Description |
---|---|
AuthenticationType |
getAuthenticationType()
Retrieves the authentication type for this bind operation.
|
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.
|
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.
|
Dn |
getUserEntryDN()
Retrieves the user entry DN for this bind operation.
|
void |
setAuthFailureReason(LocalizableMessage reason)
Specifies the reason that the authentication failed.
|
void |
setServerSASLCredentials(ByteString serverSASLCredentials)
Specifies the set of server SASL credentials to include in the bind response.
|
addAdditionalLogItem, addResponseControl, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, 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()
ByteString getRawBindDN()
Dn getBindDN()
ByteString getSimplePassword()
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 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.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.Copyright 2010-2018 ForgeRock AS.