Interface PreParseBindOperation
- All Superinterfaces:
PluginOperation,PreParseOperation
- All Known Implementing Classes:
BindOperation
This class defines a set of methods that are available for use by pre-parse 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
Modifier and TypeMethodDescriptionRetrieves the authentication type for this bind operation.Retrieves the bind DN for this bind operation as contained in the client request.Retrieves the SASL credentials for this bind operation.Retrieves the SASL mechanism for this bind operation.Retrieves the simple authentication password for this bind operation.voidSpecifies the reason that the authentication failed.voidSpecifies the bind DN for this bind operation.voidsetSASLCredentials(String saslMechanism, ByteString saslCredentials) Specifies the SASL credentials for this bind operation.voidsetServerSASLCredentials(ByteString serverSASLCredentials) Specifies the set of server SASL credentials to include in the bind response.voidsetSimplePassword(ByteString simplePassword) Specifies the simple authentication password for this bind operation.Methods inherited from interface org.opends.server.types.operation.PluginOperation
checkIfCanceled, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getRequest, getRequestControl, getRequestControl, getRequestControls, getResponseControls, hasPrivilege, isInternalOperation, isSynchronizationOperation, setAttachment, toString, toStringMethods inherited from interface org.opends.server.types.operation.PreParseOperation
addAdditionalLogItem, addRequestControl, addResponseControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, removeResponseControl, sendResponses, setErrorMessage
-
Method Details
-
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 as contained in the client request.- Returns:
- The bind DN for this bind operation as contained in the client request.
-
setBindDN
Specifies the bind DN for this bind operation.- Parameters:
bindDN- The bind DN for this bind
-
getSimplePassword
ByteString getSimplePassword()Retrieves the simple authentication password for this bind operation.- Returns:
- The simple authentication password for this bind operation.
-
setSimplePassword
Specifies the simple authentication password for this bind operation.- Parameters:
simplePassword- 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
nullif 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
nullif there are none or if the bind does not use SASL authentication.
-
setSASLCredentials
Specifies the SASL credentials for this bind operation.- Parameters:
saslMechanism- The SASL mechanism for this bind operation.saslCredentials- The SASL credentials for this bind operation, ornullif there are none.
-
setServerSASLCredentials
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
Specifies the reason that the authentication failed.- Parameters:
reason- A human-readable message providing the reason that the authentication failed.
-