TrustManagerFactory (Java Platform SE 7 ) (original) (raw)

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

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.
Since:
1.4
See Also:
TrustManager

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TrustManagerFactory(TrustManagerFactorySpi factorySpi,Provider provider,String algorithm) Creates a TrustManagerFactory object.

Method Summary

Methods

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

   * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
   `[clone](../../../java/lang/Object.html#clone%28%29), [equals](../../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../java/lang/Object.html#finalize%28%29), [getClass](../../../java/lang/Object.html#getClass%28%29), [hashCode](../../../java/lang/Object.html#hashCode%28%29), [notify](../../../java/lang/Object.html#notify%28%29), [notifyAll](../../../java/lang/Object.html#notifyAll%28%29), [toString](../../../java/lang/Object.html#toString%28%29), [wait](../../../java/lang/Object.html#wait%28%29), [wait](../../../java/lang/Object.html#wait%28long%29), [wait](../../../java/lang/Object.html#wait%28long,%20int%29)`

Constructor Detail

 * #### TrustManagerFactory  
 protected TrustManagerFactory([TrustManagerFactorySpi](../../../javax/net/ssl/TrustManagerFactorySpi.html "class in javax.net.ssl") factorySpi,  
                    [Provider](../../../java/security/Provider.html "class in java.security") provider,  
                    [String](../../../java/lang/String.html "class in java.lang") algorithm)  
 Creates a TrustManagerFactory object.  
 Parameters:  
 `factorySpi` \- the delegate  
 `provider` \- the provider  
 `algorithm` \- the algorithm

Method Detail

* #### getDefaultAlgorithm  
public static final [String](../../../java/lang/String.html "class in java.lang") 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[Security.setProperty(String, String)](../../../java/security/Security.html#setProperty%28java.lang.String,%20java.lang.String%29)) to the desired algorithm name.  
Returns:  
the default algorithm name as specified in the Java security properties, or an implementation-specific default if no such property exists.  
* #### getAlgorithm  
public final [String](../../../java/lang/String.html "class in java.lang") 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  
* #### getInstance  
public static final [TrustManagerFactory](../../../javax/net/ssl/TrustManagerFactory.html "class in javax.net.ssl") getInstance([String](../../../java/lang/String.html "class in java.lang") algorithm)  
                                             throws [NoSuchAlgorithmException](../../../java/security/NoSuchAlgorithmException.html "class in java.security")  
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()](../../../java/security/Security.html#getProviders%28%29) method.  
Parameters:  
`algorithm` \- the standard name of the requested trust management algorithm. See the [ Java Secure Socket Extension Reference Guide ](../../../../technotes/guides/security/jsse/JSSERefGuide.html) for information about standard algorithm names.  
Returns:  
the new `TrustManagerFactory` object.  
Throws:  
`[NoSuchAlgorithmException](../../../java/security/NoSuchAlgorithmException.html "class in java.security")` \- if no Provider supports a TrustManagerFactorySpi implementation for the specified algorithm.  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if algorithm is null.  
See Also:  
[Provider](../../../java/security/Provider.html "class in java.security")  
* #### getInstance  
public static final [TrustManagerFactory](../../../javax/net/ssl/TrustManagerFactory.html "class in javax.net.ssl") getInstance([String](../../../java/lang/String.html "class in java.lang") algorithm,  
                              [String](../../../java/lang/String.html "class in java.lang") provider)  
                                             throws [NoSuchAlgorithmException](../../../java/security/NoSuchAlgorithmException.html "class in java.security"),  
                                                    [NoSuchProviderException](../../../java/security/NoSuchProviderException.html "class in java.security")  
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()](../../../java/security/Security.html#getProviders%28%29) method.  
Parameters:  
`algorithm` \- the standard name of the requested trust management algorithm. See the [ Java Secure Socket Extension Reference Guide ](../../../../technotes/guides/security/jsse/JSSERefGuide.html) for information about standard algorithm names.  
`provider` \- the name of the provider.  
Returns:  
the new `TrustManagerFactory` object  
Throws:  
`[NoSuchAlgorithmException](../../../java/security/NoSuchAlgorithmException.html "class in java.security")` \- if a TrustManagerFactorySpi implementation for the specified algorithm is not available from the specified provider.  
`[NoSuchProviderException](../../../java/security/NoSuchProviderException.html "class in java.security")` \- if the specified provider is not registered in the security provider list.  
`[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the provider name is null or empty.  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if algorithm is null.  
See Also:  
[Provider](../../../java/security/Provider.html "class in java.security")  
* #### getInstance  
public static final [TrustManagerFactory](../../../javax/net/ssl/TrustManagerFactory.html "class in javax.net.ssl") getInstance([String](../../../java/lang/String.html "class in java.lang") algorithm,  
                              [Provider](../../../java/security/Provider.html "class in java.security") provider)  
                                             throws [NoSuchAlgorithmException](../../../java/security/NoSuchAlgorithmException.html "class in java.security")  
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 ](../../../../technotes/guides/security/jsse/JSSERefGuide.html) for information about standard algorithm names.  
`provider` \- an instance of the provider.  
Returns:  
the new `TrustManagerFactory` object.  
Throws:  
`[NoSuchAlgorithmException](../../../java/security/NoSuchAlgorithmException.html "class in java.security")` \- if a TrustManagerFactorySpi implementation for the specified algorithm is not available from the specified Provider object.  
`[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the provider is null.  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if algorithm is null.  
See Also:  
[Provider](../../../java/security/Provider.html "class in java.security")  
* #### getProvider  
public final [Provider](../../../java/security/Provider.html "class in java.security") getProvider()  
Returns the provider of this `TrustManagerFactory` object.  
Returns:  
the provider of this `TrustManagerFactory` object  
* #### init  
public final void init([KeyStore](../../../java/security/KeyStore.html "class in java.security") ks)  
                throws [KeyStoreException](../../../java/security/KeyStoreException.html "class in java.security")  
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)](../../../javax/net/ssl/TrustManagerFactory.html#init%28javax.net.ssl.ManagerFactoryParameters%29).  
Parameters:  
`ks` \- the key store, or null  
Throws:  
`[KeyStoreException](../../../java/security/KeyStoreException.html "class in java.security")` \- if this operation fails  
* #### init  
public final void init([ManagerFactoryParameters](../../../javax/net/ssl/ManagerFactoryParameters.html "interface in javax.net.ssl") spec)  
                throws [InvalidAlgorithmParameterException](../../../java/security/InvalidAlgorithmParameterException.html "class in java.security")  
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](../../../java/security/InvalidAlgorithmParameterException.html "class in java.security")` \- if an error is encountered  
* #### getTrustManagers  
public final [TrustManager](../../../javax/net/ssl/TrustManager.html "interface in javax.net.ssl")[] getTrustManagers()  
Returns one trust manager for each type of trust material.  
Returns:  
the trust managers  
Throws:  
`[IllegalStateException](../../../java/lang/IllegalStateException.html "class in java.lang")` \- if the factory is not initialized.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

TrustManagerFactory (Java Platform SE 7 ) (original) (raw)

Constructor Summary

Method Summary

Constructor Detail

Method Detail