|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface PreOperationBindOperation
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 | |
---|---|
AuthenticationType |
getAuthenticationType()
Retrieves the authentication type for this bind operation. |
DN |
getBindDN()
Retrieves the bind DN for this bind operation. |
java.lang.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. |
ASN1OctetString |
getSASLCredentials()
Retrieves the SASL credentials for this bind operation. |
java.lang.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(Message reason)
Specifies the reason that the authentication failed. |
void |
setServerSASLCredentials(ASN1OctetString serverSASLCredentials)
Specifies the set of server SASL credentials to include in the bind response. |
Methods inherited from interface org.opends.server.types.operation.PreOperationOperation |
---|
addResponseControl, appendAdditionalLogMessage, appendErrorMessage, getAdditionalLogMessage, getAuthorizationDN, getErrorMessage, removeResponseControl, setAdditionalLogMessage, setErrorMessage |
Methods inherited from interface org.opends.server.types.operation.PluginOperation |
---|
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getProcessingStartTime, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString |
Method Detail |
---|
AuthenticationType getAuthenticationType()
java.lang.String getProtocolVersion()
ByteString getRawBindDN()
DN getBindDN()
ByteString getSimplePassword()
java.lang.String getSASLMechanism()
null
if the bind does not use SASL
authentication.ASN1OctetString getSASLCredentials()
null
if there are none or if the bind does
not use SASL authentication.void setServerSASLCredentials(ASN1OctetString serverSASLCredentials)
serverSASLCredentials
- The set of server SASL credentials
to include in the bind response.void setAuthFailureReason(Message 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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |