TrustManagerFactory

AI-generated Key Takeaways

• The TrustManagerFactory class acts as a factory for trust managers, which manage trust material for secure sockets.

• Android supports the PKIX algorithm for TrustManagerFactory.

• This factory can be initialized with a KeyStore or provider-specific parameters.

• TrustManagerFactory provides methods to get the algorithm, provider, and trust managers.

• You can obtain an instance of TrustManagerFactory using the getInstance() methods.

public class TrustManagerFactory extends Object

This class acts as a factory for trust managers based on a source of trust material. Each trust manager manages a specific type of trust material for use by secure sockets. The trust material is based on a KeyStore and/or provider specific sources.

Android provides the following TrustManagerFactory algorithms:

Algorithm	Supported API Levels
PKIX	1+

See Also

• TrustManager

Protected Constructor Summary

TrustManagerFactory(TrustManagerFactorySpi factorySpi, Provider provider, String algorithm) Creates a TrustManagerFactory object.

Public Method Summary

final String	getAlgorithm() Returns the algorithm name of this TrustManagerFactory object.
final static String	getDefaultAlgorithm() Obtains the default TrustManagerFactory algorithm name.
final static TrustManagerFactory	getInstance(String algorithm) Returns a TrustManagerFactory object that acts as a factory for trust managers.
final static TrustManagerFactory	getInstance(String algorithm, String provider) Returns a TrustManagerFactory object that acts as a factory for trust managers.
final static TrustManagerFactory	getInstance(String algorithm, Provider provider) Returns a TrustManagerFactory object that acts as a factory for trust managers.
final Provider	getProvider() Returns the provider of this TrustManagerFactory object.
final TrustManager[]	getTrustManagers() Returns one trust manager for each type of trust material.
final void	init(ManagerFactoryParameters spec) Initializes this factory with a source of provider-specific trust material.
final void	init(KeyStore ks) Initializes this factory with a source of certificate authorities and related trust material.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Protected Constructors

protected TrustManagerFactory (TrustManagerFactorySpi factorySpi, Provider provider, String algorithm)

Creates a TrustManagerFactory object.

Parameters

factorySpi	the delegate
provider	the provider
algorithm	the algorithm

Public Methods

public final String getAlgorithm ()

Returns the algorithm name of this TrustManagerFactory object.

This is the same name that was specified in one of the getInstance calls that created this TrustManagerFactory object.

Returns

• the algorithm name of this TrustManagerFactory object

public static final String getDefaultAlgorithm ()

Obtains the default TrustManagerFactory algorithm name.

The default TrustManager can be changed at runtime by setting the value of the ssl.TrustManagerFactory.algorithm security property to the desired algorithm name.

Returns

• the default algorithm name as specified by the ssl.TrustManagerFactory.algorithm security property, or an implementation-specific default if no such property exists.

See Also

• security properties

public static final TrustManagerFactory getInstance (String algorithm)

Returns a TrustManagerFactory object that acts as a factory for trust managers.

This method traverses the list of registered security Providers, starting with the most preferred Provider. A new TrustManagerFactory object encapsulating the TrustManagerFactorySpi implementation from the first Provider that supports the specified algorithm is returned.

Note that the list of registered providers may be retrieved via the Security.getProviders() method.

Parameters

algorithm	the standard name of the requested trust management algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names.

Returns

• the new TrustManagerFactory object.

Throws

NoSuchAlgorithmException	if no Provider supports a TrustManagerFactorySpi implementation for the specified algorithm.
NullPointerException	if algorithm is null.

See Also

• Provider

public static final TrustManagerFactory getInstance (String algorithm, String provider)

Returns a TrustManagerFactory object that acts as a factory for trust managers.

A new KeyManagerFactory object encapsulating the KeyManagerFactorySpi implementation from the specified provider is returned. The specified provider must be registered in the security provider list.

Note that the list of registered providers may be retrieved via the Security.getProviders() method.

Parameters

algorithm	the standard name of the requested trust management algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names.
provider	the name of the provider.

Returns

• the new TrustManagerFactory object

Throws

NoSuchAlgorithmException	if a TrustManagerFactorySpi implementation for the specified algorithm is not available from the specified provider.
NoSuchProviderException	if the specified provider is not registered in the security provider list.
IllegalArgumentException	if the provider name is null or empty.
NullPointerException	if algorithm is null.

See Also

• Provider

public static final TrustManagerFactory getInstance (String algorithm, Provider provider)

Returns a TrustManagerFactory object that acts as a factory for trust managers.

A new TrustManagerFactory object encapsulating the TrustManagerFactorySpi implementation from the specified Provider object is returned. Note that the specified Provider object does not have to be registered in the provider list.

Parameters

algorithm	the standard name of the requested trust management algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names.
provider	an instance of the provider.

Returns

• the new TrustManagerFactory object.

Throws

NoSuchAlgorithmException	if a TrustManagerFactorySpi implementation for the specified algorithm is not available from the specified Provider object.
IllegalArgumentException	if the provider is null.
NullPointerException	if algorithm is null.

See Also

• Provider

public final Provider getProvider ()

Returns the provider of this TrustManagerFactory object.

Returns

• the provider of this TrustManagerFactory object

public final TrustManager[] getTrustManagers ()

Returns one trust manager for each type of trust material.

Returns

• the trust managers

Throws

IllegalStateException	if the factory is not initialized.

public final void init (ManagerFactoryParameters spec)

Initializes this factory with a source of provider-specific trust material.

In some cases, initialization parameters other than a keystore may be needed by a provider. Users of that particular provider are expected to pass an implementation of the appropriate ManagerFactoryParameters as defined by the provider. The provider can then call the specified methods in the ManagerFactoryParameters implementation to obtain the needed information.

Parameters

spec	an implementation of a provider-specific parameter specification

Throws

InvalidAlgorithmParameterException	if an error is encountered

public final void init (KeyStore ks)

Initializes this factory with a source of certificate authorities and related trust material.

The provider typically uses a KeyStore as a basis for making trust decisions.

For more flexible initialization, please see init(ManagerFactoryParameters).

Parameters

ks	the key store, or null

Throws

KeyStoreException	if this operation fails