Interface PreOperationBindOperation
-
- All Superinterfaces:
PluginOperation
,PreOperationOperation
- All Known Implementing Classes:
BindOperation
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface PreOperationBindOperation extends PreOperationOperation
This class defines a set of methods that are available for use by pre-operation 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.Dn
getBindDN()
Retrieves the bind DN for this bind operation.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.-
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.PreOperationOperation
addAdditionalLogItem, addResponseControl, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, removeResponseControl, setErrorMessage
-
-
-
-
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.
-
setServerSASLCredentials
void setServerSASLCredentials(ByteString serverSASLCredentials)
Specifies the set of server SASL credentials to include in the bind response.- Parameters:
serverSASLCredentials
- The set of server SASL credentials to include in the bind response.
-
setAuthFailureReason
void setAuthFailureReason(LocalizableMessage reason)
Specifies the reason that the authentication failed.- Parameters:
reason
- A human-readable message providing the reason that the authentication failed.
-
getUserEntryDN
Dn getUserEntryDN()
Retrieves the user entry DN for this bind operation. It will only be available for simple bind operations (and may be different than the bind DN from the client request).- 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.
-
-