|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.core.OperationWrapper
org.opends.server.core.BindOperationWrapper
public abstract class BindOperationWrapper
This abstract class wraps/decorates a given bind operation. This class will be extended by sub-classes to enhance the functionnality of the BindOperationBasis.
Field Summary |
---|
Fields inherited from interface org.opends.server.types.Operation |
---|
LOCALBACKENDOPERATIONS |
Constructor Summary | |
---|---|
protected |
BindOperationWrapper(BindOperation bind)
Creates a new bind operation based on the provided bind operation. |
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 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 |
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. |
java.lang.String |
toString()
Retrieves a string representation of this operation. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected BindOperationWrapper(BindOperation bind)
bind
- The bind operation to wrapMethod Detail |
---|
public AuthenticationInfo getAuthenticationInfo()
getAuthenticationInfo
in interface BindOperation
public AuthenticationType getAuthenticationType()
getAuthenticationType
in interface BindOperation
public Message getAuthFailureReason()
getAuthFailureReason
in interface BindOperation
null
if none is available.public DN getBindDN()
getRawBindDN
method.
getBindDN
in interface BindOperation
null
if the
raw DN has not yet been processed.public ByteString getRawBindDN()
getRawBindDN
in interface BindOperation
public Entry getSASLAuthUserEntry()
getSASLAuthUserEntry
in interface BindOperation
null
if it was not a SASL authentication or the SASL
processing was not able to map the request to a user.public ASN1OctetString getSASLCredentials()
getSASLCredentials
in interface BindOperation
null
if there are none or if the bind does not use SASL authentication.public java.lang.String getSASLMechanism()
getSASLMechanism
in interface BindOperation
null
if the bind does not use SASL authentication.public ASN1OctetString getServerSASLCredentials()
getServerSASLCredentials
in interface BindOperation
null
if there are none.public ByteString getSimplePassword()
getSimplePassword
in interface BindOperation
public DN getUserEntryDN()
getUserEntryDN
in interface BindOperation
null
if
the bind processing has not progressed far enough to identify the
user or if the user DN could not be determined.public void setAuthenticationInfo(AuthenticationInfo authInfo)
processSASLBind
method.
setAuthenticationInfo
in interface BindOperation
authInfo
- The authentication info that resulted from processing
this bind operation.public void setAuthFailureReason(Message reason)
setAuthFailureReason
in interface BindOperation
reason
- providing the reason that the
authentication failed.public void setRawBindDN(ByteString rawBindDN)
setRawBindDN
in interface BindOperation
rawBindDN
- The raw, unprocessed bind DN for this bind operation.public void setSASLAuthUserEntry(Entry saslAuthUserEntry)
setSASLAuthUserEntry
in interface BindOperation
saslAuthUserEntry
- The user entry associated with the SASL
authentication attempt.public void setSASLCredentials(java.lang.String saslMechanism, ASN1OctetString saslCredentials)
setSASLCredentials
in interface BindOperation
saslMechanism
- The SASL mechanism for this bind operation.saslCredentials
- The SASL credentials for this bind operation, or
null
if there are none.public void setServerSASLCredentials(ASN1OctetString serverSASLCredentials)
setServerSASLCredentials
in interface BindOperation
serverSASLCredentials
- The set of server SASL credentials to
include in the bind response.public void setSimplePassword(ByteString simplePassword)
setSimplePassword
in interface BindOperation
simplePassword
- The simple authentication password for this bind
operation.public void setUserEntryDN(DN userEntryDN)
setUserEntryDN
in interface BindOperation
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.public java.lang.String toString()
toString
in interface Operation
toString
in class java.lang.Object
public void setProtocolVersion(java.lang.String protocolVersion)
setProtocolVersion
in interface BindOperation
protocolVersion
- The string representation of the protocol version
associated with this bind request.public java.lang.String getProtocolVersion()
getProtocolVersion
in interface BindOperation
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |