- java.lang.Object
-
- java.security.cert.CertPathBuilder
-
public class CertPathBuilder extends Object
A class for building certification paths (also known as certificate chains).This class uses a provider-based architecture. To create a
CertPathBuilder
, call one of the staticgetInstance
methods, passing in the algorithm name of theCertPathBuilder
desired and optionally the name of the provider desired.Once a
CertPathBuilder
object has been created, certification paths can be constructed by calling thebuild
method and passing it an algorithm-specific set of parameters. If successful, the result (including theCertPath
that was built) is returned in an object that implements theCertPathBuilderResult
interface.Every implementation of the Java platform is required to support the following standard
CertPathBuilder
algorithm:- PKIX
Concurrent Access
The static methods of this class are guaranteed to be thread-safe. Multiple threads may concurrently invoke the static methods defined in this class with no ill effects.
However, this is not true for the non-static methods defined by this class. Unless otherwise documented by a specific provider, threads that need to access a single
CertPathBuilder
instance concurrently should synchronize amongst themselves and provide the necessary locking. Multiple threads each manipulating a differentCertPathBuilder
instance need not synchronize.- Since:
- 1.4
- See Also:
CertPath
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
CertPathBuilder(CertPathBuilderSpi builderSpi, Provider provider, String algorithm)
Creates aCertPathBuilder
object of the given algorithm, and encapsulates the given provider implementation (SPI object) in it.
-
Method Summary
Methods Modifier and Type Method and Description CertPathBuilderResult
build(CertPathParameters params)
Attempts to build a certification path using the specified algorithm parameter set.String
getAlgorithm()
Returns the name of the algorithm of thisCertPathBuilder
.static String
getDefaultType()
Returns the defaultCertPathBuilder
type as specified in the Java security properties file, or the string "PKIX" if no such property exists.static CertPathBuilder
getInstance(String algorithm)
Returns aCertPathBuilder
object that implements the specified algorithm.static CertPathBuilder
getInstance(String algorithm, Provider provider)
Returns aCertPathBuilder
object that implements the specified algorithm.static CertPathBuilder
getInstance(String algorithm, String provider)
Returns aCertPathBuilder
object that implements the specified algorithm.Provider
getProvider()
Returns the provider of thisCertPathBuilder
.
-
-
-
Constructor Detail
-
CertPathBuilder
protected CertPathBuilder(CertPathBuilderSpi builderSpi, Provider provider, String algorithm)
Creates aCertPathBuilder
object of the given algorithm, and encapsulates the given provider implementation (SPI object) in it.- Parameters:
builderSpi
- the provider implementationprovider
- the provideralgorithm
- the algorithm name
-
-
Method Detail
-
getInstance
public static CertPathBuilder getInstance(String algorithm) throws NoSuchAlgorithmException
Returns aCertPathBuilder
object that implements the specified algorithm.This method traverses the list of registered security Providers, starting with the most preferred Provider. A new CertPathBuilder object encapsulating the CertPathBuilderSpi 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 name of the requestedCertPathBuilder
algorithm. See the CertPathBuilder section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.- Returns:
- a
CertPathBuilder
object that implements the specified algorithm. - Throws:
NoSuchAlgorithmException
- if no Provider supports a CertPathBuilderSpi implementation for the specified algorithm.- See Also:
Provider
-
getInstance
public static CertPathBuilder getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
Returns aCertPathBuilder
object that implements the specified algorithm.A new CertPathBuilder object encapsulating the CertPathBuilderSpi 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 name of the requestedCertPathBuilder
algorithm. See the CertPathBuilder section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.provider
- the name of the provider.- Returns:
- a
CertPathBuilder
object that implements the specified algorithm. - Throws:
NoSuchAlgorithmException
- if a CertPathBuilderSpi 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 theprovider
is null or empty.- See Also:
Provider
-
getInstance
public static CertPathBuilder getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
Returns aCertPathBuilder
object that implements the specified algorithm.A new CertPathBuilder object encapsulating the CertPathBuilderSpi 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 name of the requestedCertPathBuilder
algorithm. See the CertPathBuilder section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.provider
- the provider.- Returns:
- a
CertPathBuilder
object that implements the specified algorithm. - Throws:
NoSuchAlgorithmException
- if a CertPathBuilderSpi implementation for the specified algorithm is not available from the specified Provider object.IllegalArgumentException
- if theprovider
is null.- See Also:
Provider
-
getProvider
public final Provider getProvider()
Returns the provider of thisCertPathBuilder
.- Returns:
- the provider of this
CertPathBuilder
-
getAlgorithm
public final String getAlgorithm()
Returns the name of the algorithm of thisCertPathBuilder
.- Returns:
- the name of the algorithm of this
CertPathBuilder
-
build
public final CertPathBuilderResult build(CertPathParameters params) throws CertPathBuilderException, InvalidAlgorithmParameterException
Attempts to build a certification path using the specified algorithm parameter set.- Parameters:
params
- the algorithm parameters- Returns:
- the result of the build algorithm
- Throws:
CertPathBuilderException
- if the builder is unable to construct a certification path that satisfies the specified parametersInvalidAlgorithmParameterException
- if the specified parameters are inappropriate for thisCertPathBuilder
-
getDefaultType
public static final String getDefaultType()
Returns the defaultCertPathBuilder
type as specified in the Java security properties file, or the string "PKIX" if no such property exists. The Java security properties file is located in the file named <JAVA_HOME>/lib/security/java.security. <JAVA_HOME> refers to the value of the java.home system property, and specifies the directory where the JRE is installed.The default
CertPathBuilder
type can be used by applications that do not want to use a hard-coded type when calling one of thegetInstance
methods, and want to provide a default type in case a user does not specify its own.The default
CertPathBuilder
type can be changed by setting the value of the "certpathbuilder.type" security property (in the Java security properties file) to the desired type.- Returns:
- the default
CertPathBuilder
type as specified in the Java security properties file, or the string "PKIX" if no such property exists.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
05/11/2024 17:24:46 Cette version de la page est en cache (à la date du 05/11/2024 17:24:46) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 31/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-java/security/cert/CertPathBuilder.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.