JavaMail API 1.6.2 · com.sun.mail.auth.OAuth2SaslClientFactory

Modifier and Type	Class and Description
pack-priv static class	OAuth2SaslClientFactory.OAuth2Provider

Modifier and Type	Field and Description
private static final String	MECHANISM_NAME
private static final String	PROVIDER_NAME

Access	Constructor and Description
public	OAuth2SaslClientFactory()

Method Summary

Modifier and Type	Method and Description
public SaslClient	createSaslClient(String[] The non-null list of mechanism names to try. Each is the IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5"). mechanisms, String 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. authorizationId, String The non-null string name of the protocol for which the authentication is being performed (e.g., "ldap"). protocol, String The non-null fully qualified host name of the server to authenticate to. serverName, Map<String, ?> 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. props, CallbackHandler 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. cbh) Implements javax.security.sasl.SaslClientFactory.createSaslClient. Creates a SaslClient using the parameters supplied.
public String[]	getMechanismNames(Map<String, ?> 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. props) Implements javax.security.sasl.SaslClientFactory.getMechanismNames. Returns an array of names of mechanisms that match the specified mechanism selection policies.
public static void	init() Initialize this OAUTH2 provider, but only if there isn't one already.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

MECHANISM_NAME	back to summary
private static final String MECHANISM_NAME

PROVIDER_NAME	back to summary
private static final String PROVIDER_NAME

OAuth2SaslClientFactory	back to summary
public OAuth2SaslClientFactory()

Method Detail

createSaslClient back to summary

createSaslClient	back to summary
public SaslClient createSaslClient(String[] mechanisms, String authorizationId, String protocol, String serverName, Map<String, ?> props, CallbackHandler cbh) throws SaslException Implements javax.security.sasl.SaslClientFactory.createSaslClient. Doc from javax.security.sasl.SaslClientFactory.createSaslClient. Creates a SaslClient using the parameters supplied. Parameters mechanisms:String[] 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:String 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:String The non-null string name of the protocol for which the authentication is being performed (e.g., "ldap"). serverName:String The non-null fully qualified host name of the server to authenticate to. props:Map<String, ?> 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:CallbackHandler 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:SaslClient A possibly null `SaslClient` created using the parameters supplied. If null, this factory cannot produce a `SaslClient` using the parameters supplied. Annotations @Override Exceptions SaslException: If cannot create a `SaslClient` because of an error.

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

Implements javax.security.sasl.SaslClientFactory.createSaslClient.

Doc from javax.security.sasl.SaslClientFactory.createSaslClient.

Creates a SaslClient using the parameters supplied.

Parameters

mechanisms:String[]: 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:String: 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:String: The non-null string name of the protocol for which the authentication is being performed (e.g., "ldap").
serverName:String: The non-null fully qualified host name of the server to authenticate to.
props:Map<String, ?>: 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:CallbackHandler: 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:SaslClient

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

Annotations

@Override

Exceptions

SaslException:: If cannot create a SaslClient because of an error.

getMechanismNames back to summary

getMechanismNames	back to summary
public String[] getMechanismNames(Map<String, ?> props) Implements javax.security.sasl.SaslClientFactory.getMechanismNames. Doc from javax.security.sasl.SaslClientFactory.getMechanismNames. Returns an array of names of mechanisms that match the specified mechanism selection policies. Parameters props:Map<String, ?> 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:String[] A non-null array containing a IANA-registered SASL mechanism names. Annotations @Override

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

Implements javax.security.sasl.SaslClientFactory.getMechanismNames.

Doc from javax.security.sasl.SaslClientFactory.getMechanismNames.

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

Parameters

props:Map<String, ?>: 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:String[]

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

Annotations

@Override

init	back to summary
public static void init() Initialize this OAUTH2 provider, but only if there isn't one already. If we're not allowed to add this provider, just give up silently.

public Class OAuth2SaslClientFactory

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class OAuth2SaslClientFactory.OAuth2Provider

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail