public class CertPathValidator extends Object
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:
PKIXConcurrent 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.
CertPath| Modifier | Constructor and Description |
|---|---|
protected |
CertPathValidator(CertPathValidatorSpi validatorSpi,
Provider provider,
String algorithm)
Creates a
CertPathValidator object of the given algorithm,
and encapsulates the given provider implementation (SPI object) in it. |
| Modifier and Type | Method and Description |
|---|---|
String |
getAlgorithm()
Returns the algorithm name of this
CertPathValidator. |
static String |
getDefaultType()
Returns the default
CertPathValidator type as specified by
the certpathvalidator.type security property, or the string
"PKIX" if no such property exists. |
static CertPathValidator |
getInstance(String algorithm)
Returns a
CertPathValidator object that implements the
specified algorithm. |
static CertPathValidator |
getInstance(String algorithm,
Provider provider)
Returns a
CertPathValidator object that implements the
specified algorithm. |
static CertPathValidator |
getInstance(String algorithm,
String provider)
Returns a
CertPathValidator object that implements the
specified algorithm. |
Provider |
getProvider()
Returns the
Provider of this
CertPathValidator. |
CertPathChecker |
getRevocationChecker()
Returns a
CertPathChecker that the encapsulated
CertPathValidatorSpi implementation uses to check the revocation
status of certificates. |
CertPathValidatorResult |
validate(CertPath certPath,
CertPathParameters params)
Validates the specified certification path using the specified
algorithm parameter set.
|
protected CertPathValidator(CertPathValidatorSpi validatorSpi, Provider provider, String algorithm)
CertPathValidator object of the given algorithm,
and encapsulates the given provider implementation (SPI object) in it.validatorSpi - the provider implementationprovider - the provideralgorithm - the algorithm namepublic static CertPathValidator getInstance(String algorithm) throws NoSuchAlgorithmException
CertPathValidator 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.
algorithm - the name of the requested CertPathValidator
algorithm. See the CertPathValidator section in the
Java Cryptography Architecture Standard Algorithm Name Documentation
for information about standard algorithm names.CertPathValidator object that implements the
specified algorithm.NoSuchAlgorithmException - if no Provider supports a
CertPathValidatorSpi implementation for the
specified algorithm.Providerpublic static CertPathValidator getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
CertPathValidator 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.
algorithm - the name of the requested CertPathValidator
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.CertPathValidator object that implements the
specified algorithm.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 the provider is
null or empty.Providerpublic static CertPathValidator getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
CertPathValidator 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.
algorithm - the name of the requested CertPathValidator
algorithm. See the CertPathValidator section in the
Java Cryptography Architecture Standard Algorithm Name Documentation
for information about standard algorithm names.provider - the provider.CertPathValidator object that implements the
specified algorithm.NoSuchAlgorithmException - if a CertPathValidatorSpi
implementation for the specified algorithm is not available
from the specified Provider object.IllegalArgumentException - if the provider is
null.Providerpublic final Provider getProvider()
Provider of this
CertPathValidator.Provider of this CertPathValidatorpublic final String getAlgorithm()
CertPathValidator.CertPathValidatorpublic final CertPathValidatorResult validate(CertPath certPath, CertPathParameters params) throws CertPathValidatorException, InvalidAlgorithmParameterException
The CertPath specified must be of a type that is
supported by the validation algorithm, otherwise an
InvalidAlgorithmParameterException will be thrown. For
example, a CertPathValidator that implements the PKIX
algorithm validates CertPath objects of type X.509.
certPath - the CertPath to be validatedparams - the algorithm parametersCertPathValidatorException - if the CertPath
does not validateInvalidAlgorithmParameterException - if the specified
parameters or the type of the specified CertPath are
inappropriate for this CertPathValidatorpublic static final String getDefaultType()
CertPathValidator type as specified by
the certpathvalidator.type security property, or the string
"PKIX" if no such property exists.
The default CertPathValidator type can be used by
applications that do not want to use a hard-coded type when calling one
of the getInstance 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 to the desired type.
CertPathValidator type as specified
by the certpathvalidator.type security property, or the string
"PKIX" if no such property exists.security propertiespublic final CertPathChecker getRevocationChecker()
CertPathChecker that the encapsulated
CertPathValidatorSpi implementation uses to check the revocation
status of certificates. A PKIX implementation returns objects of
type PKIXRevocationChecker. Each invocation of this method
returns a new instance of CertPathChecker.
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.
CertPathCheckerUnsupportedOperationException - if the service provider does not
support this method 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, 2018, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.