| javax.security.sasl.SaslServerFactory
| SaslServerFactory | | abstract public interface SaslServerFactory (Code) | | An interface for creating instances of SaslServer.
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 server, which will use the
Sasl static methods
instead. However, a particular environment may provide and install a
new or different SaslServerFactory.
since:
1.5
See Also: SaslServer
See Also: Sasl
author:
Rosanna Lee
author:
Rob Weltman |
| Method Summary | |
| abstract public SaslServer | createSaslServer(String mechanism, String protocol, String serverName, Map<String, ?> props, CallbackHandler cbh)
Creates a SaslServer using the parameters supplied.
It returns null
if no SaslServer can be created using the parameters supplied.
Throws SaslException if it cannot create a SaslServer
because of an error.
Parameters:
mechanism - The non-nullIANA-registered name of a SASL mechanism. | | 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. |
| createSaslServer | | abstract public SaslServer createSaslServer(String mechanism, String protocol, String serverName, Map<String, ?> props, CallbackHandler cbh) throws SaslException(Code) | | Creates a SaslServer using the parameters supplied.
It returns null
if no SaslServer can be created using the parameters supplied.
Throws SaslException if it cannot create a SaslServer
because of an error.
Parameters:
mechanism - The non-nullIANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5").
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 serverto 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 SaslServer created using the parameterssupplied. If null, this factory cannot produce a SaslServerusing the parameters supplied.
exception:
SaslException - If cannot create a SaslServer 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. |
|
|