|
LDAP Classes Implements Java LDAP |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Performs SASL authentication as a client.An Class implementing this interface can negotiate authentication as a client using one of the IANA-registered mechanisms.
Sasl
,
SaslClientFactory
Method Summary | |
void |
dispose()
Disposes of any system resources or security-sensitive information the SaslClient might be using. |
byte[] |
evaluateChallenge(byte[] challenge)
If a challenge is received from the server during the authentication process, this method is called to prepare an appropriate next response to submit to the server. |
java.lang.String |
getMechanismName()
Reports the IANA-registered name of the mechanism used by this client, e.g. |
java.lang.Object |
getNegotiatedProperty(java.lang.String propName)
This method Retrieves the negotiated property. |
boolean |
hasInitialResponse()
Determines whether this mechanism has an optional initial response. |
boolean |
isComplete()
This method may be called at any time to determine if the authentication process is finished. |
byte[] |
unwrap(byte[] incoming,
int offset,
int len)
Unwraps a byte array received from the server This method can be called only after the authentication process has completed (i.e., when isComplete() returns true) and only if the authentication process has negotiated integrity and/or privacy as the quality of protection. |
byte[] |
wrap(byte[] outgoing,
int offset,
int len)
Wraps a byte array to be sent to the server This method can be called only after the authentication exchange has completed (i.e., when isComplete() returns true) and only if the authentication exchange has negotiated integrity and/or privacy as the quality of protection. |
Method Detail |
public java.lang.String getMechanismName()
public boolean hasInitialResponse()
public byte[] evaluateChallenge(byte[] challenge) throws SaslException
challenge
- The non-null challenge received from the server.
The challenge array may have zero length.
SaslException
- If an error occurred while processing the
challenge or generating a response.public boolean isComplete()
public byte[] unwrap(byte[] incoming, int offset, int len) throws SaslException
incoming
- A non-null byte array containing the encoded bytes
from the server.offset
- The starting position at incoming of the bytes to uselen
- The number of bytes from incoming to use.
SaslException
- If this method is called before
the authentictaion process has completed.A SaslException
is thrown also if incoming cannot be successfully unwrappedpublic byte[] wrap(byte[] outgoing, int offset, int len) throws SaslException
outgoing
- A non-null byte array containing the bytes to encode.offset
- The starting position at outgoing of the bytes to use.len
- The number of bytes from outgoing to use.
SaslException
- If this method is called before
the authentictaion exchange has completed.A SaslException
is thrown also if outgoing cannot be successfully wrapped.public java.lang.Object getNegotiatedProperty(java.lang.String propName) throws SaslException
This method can be called only after the authentication exchange has completed (i.e., when isComplete() returns true)
For example, this method may be used to obtained the negotiated raw send buffer size, quality-of-protection, and cipher strength.
propName
- The non-null property name.
java.lang.IllegalStateException
- if this authentication exchange has
not completed
SaslException
public void dispose() throws SaslException
SaslException
- If a problem was encountered while disposing
of the resources
|
LDAP Classes Implements Java LDAP |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |