com.novell.sasl
Interface SaslClientFactory

All Known Implementing Classes:

ClientFactory

public interface SaslClientFactory

An object implementing this interface can provide a SaslClient.

The implementation must be thread-safe and handle multiple simultaneous requests.It must also have a public constructor that accepts no argument.

Method Summary

SaslClient	createSaslClient(java.lang.String[] mechanisms, java.lang.String authorizationID, java.lang.String protocol, java.lang.String serverName, java.util.Map props, javax.security.auth.callback.CallbackHandler cbh) Creates a SaslClient using the parameters supplied.
java.lang.String[]	getMechanismNames(java.util.Map props) Returns an array of names of mechanisms that match the specified mechanism selection policies

Method Detail

createSaslClient

public SaslClient createSaslClient(java.lang.String[] mechanisms,
                                   java.lang.String authorizationID,
                                   java.lang.String protocol,
                                   java.lang.String serverName,
                                   java.util.Map props,
                                   javax.security.auth.callback.CallbackHandler cbh)
                            throws SaslException

Creates a SaslClient using the parameters supplied.

Parameters:

mechanisms - The non-null list of mechanism names to try. Each is the IANA-registered name of a SASL mechanism (e.g. "GSSAPI", "DIGEST-MD5").

authorizationID - The possibly null protocol-dependent identification to be used for authorization. If null or empty, the server derives an authorization ID from the client's authentication credentials. When the SASL authentication complete successfully , the specified entity is granted access.

protocol - The non-null string name of the protocol for which the authentication is being performed, e.g "ldap".

serverName - The non-null fully qualified host name of the server to authenticate to.

props - The possibly null set of properties used to select the SASL mechanism and to configure the authentication exchange of the selected mechanism. Other, possibly mechanism-specific, properties can be included. Properties not relevant to the selected mechanism are ignored.

cbh - The possibly null callback handler to be used by the SASL mechanisms to get further information from the application/library to complete the authentication. For example, a SASL mechanism might require the authentication ID, password and realm from the caller. The authentication ID is requested by using a NameCallback. The password is requested by using a PasswordCallback. The realm is requested by using a RealmChoiceCallback if there is a list of realms to choose from, and by using a RealmCallback if the realm must be enterd.

Returns:

A possibly null SaslClient created using the parameters supplied. If null, this factory cannot produce a SaslClient using the parameters supplied.

Throws:

SaslException - If a SaslClient instance cannot be created because of an error

getMechanismNames

public java.lang.String[] getMechanismNames(java.util.Map props)

Returns an array of names of mechanisms that match the specified mechanism selection policies

Parameters:

props - The possibly null set of properties used to specify the security policy of the SASL mechanisms. For example, if props contains the Sasl.POLICY_NOPLAINTEXT property with the value "true", then the factory must not return any SASL mechanisms that are susceptible to simple plain passive attacks. Non-policy related properties, if present in props, are ignored.

Returns:

A non-null array containing IANA-registered SASL mechanism names