Interface PostResponseBindOperation
-
- All Superinterfaces:
PluginOperation
,PostOperationOperation
- All Known Implementing Classes:
BindOperation
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface PostResponseBindOperation extends PostOperationOperation
This class defines a set of methods that are available for use by post-response plugins for bind operations. Note that this interface is intended only to define an API for use by plugins and is not intended to be implemented by any custom classes.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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.Dn
getBindDN()
Retrieves the bind DN for this bind operation.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.-
Methods inherited from interface org.opends.server.types.operation.PluginOperation
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getRequestControl, getRequestControl, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString
-
Methods inherited from interface org.opends.server.types.operation.PostOperationOperation
addAdditionalLogItem, addResponseControl, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, removeResponseControl, setErrorMessage, setMatchedDN, setReferralURLs, setResult, setResultCode
-
-
-
-
Method Detail
-
getAuthenticationType
AuthenticationType getAuthenticationType()
Retrieves the authentication type for this bind operation.- Returns:
- The authentication type for this bind operation.
-
getBindDN
Dn getBindDN()
Retrieves the bind DN for this bind operation.- Returns:
- The bind DN for this bind operation.
-
getSimplePassword
ByteString getSimplePassword()
Retrieves the simple authentication password for this bind operation.- Returns:
- The simple authentication password for this bind operation.
-
getSASLMechanism
String getSASLMechanism()
Retrieves the SASL mechanism for this bind operation.- Returns:
- The SASL mechanism for this bind operation, or
null
if the bind does not use SASL authentication.
-
getSASLCredentials
ByteString getSASLCredentials()
Retrieves the SASL credentials for this bind operation.- Returns:
- The SASL credentials for this bind operation, or
null
if there are none or if the bind does not use SASL authentication.
-
getServerSASLCredentials
ByteString getServerSASLCredentials()
Retrieves the set of server SASL credentials to include in the bind response.- Returns:
- The set of server SASL credentials to include in the bind response, or
null
if there are none.
-
getSASLAuthUserEntry
Entry getSASLAuthUserEntry()
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.- 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.
-
getAuthFailureReason
LocalizableMessage getAuthFailureReason()
Retrieves a human-readable message providing the reason that the authentication failed, if available.- Returns:
- A human-readable message providing the reason that the authentication failed, or
null
if none is available.
-
getUserEntryDN
Dn getUserEntryDN()
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.- 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.
-
-