- java.lang.Object
-
- java.security.cert.CertPathValidator
-
public class CertPathValidator extends Object
A class for validating certification paths (also known as certificate chains).This class uses a provider-based architecture. To create a
CertPathValidator
, call one of the staticgetInstance
methods, passing in the algorithm name of theCertPathValidator
desired and optionally the name of the provider desired.Once a
CertPathValidator
object has been created, it can be used to validate certification paths by calling thevalidate
method and passing it theCertPath
to be validated and an algorithm-specific set of parameters. If successful, the result is returned in an object that implements theCertPathValidatorResult
interface.Every implementation of the Java platform is required to support the following standard
CertPathValidator
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
CertPathValidator
instance concurrently should synchronize amongst themselves and provide the necessary locking. Multiple threads each manipulating a differentCertPathValidator
instance need not synchronize.- Since:
- 1.4
- See Also:
CertPath
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
CertPathValidator(CertPathValidatorSpi validatorSpi, Provider provider, String algorithm)
Creates aCertPathValidator
object of the given algorithm, and encapsulates the given provider implementation (SPI object) in it.
-
Method Summary
Methods Modifier and Type Method and Description String
getAlgorithm()
Returns the algorithm name of thisCertPathValidator
.static String
getDefaultType()
Returns the defaultCertPathValidator
type as specified in the Java security properties file, or the string "PKIX" if no such property exists.static CertPathValidator
getInstance(String algorithm)
Returns aCertPathValidator
object that implements the specified algorithm.static CertPathValidator
getInstance(String algorithm, Provider provider)
Returns aCertPathValidator
object that implements the specified algorithm.static CertPathValidator
getInstance(String algorithm, String provider)
Returns aCertPathValidator
object that implements the specified algorithm.Provider
getProvider()
Returns theProvider
of thisCertPathValidator
.CertPathValidatorResult
validate(CertPath certPath, CertPathParameters params)
Validates the specified certification path using the specified algorithm parameter set.
-
-
-
Constructor Detail
-
CertPathValidator
protected CertPathValidator(CertPathValidatorSpi validatorSpi, Provider provider, String algorithm)
Creates aCertPathValidator
object of the given algorithm, and encapsulates the given provider implementation (SPI object) in it.- Parameters:
validatorSpi
- the provider implementationprovider
- the provideralgorithm
- the algorithm name
-
-
Method Detail
-
getInstance
public static CertPathValidator getInstance(String algorithm) throws NoSuchAlgorithmException
Returns aCertPathValidator
object that implements the specified algorithm.This method traverses the list of registered security Providers, starting with the most preferred Provider. A new CertPathValidator object encapsulating the CertPathValidatorSpi 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 requestedCertPathValidator
algorithm. See the CertPathValidator section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.- Returns:
- a
CertPathValidator
object that implements the specified algorithm. - Throws:
NoSuchAlgorithmException
- if no Provider supports a CertPathValidatorSpi implementation for the specified algorithm.- See Also:
Provider
-
getInstance
public static CertPathValidator getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
Returns aCertPathValidator
object that implements the specified algorithm.A new CertPathValidator object encapsulating the CertPathValidatorSpi 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 requestedCertPathValidator
algorithm. See the CertPathValidator section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.provider
- the name of the provider.- Returns:
- a
CertPathValidator
object that implements the specified algorithm. - Throws:
NoSuchAlgorithmException
- if a CertPathValidatorSpi 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 CertPathValidator getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
Returns aCertPathValidator
object that implements the specified algorithm.A new CertPathValidator object encapsulating the CertPathValidatorSpi 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 requestedCertPathValidator
algorithm. See the CertPathValidator section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.provider
- the provider.- Returns:
- a
CertPathValidator
object that implements the specified algorithm. - Throws:
NoSuchAlgorithmException
- if a CertPathValidatorSpi 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 theProvider
of thisCertPathValidator
.- Returns:
- the
Provider
of thisCertPathValidator
-
getAlgorithm
public final String getAlgorithm()
Returns the algorithm name of thisCertPathValidator
.- Returns:
- the algorithm name of this
CertPathValidator
-
validate
public final CertPathValidatorResult validate(CertPath certPath, CertPathParameters params) throws CertPathValidatorException, InvalidAlgorithmParameterException
Validates the specified certification path using the specified algorithm parameter set.The
CertPath
specified must be of a type that is supported by the validation algorithm, otherwise anInvalidAlgorithmParameterException
will be thrown. For example, aCertPathValidator
that implements the PKIX algorithm validatesCertPath
objects of type X.509.- Parameters:
certPath
- theCertPath
to be validatedparams
- the algorithm parameters- Returns:
- the result of the validation algorithm
- Throws:
CertPathValidatorException
- if theCertPath
does not validateInvalidAlgorithmParameterException
- if the specified parameters or the type of the specifiedCertPath
are inappropriate for thisCertPathValidator
-
getDefaultType
public static final String getDefaultType()
Returns the defaultCertPathValidator
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
CertPathValidator
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
CertPathValidator
type can be changed by setting the value of the "certpathvalidator.type" security property (in the Java security properties file) to the desired type.- Returns:
- the default
CertPathValidator
type as specified in the Java security properties file, or the string "PKIX" if no such property exists.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/security/cert/certpathvalidator.html/.html/
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.