|
|||||||||
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 PreParseBindOperation
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 | |
---|---|
AuthenticationType |
getAuthenticationType()
Retrieves the authentication type 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. |
void |
setAuthFailureReason(Message reason)
Specifies the reason that the authentication failed. |
void |
setProtocolVersion(java.lang.String protocolVersion)
Specifies the string representation of the protocol version associated with this bind request. |
void |
setRawBindDN(ByteString rawBindDN)
Specifies the raw, unprocessed bind DN for this bind operation. |
void |
setSASLCredentials(java.lang.String saslMechanism,
ASN1OctetString saslCredentials)
Specifies the SASL credentials for this bind operation. |
void |
setServerSASLCredentials(ASN1OctetString serverSASLCredentials)
Specifies the set of server SASL credentials to include in the bind response. |
void |
setSimplePassword(ByteString simplePassword)
Specifies the simple authentication password for this bind operation. |
Methods inherited from interface org.opends.server.types.operation.PreParseOperation |
---|
addRequestControl, addResponseControl, appendAdditionalLogMessage, appendErrorMessage, getAdditionalLogMessage, getErrorMessage, removeRequestControl, 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()
void setProtocolVersion(java.lang.String protocolVersion)
protocolVersion
- The string representation of the
protocol version associated with this
bind request.ByteString getRawBindDN()
void setRawBindDN(ByteString rawBindDN)
rawBindDN
- The raw, unprocessed bind DN for this bind
operation.ByteString getSimplePassword()
void setSimplePassword(ByteString simplePassword)
simplePassword
- The simple authentication password for
this bind operation.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 setSASLCredentials(java.lang.String saslMechanism, ASN1OctetString saslCredentials)
saslMechanism
- The SASL mechanism for this bind
operation.saslCredentials
- The SASL credentials for this bind
operation, or null
if there
are none.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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |