public class CertPathBuilder extends Object
This class uses a provider-based architecture.
To create a CertPathBuilder
, call
one of the static getInstance
methods, passing in the
algorithm name of the CertPathBuilder
desired and optionally
the name of the provider desired.
Once a CertPathBuilder
object has been created, certification
paths can be constructed by calling the build
method and
passing it an algorithm-specific set of parameters. If successful, the
result (including the CertPath
that was built) is returned
in an object that implements the CertPathBuilderResult
interface.
The getRevocationChecker()
method allows an application to specify
additional algorithm-specific parameters and options used by the
CertPathBuilder
when checking the revocation status of certificates.
Here is an example demonstrating how it is used with the PKIX algorithm:
CertPathBuilder cpb = CertPathBuilder.getInstance("PKIX"); PKIXRevocationChecker rc = (PKIXRevocationChecker)cpb.getRevocationChecker(); rc.setOptions(EnumSet.of(Option.PREFER_CRLS)); params.addCertPathChecker(rc); CertPathBuilderResult cpbr = cpb.build(params);
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 different CertPathBuilder
instance
need not synchronize.
CertPath
Modifier | Constructor | Description |
---|---|---|
protected |
CertPathBuilder(CertPathBuilderSpi builderSpi,
Provider provider,
String algorithm) |
Creates a
CertPathBuilder object of the given algorithm,
and encapsulates the given provider implementation (SPI object) in it. |
Modifier and Type | Method | 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 this
CertPathBuilder . |
static String |
getDefaultType() |
Returns the default
CertPathBuilder type as specified by
the certpathbuilder.type security property, or the string
"PKIX" if no such property exists. |
static CertPathBuilder |
getInstance(String algorithm) |
Returns a
CertPathBuilder object that implements the
specified algorithm. |
static CertPathBuilder |
getInstance(String algorithm,
String provider) |
Returns a
CertPathBuilder object that implements the
specified algorithm. |
static CertPathBuilder |
getInstance(String algorithm,
Provider provider) |
Returns a
CertPathBuilder object that implements the
specified algorithm. |
Provider |
getProvider() |
Returns the provider of this
CertPathBuilder . |
CertPathChecker |
getRevocationChecker() |
Returns a
CertPathChecker that the encapsulated
CertPathBuilderSpi implementation uses to check the revocation
status of certificates. |
protected CertPathBuilder(CertPathBuilderSpi builderSpi, Provider provider, String algorithm)
CertPathBuilder
object of the given algorithm,
and encapsulates the given provider implementation (SPI object) in it.builderSpi
- the provider implementationprovider
- the provideralgorithm
- the algorithm namepublic static CertPathBuilder getInstance(String algorithm) throws NoSuchAlgorithmException
CertPathBuilder
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.
jdk.security.provider.preferred
Security
property to determine
the preferred provider order for the specified algorithm. This
may be different than the order of providers returned by
Security.getProviders()
.algorithm
- the name of the requested CertPathBuilder
algorithm. See the CertPathBuilder section in the
Java Cryptography Architecture Standard Algorithm Name Documentation
for information about standard algorithm names.CertPathBuilder
object that implements the
specified algorithmNoSuchAlgorithmException
- if no Provider
supports a
CertPathBuilderSpi
implementation for the
specified algorithmNullPointerException
- if algorithm
is null
Provider
public static CertPathBuilder getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
CertPathBuilder
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.
algorithm
- the name of the requested CertPathBuilder
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.CertPathBuilder
object that implements the
specified algorithmIllegalArgumentException
- if the provider
is
null
or emptyNoSuchAlgorithmException
- if a CertPathBuilderSpi
implementation for the specified algorithm is not
available from the specified providerNoSuchProviderException
- if the specified provider is not
registered in the security provider listNullPointerException
- if algorithm
is null
Provider
public static CertPathBuilder getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
CertPathBuilder
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.
algorithm
- the name of the requested CertPathBuilder
algorithm. See the CertPathBuilder section in the
Java Cryptography Architecture Standard Algorithm Name Documentation
for information about standard algorithm names.provider
- the provider.CertPathBuilder
object that implements the
specified algorithmIllegalArgumentException
- if the provider
is
null
NoSuchAlgorithmException
- if a CertPathBuilderSpi
implementation for the specified algorithm is not available
from the specified Provider
objectNullPointerException
- if algorithm
is null
Provider
public final Provider getProvider()
CertPathBuilder
.CertPathBuilder
public final String getAlgorithm()
CertPathBuilder
.CertPathBuilder
public final CertPathBuilderResult build(CertPathParameters params) throws CertPathBuilderException, InvalidAlgorithmParameterException
params
- the algorithm parametersCertPathBuilderException
- if the builder is unable to construct
a certification path that satisfies the specified parametersInvalidAlgorithmParameterException
- if the specified parameters
are inappropriate for this CertPathBuilder
public static final String getDefaultType()
CertPathBuilder
type as specified by
the certpathbuilder.type
security property, or the string
"PKIX" if no such property exists.
The default CertPathBuilder
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 CertPathBuilder
type can be changed by
setting the value of the certpathbuilder.type
security property
to the desired type.
CertPathBuilder
type as specified
by the certpathbuilder.type
security property, or the string
"PKIX" if no such property exists.security properties
public final CertPathChecker getRevocationChecker()
CertPathChecker
that the encapsulated
CertPathBuilderSpi
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.
CertPathChecker
UnsupportedOperationException
- 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, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-internal+0-adhoc.mlchung.jdk9-jdeps