public final class

FactoryImpl

extends Object
implements SaslClientFactory SaslServerFactory
java.lang.Object
   ↳ com.sun.security.sasl.digest.FactoryImpl

Class Overview

Client and server factory for DIGEST-MD5 SASL client/server mechanisms. See DigestMD5Client and DigestMD5Server for input requirements.

Summary

Public Constructors
FactoryImpl()
Empty constructor.
Public Methods
SaslClient createSaslClient(String[] mechs, String authorizationId, String protocol, String serverName, Map<String, ?> props, CallbackHandler cbh)
Returns a new instance of the DIGEST-MD5 SASL client mechanism.
SaslServer createSaslServer(String mech, String protocol, String serverName, Map<String, ?> props, CallbackHandler cbh)
Returns a new instance of the DIGEST-MD5 SASL server mechanism.
String[] getMechanismNames(Map<String, ?> env)
Returns the authentication mechanisms that this factory can produce.
[Expand]
Inherited Methods
From class java.lang.Object
From interface javax.security.sasl.SaslClientFactory
From interface javax.security.sasl.SaslServerFactory

Public Constructors

public FactoryImpl ()

Empty constructor.

Public Methods

public SaslClient createSaslClient (String[] mechs, String authorizationId, String protocol, String serverName, Map<String, ?> props, CallbackHandler cbh)

Returns a new instance of the DIGEST-MD5 SASL client mechanism.

Parameters
mechs The non-null list of mechanism names to try. Each is the IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-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 completes 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. 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.
cbh The possibly null callback handler to 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 entered.
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 there is an error creating the DigestMD5 SASL client.

public SaslServer createSaslServer (String mech, String protocol, String serverName, Map<String, ?> props, CallbackHandler cbh)

Returns a new instance of the DIGEST-MD5 SASL server mechanism.

Parameters
mech The non-null IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5").
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. 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.
cbh The possibly null callback handler to 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 entered.
Returns
  • A possibly null SaslServer created using the parameters supplied. If null, this factory cannot produce a SaslServer using the parameters supplied.
Throws
SaslException If there is an error creating the DigestMD5 SASL server.

public String[] getMechanismNames (Map<String, ?> env)

Returns the authentication mechanisms that this factory can produce.

Parameters
env 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. 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.
Returns
  • A non-null array containing a IANA-registered SASL mechanism names.