|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BindOperation
This interface defines an operation that may be used to authenticate a user
to the Directory Server. Note that for security restrictions, response
messages that may be returned to the client must be carefully cleaned to
ensure that they do not provide a malicious client with information that may
be useful in an attack. This does impact the debugability of the server,
but that can be addressed by calling the setAuthFailureReason
method, which can provide a reason for a failure in a form that will not be
returned to the client but may be written to a log file.
Field Summary |
---|
Fields inherited from interface org.opends.server.types.Operation |
---|
LOCALBACKENDOPERATIONS |
Method Summary | |
---|---|
AuthenticationInfo |
getAuthenticationInfo()
Retrieves the authentication info that resulted from processing this bind operation. |
AuthenticationType |
getAuthenticationType()
Retrieves the authentication type for this bind operation. |
Message |
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. |
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. |
Entry |
getSASLAuthUserEntry()
Retrieves the user entry associated with the SASL authentication attempt. |
ASN1OctetString |
getSASLCredentials()
Retrieves the SASL credentials for this bind operation. |
java.lang.String |
getSASLMechanism()
Retrieves the SASL mechanism for this bind operation. |
ASN1OctetString |
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. |
void |
setAuthenticationInfo(AuthenticationInfo authInfo)
Specifies the authentication info that resulted from processing this bind operation. |
void |
setAuthFailureReason(Message message)
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 |
setSASLAuthUserEntry(Entry saslAuthUserEntry)
Specifies the user entry associated with the SASL authentication attempt. |
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. |
void |
setUserEntryDN(DN userEntryDN)
Set the user entry DN for this bind operation. |
Method Detail |
---|
AuthenticationType getAuthenticationType()
ByteString getRawBindDN()
void setRawBindDN(ByteString rawBindDN)
rawBindDN
- The raw, unprocessed bind DN for this bind operation.java.lang.String getProtocolVersion()
void setProtocolVersion(java.lang.String protocolVersion)
protocolVersion
- The string representation of the protocol version
associated with this bind request.DN getBindDN()
getRawBindDN
method.
null
if the
raw DN has not yet been processed.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.ASN1OctetString getServerSASLCredentials()
null
if there are none.void setServerSASLCredentials(ASN1OctetString serverSASLCredentials)
serverSASLCredentials
- The set of server SASL credentials to
include in the bind response.Entry getSASLAuthUserEntry()
null
if it was not a SASL authentication or the SASL
processing was not able to map the request to a user.void setSASLAuthUserEntry(Entry saslAuthUserEntry)
saslAuthUserEntry
- The user entry associated with the SASL
authentication attempt.Message getAuthFailureReason()
null
if none is available.void setAuthFailureReason(Message message)
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.AuthenticationInfo getAuthenticationInfo()
void setAuthenticationInfo(AuthenticationInfo authInfo)
processSASLBind
method.
authInfo
- The authentication info that resulted from processing
this bind operation.void setUserEntryDN(DN userEntryDN)
userEntryDN
- 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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |