Summary: Protected Ctors | Methods | Inherited Methods

TrustManagerFactory

public class TrustManagerFactory
extends Object

java.lang.Object
↳	javax.net.ssl.TrustManagerFactory

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

Summary

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

Public methods
`final String`	`getAlgorithm()` Returns the algorithm name of this `TrustManagerFactory` object.
`static final String`	`getDefaultAlgorithm()` Obtains the default TrustManagerFactory algorithm name.
`static final TrustManagerFactory`	`getInstance(String algorithm)` Returns a `TrustManagerFactory` object that acts as a factory for trust managers.
`static final TrustManagerFactory`	`getInstance(String algorithm, String provider)` Returns a `TrustManagerFactory` object that acts as a factory for trust managers.
`static final 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 methods

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Protected constructors

TrustManagerFactory

Added in API level 1

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

Creates a TrustManagerFactory object.

Parameters
`factorySpi`	`TrustManagerFactorySpi`: the delegate
`provider`	`Provider`: the provider
`algorithm`	`String`: the algorithm

Public methods

getAlgorithm

Added in API level 1

 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
`String`	the algorithm name of this `TrustManagerFactory` object

getDefaultAlgorithm

Added in API level 1

 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
`String`	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

getInstance

Added in API level 1

 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`	`String`: the standard name of the requested trust management algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names.

Returns
`TrustManagerFactory`	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

getInstance

Added in API level 1

 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`	`String`: the standard name of the requested trust management algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names.
`provider`	`String`: the name of the provider.

Returns
`TrustManagerFactory`	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

getInstance

Added in API level 1

 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`	`String`: the standard name of the requested trust management algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names.
`provider`	`Provider`: an instance of the provider.

Returns
`TrustManagerFactory`	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

getProvider

Added in API level 1

 public final Provider getProvider ()

Returns the provider of this TrustManagerFactory object.

Returns
`Provider`	the provider of this `TrustManagerFactory` object

getTrustManagers

Added in API level 1

 public final TrustManager[] getTrustManagers ()

Returns one trust manager for each type of trust material.

Returns
`TrustManager[]`	the trust managers

Throws
`IllegalStateException`	if the factory is not initialized.

init

Added in API level 1

 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`	`ManagerFactoryParameters`: an implementation of a provider-specific parameter specification

Throws
`InvalidAlgorithmParameterException`	if an error is encountered

init

Added in API level 1

 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(javax.net.ssl.ManagerFactoryParameters).

Parameters
`ks`	`KeyStore`: the key store, or null

Throws
`KeyStoreException`	if this operation fails