- 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 staticgetInstancemethods, passing in the algorithm name of theCertPathBuilderdesired and optionally the name of the provider desired.Once a
CertPathBuilderobject has been created, certification paths can be constructed by calling thebuildmethod and passing it an algorithm-specific set of parameters. If successful, the result (including theCertPaththat was built) is returned in an object that implements theCertPathBuilderResultinterface.The
getRevocationChecker()method allows an application to specify additional algorithm-specific parameters and options used by theCertPathBuilderwhen 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
CertPathBuilderalgorithm: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
CertPathBuilderinstance concurrently should synchronize amongst themselves and provide the necessary locking. Multiple threads each manipulating a differentCertPathBuilderinstance need not synchronize.- Since:
- 1.4
- See Also:
CertPath
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedCertPathBuilder(CertPathBuilderSpi builderSpi, Provider provider, String algorithm)Creates aCertPathBuilderobject of the given algorithm, and encapsulates the given provider implementation (SPI object) in it.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CertPathBuilderResultbuild(CertPathParameters params)Attempts to build a certification path using the specified algorithm parameter set.StringgetAlgorithm()Returns the name of the algorithm of thisCertPathBuilder.static StringgetDefaultType()Returns the defaultCertPathBuildertype as specified by thecertpathbuilder.typesecurity property, or the string "PKIX" if no such property exists.static CertPathBuildergetInstance(String algorithm)Returns aCertPathBuilderobject that implements the specified algorithm.static CertPathBuildergetInstance(String algorithm, String provider)Returns aCertPathBuilderobject that implements the specified algorithm.static CertPathBuildergetInstance(String algorithm, Provider provider)Returns aCertPathBuilderobject that implements the specified algorithm.ProvidergetProvider()Returns the provider of thisCertPathBuilder.CertPathCheckergetRevocationChecker()Returns aCertPathCheckerthat the encapsulatedCertPathBuilderSpiimplementation uses to check the revocation status of certificates.
-
-
-
Constructor Detail
-
CertPathBuilder
protected CertPathBuilder(CertPathBuilderSpi builderSpi, Provider provider, String algorithm)
Creates aCertPathBuilderobject 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 aCertPathBuilderobject 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.- 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 than the order of providers returned bySecurity.getProviders(). - Parameters:
algorithm- the name of the requestedCertPathBuilderalgorithm. See the CertPathBuilder section in the Java Security Standard Algorithm Names Specification for information about standard algorithm names.- Returns:
- a
CertPathBuilderobject that implements the specified algorithm - Throws:
NoSuchAlgorithmException- if noProvidersupports aCertPathBuilderSpiimplementation for the specified algorithmNullPointerException- ifalgorithmisnull- See Also:
Provider
-
getInstance
public static CertPathBuilder getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
Returns aCertPathBuilderobject 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 requestedCertPathBuilderalgorithm. See the CertPathBuilder section in the Java Security Standard Algorithm Names Specification for information about standard algorithm names.provider- the name of the provider.- Returns:
- a
CertPathBuilderobject that implements the specified algorithm - Throws:
IllegalArgumentException- if theproviderisnullor emptyNoSuchAlgorithmException- if aCertPathBuilderSpiimplementation 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:
Provider
-
getInstance
public static CertPathBuilder getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
Returns aCertPathBuilderobject 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 requestedCertPathBuilderalgorithm. See the CertPathBuilder section in the Java Security Standard Algorithm Names Specification for information about standard algorithm names.provider- the provider.- Returns:
- a
CertPathBuilderobject that implements the specified algorithm - Throws:
IllegalArgumentException- if theproviderisnullNoSuchAlgorithmException- if aCertPathBuilderSpiimplementation for the specified algorithm is not available from the specifiedProviderobjectNullPointerException- ifalgorithmisnull- 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 defaultCertPathBuildertype as specified by thecertpathbuilder.typesecurity property, or the string "PKIX" if no such property exists.The default
CertPathBuildertype 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
CertPathBuildertype can be changed by setting the value of thecertpathbuilder.typesecurity property to the desired type.- Returns:
- the default
CertPathBuildertype as specified by thecertpathbuilder.typesecurity property, or the string "PKIX" if no such property exists. - See Also:
security properties
-
getRevocationChecker
public final CertPathChecker getRevocationChecker()
Returns aCertPathCheckerthat the encapsulatedCertPathBuilderSpiimplementation 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
-
-