|
For the latest news and information visit The GNU Crypto project |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object | +--gnu.crypto.sasl.ClientFactory
The implementation of SaslClientFactory.
| Constructor Summary | |
|---|---|
ClientFactory()
|
|
| Method Summary | |
|---|---|
SaslClient |
createSaslClient(java.lang.String[] mechanisms,
java.lang.String authorisationID,
java.lang.String protocol,
java.lang.String serverName,
java.util.Map props,
CallbackHandler cbh)
Creates a SaslClient using the parameters supplied. |
static ClientMechanism |
getInstance(java.lang.String mechanism)
|
java.lang.String[] |
getMechanismNames(java.util.Map props)
Returns an array of names of mechanisms that match the specified mechanism selection policies. |
static java.util.Set |
getNames()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public ClientFactory()
| Method Detail |
public static final java.util.Set getNames()
public static final ClientMechanism getInstance(java.lang.String mechanism)
public SaslClient createSaslClient(java.lang.String[] mechanisms,
java.lang.String authorisationID,
java.lang.String protocol,
java.lang.String serverName,
java.util.Map props,
CallbackHandler cbh)
throws SaslException
SaslClientFactorySaslClient using the parameters supplied.
createSaslClient in interface SaslClientFactorymechanisms - the non-null list of mechanism names to try. Each is the
IANA-registered name of a SASL mechanism (e.g. "GSSAPI", "CRAM-MD5").authorisationID - 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.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.
null SaslClient created using the
parameters supplied. If null, this factory cannot produce a
SaslClient using the parameters supplied.
SaslException - if a SaslClient instance cannot be created
because of an error.public java.lang.String[] getMechanismNames(java.util.Map props)
SaslClientFactory
getMechanismNames in interface SaslClientFactoryprops - 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.
|
For the latest news and information visit The GNU Crypto project |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||