Skip to content

Most visited

Recently visited

navigation

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.

See also:

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

Protected constructors

TrustManagerFactory

Added in API level 1
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
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
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 (set in the Java security properties file or by calling setProperty(String, String)) to the desired algorithm name.

Returns
String the default algorithm name as specified in the Java security properties, or an implementation-specific default if no such property exists.

getInstance

Added in API level 1
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:

getInstance

Added in API level 1
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:

getInstance

Added in API level 1
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:

getProvider

Added in API level 1
Provider getProvider ()

Returns the provider of this TrustManagerFactory object.

Returns
Provider the provider of this TrustManagerFactory object

getTrustManagers

Added in API level 1
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
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
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 KeyStore: the key store, or null
Throws
KeyStoreException if this operation fails
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.