This class uses a provider-based architecture.
To create a CertPathValidator,
call one of the static getInstance methods, passing in the
algorithm name of the CertPathValidator 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 the validate method and passing it the CertPath to be validated
and an algorithm-specific set of parameters. If successful, the result is
returned in an object that implements the
CertPathValidatorResult interface.
The getRevocationChecker() method allows an application to specify
additional algorithm-specific parameters and options used by the
CertPathValidator when checking the revocation status of
certificates. Here is an example demonstrating how it is used with the PKIX
algorithm:
CertPathValidator cpv = CertPathValidator.getInstance("PKIX");
PKIXRevocationChecker rc = (PKIXRevocationChecker)cpv.getRevocationChecker();
rc.setOptions(EnumSet.of(Option.SOFT_FAIL));
params.addCertPathChecker(rc);
CertPathValidatorResult cpvr = cpv.validate(path, params);
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 different CertPathValidator
instance need not synchronize.
- Since:
- 1.4
- See Also:
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCertPathValidator(CertPathValidatorSpi validatorSpi, Provider provider, String algorithm) Creates aCertPathValidatorobject of the given algorithm, and encapsulates the given provider implementation (SPI object) in it. -
Method Summary
Modifier and TypeMethodDescriptionfinal StringReturns the algorithm name of thisCertPathValidator.static final StringReturns the defaultCertPathValidatortype as specified by thecertpathvalidator.typesecurity property, or the string "PKIX" if no such property exists.static CertPathValidatorgetInstance(String algorithm) Returns aCertPathValidatorobject that implements the specified algorithm.static CertPathValidatorgetInstance(String algorithm, String provider) Returns aCertPathValidatorobject that implements the specified algorithm.static CertPathValidatorgetInstance(String algorithm, Provider provider) Returns aCertPathValidatorobject that implements the specified algorithm.final ProviderReturns theProviderof thisCertPathValidator.final CertPathCheckerReturns aCertPathCheckerthat the encapsulatedCertPathValidatorSpiimplementation uses to check the revocation status of certificates.final CertPathValidatorResultvalidate(CertPath certPath, CertPathParameters params) Validates the specified certification path using the specified algorithm parameter set.
-
Constructor Details
-
CertPathValidator
Creates aCertPathValidatorobject 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 Details
-
getInstance
Returns aCertPathValidatorobject 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.- Implementation Note:
- The JDK Reference Implementation additionally uses the
jdk.security.provider.preferredSecurityproperty to determine the preferred provider order for the specified algorithm. This may be different from the order of providers returned bySecurity.getProviders(). - Parameters:
algorithm- the name of the requestedCertPathValidatoralgorithm. See the CertPathValidator section in the Java Security Standard Algorithm Names Specification for information about standard algorithm names.- Returns:
- a
CertPathValidatorobject that implements the specified algorithm - Throws:
NoSuchAlgorithmException- if noProvidersupports aCertPathValidatorSpiimplementation for the specified algorithmNullPointerException- ifalgorithmisnull- See Also:
-
getInstance
public static CertPathValidator getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException Returns aCertPathValidatorobject 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 requestedCertPathValidatoralgorithm. See the CertPathValidator section in the Java Security Standard Algorithm Names Specification for information about standard algorithm names.provider- the name of the provider.- Returns:
- a
CertPathValidatorobject that implements the specified algorithm - Throws:
IllegalArgumentException- if theproviderisnullor emptyNoSuchAlgorithmException- if aCertPathValidatorSpiimplementation for the specified algorithm is not available from the specified providerNoSuchProviderException- if the specified provider is not registered in the security provider listNullPointerException- ifalgorithmisnull- See Also:
-
getInstance
public static CertPathValidator getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException Returns aCertPathValidatorobject 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 requestedCertPathValidatoralgorithm. See the CertPathValidator section in the Java Security Standard Algorithm Names Specification for information about standard algorithm names.provider- the provider.- Returns:
- a
CertPathValidatorobject that implements the specified algorithm - Throws:
IllegalArgumentException- if theproviderisnullNoSuchAlgorithmException- if aCertPathValidatorSpiimplementation for the specified algorithm is not available from the specified Provider objectNullPointerException- ifalgorithmisnull- See Also:
-
getProvider
Returns theProviderof thisCertPathValidator.- Returns:
- the
Providerof thisCertPathValidator
-
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
CertPathspecified must be of a type that is supported by the validation algorithm, otherwise anInvalidAlgorithmParameterExceptionwill be thrown. For example, aCertPathValidatorthat implements the PKIX algorithm validatesCertPathobjects of type X.509.- Parameters:
certPath- theCertPathto be validatedparams- the algorithm parameters- Returns:
- the result of the validation algorithm
- Throws:
CertPathValidatorException- if theCertPathdoes not validateInvalidAlgorithmParameterException- if the specified parameters or the type of the specifiedCertPathare inappropriate for thisCertPathValidator
-
getDefaultType
Returns the defaultCertPathValidatortype as specified by thecertpathvalidator.typesecurity property, or the string "PKIX" if no such property exists.The default
CertPathValidatortype can be used by applications that do not want to use a hard-coded type when calling one of thegetInstancemethods, and want to provide a default type in case a user does not specify its own.The default
CertPathValidatortype can be changed by setting the value of thecertpathvalidator.typesecurity property to the desired type.- Returns:
- the default
CertPathValidatortype as specified by thecertpathvalidator.typesecurity property, or the string "PKIX" if no such property exists. - See Also:
-
getRevocationChecker
Returns aCertPathCheckerthat the encapsulatedCertPathValidatorSpiimplementation uses to check the revocation status of certificates. A PKIX implementation returns objects of typePKIXRevocationChecker. Each invocation of this method returns a new instance ofCertPathChecker.The primary purpose of this method is to allow callers to specify additional input parameters and options specific to revocation checking. See the class description for an example.
- Returns:
- a
CertPathChecker - Throws:
UnsupportedOperationException- if the service provider does not support this method- Since:
- 1.8
-