Package java.security.cert

Class CertPathBuilder

  • public class CertPathBuilder
extends java.lang.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 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
    This algorithm is described in the CertPathBuilder section of the Java Cryptography Architecture Standard Algorithm Name Documentation. Consult the release documentation for your implementation to see if any other algorithms are supported.

    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.

    Since:
    1.4
    See Also:
    CertPath

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected CertPathBuilder​(CertPathBuilderSpi builderSpi, java.lang.String algorithm)
      Creates a CertPathBuilder object 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
      CertPathBuilderResult build​(CertPathParameters params)
      Attempts to build a certification path using the specified algorithm parameter set.
      java.lang.String getAlgorithm()
      Returns the name of the algorithm of this CertPathBuilder.
      static java.lang.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​(java.lang.String algorithm)
      Returns a CertPathBuilder object that implements the specified algorithm.
      CertPathChecker getRevocationChecker()
      Returns a CertPathChecker that the encapsulated CertPathBuilderSpi implementation uses to check the revocation status of certificates.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CertPathBuilder

        protected CertPathBuilder​(CertPathBuilderSpi builderSpi,
                          java.lang.String algorithm)
        Creates a CertPathBuilder object of the given algorithm, and encapsulates the given provider implementation (SPI object) in it.
        Parameters:
        builderSpi - the provider implementation
        algorithm - the algorithm name

    • Method Detail

      • getAlgorithm

        public final java.lang.String getAlgorithm()
        Returns the name of the algorithm of this CertPathBuilder.
        Returns:
        the name of the algorithm of this CertPathBuilder

      • getDefaultType

        public static final java.lang.String getDefaultType()
        Returns the default 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.

        Returns:
        the default CertPathBuilder type as specified by the certpathbuilder.type security property, or the string "PKIX" if no such property exists.

      • getRevocationChecker

        public final CertPathChecker getRevocationChecker()
        Returns a 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.

        Returns:
        a CertPathChecker
        Throws:
        java.lang.UnsupportedOperationException - if the service provider does not support this method
        Since:
        1.8