Package javax.security.sasl

Interface Summary

SaslClient Performs SASL authentication as a client.

A protocol library such as one for LDAP gets an instance of this class in order to perform authentication defined by a specific SASL mechanism.

SaslClientFactory An interface for creating instances of SaslClient.

SaslServer Performs SASL authentication as a server.

A server such as an LDAP server gets an instance of this class in order to perform authentication defined by a specific SASL mechanism.

SaslServerFactory An interface for creating instances of SaslServer.

Class Summary

AuthorizeCallback This callback is used by SaslServer to determine whether one entity (identified by an authenticated authentication ID) can act on behalf of another entity (identified by an authorization ID).

RealmCallback This callback is used by SaslClient and SaslServer to retrieve realm information.

RealmChoiceCallback This callback is used by SaslClient and SaslServer to obtain a realm given a list of realm choices.

Sasl A static class for creating SASL clients and servers.

This class defines the policy of how to locate, load, and instantiate SASL clients and servers.

For example, an application or library gets a SASL client instance by doing something like:

SaslClient sc =
 Sasl.createSaslClient(mechanisms, authorizationID, protocol,
 serverName, props, callbackHandler);
 

It can then proceed to use the instance to create an authenticated connection.

Similarly, a server gets a SASL server instance by using code that looks as follows:

SaslServer ss =
 Sasl.createSaslServer(mechanism, protocol, serverName, props,
 callbackHandler);
 

Exception Summary

AuthenticationException This exception is thrown by a SASL mechanism implementation to indicate that the SASL exchange has failed due to reasons related to authentication, such as an invalid identity, passphrase, or key.

Note that the lack of an AuthenticationException does not mean that the failure was not due to an authentication error.

SaslException This class represents an error that has occurred when using SASL.