| javax.security.sasl.SaslClientFactory
SaslClientFactory | abstract public interface SaslClientFactory (Code) | | An interface for creating instances of SaslClient.
A class that implements this interface
must be thread-safe and handle multiple simultaneous
requests. It must also have a public constructor that accepts no
argument.
This interface is not normally accessed directly by a client, which will use the
Sasl static methods
instead. However, a particular environment may provide and install a
new or different SaslClientFactory.
since: 1.5 See Also: SaslClient See Also: Sasl author: Rosanna Lee author: Rob Weltman |
Method Summary | |
abstract public SaslClient | createSaslClient(String[] mechanisms, String authorizationId, String protocol, String serverName, Map<String, ?> props, CallbackHandler cbh) Creates a SaslClient using the parameters supplied.
Parameters: mechanisms - The non-null list of mechanism names to try. | abstract public String[] | getMechanismNames(Map<String, ?> 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 thesecurity policy of the SASL mechanisms. |
createSaslClient | abstract public SaslClient createSaslClient(String[] mechanisms, String authorizationId, String protocol, String serverName, Map<String, ?> props, CallbackHandler cbh) throws SaslException(Code) | | Creates a SaslClient using the parameters supplied.
Parameters: mechanisms - The non-null list of mechanism names to try. Each is theIANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5"). Parameters: 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 completes successfully, the specified entity is granted access. Parameters: protocol - The non-null string name of the protocol for whichthe authentication is being performed (e.g., "ldap"). Parameters: serverName - The non-null fully qualified host name of the server to authenticate to. Parameters: props - The possibly null set of properties used to select the SASLmechanism and to configure the authentication exchange of the selectedmechanism. See the Sasl class for a list of standard properties. Other, possibly mechanism-specific, properties can be included.Properties not relevant to the selected mechanism are ignored,including any map entries with non-String keys. Parameters: cbh - The possibly null callback handler to used by the SASLmechanisms to get further information from the application/libraryto complete the authentication. For example, a SASL mechanism mightrequire 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 listof realms to choose from, and by using a RealmCallback ifthe realm must be entered. A possibly null SaslClient created using the parameterssupplied. If null, this factory cannot produce a SaslClientusing the parameters supplied. exception: SaslException - If cannot create a SaslClient becauseof an error. |
getMechanismNames | abstract public String[] getMechanismNames(Map<String, ?> props)(Code) | | 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 thesecurity policy of the SASL mechanisms. For example, if propscontains the Sasl.POLICY_NOPLAINTEXT property with the value"true", then the factory must not return any SASL mechanismsthat are susceptible to simple plain passive attacks.See the Sasl class for a complete list of policy properties.Non-policy related properties, if present in props, are ignored,including any map entries with non-String keys. A non-null array containing a IANA-registered SASL mechanism names. |
|
|