java.security.cert
Class CertPathBuilder

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.security.cert.CertPathBuilder

public class CertPathBuilder
extends Object sample code for java.lang.Object definition code for java.lang.Object

A class for building certification paths (also known as certificate chains).

This class uses a provider-based architecture, as described in the Java Cryptography 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 sample code for java.security.cert.CertPathBuilder.build(java.security.cert.CertPathParameters) definition code for java.security.cert.CertPathBuilder.build(java.security.cert.CertPathParameters) 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.

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 sample code for java.security.cert.CertPath definition code for java.security.cert.CertPath

Constructor Summary
protected CertPathBuilder sample code for java.security.cert.CertPathBuilder.CertPathBuilder(java.security.cert.CertPathBuilderSpi, java.security.Provider, java.lang.String) definition code for java.security.cert.CertPathBuilder.CertPathBuilder(java.security.cert.CertPathBuilderSpi, java.security.Provider, java.lang.String) (CertPathBuilderSpi sample code for java.security.cert.CertPathBuilderSpi definition code for java.security.cert.CertPathBuilderSpi  builderSpi, Provider sample code for java.security.Provider definition code for java.security.Provider  provider, String sample code for java.lang.String definition code for java.lang.String  algorithm)
          Creates a CertPathBuilder object of the given algorithm, and encapsulates the given provider implementation (SPI object) in it.
 
Method Summary
 CertPathBuilderResult sample code for java.security.cert.CertPathBuilderResult definition code for java.security.cert.CertPathBuilderResult build sample code for java.security.cert.CertPathBuilder.build(java.security.cert.CertPathParameters) definition code for java.security.cert.CertPathBuilder.build(java.security.cert.CertPathParameters) (CertPathParameters sample code for java.security.cert.CertPathParameters definition code for java.security.cert.CertPathParameters  params)
          Attempts to build a certification path using the specified algorithm parameter set.
 String sample code for java.lang.String definition code for java.lang.String getAlgorithm sample code for java.security.cert.CertPathBuilder.getAlgorithm() definition code for java.security.cert.CertPathBuilder.getAlgorithm() ()
          Returns the name of the algorithm of this CertPathBuilder.
static String sample code for java.lang.String definition code for java.lang.String getDefaultType sample code for java.security.cert.CertPathBuilder.getDefaultType() definition code for java.security.cert.CertPathBuilder.getDefaultType() ()
          Returns the default CertPathBuilder type as specified in the Java security properties file, or the string "PKIX" if no such property exists.
static CertPathBuilder sample code for java.security.cert.CertPathBuilder definition code for java.security.cert.CertPathBuilder getInstance sample code for java.security.cert.CertPathBuilder.getInstance(java.lang.String) definition code for java.security.cert.CertPathBuilder.getInstance(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  algorithm)
          Returns a CertPathBuilder object that implements the specified algorithm.
static CertPathBuilder sample code for java.security.cert.CertPathBuilder definition code for java.security.cert.CertPathBuilder getInstance sample code for java.security.cert.CertPathBuilder.getInstance(java.lang.String, java.security.Provider) definition code for java.security.cert.CertPathBuilder.getInstance(java.lang.String, java.security.Provider) (String sample code for java.lang.String definition code for java.lang.String  algorithm, Provider sample code for java.security.Provider definition code for java.security.Provider  provider)
          Returns a CertPathBuilder object that implements the specified algorithm, as supplied by the specified provider.
static CertPathBuilder sample code for java.security.cert.CertPathBuilder definition code for java.security.cert.CertPathBuilder getInstance sample code for java.security.cert.CertPathBuilder.getInstance(java.lang.String, java.lang.String) definition code for java.security.cert.CertPathBuilder.getInstance(java.lang.String, java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  algorithm, String sample code for java.lang.String definition code for java.lang.String  provider)
          Returns a CertPathBuilder object that implements the specified algorithm, as supplied by the specified provider.
 Provider sample code for java.security.Provider definition code for java.security.Provider getProvider sample code for java.security.cert.CertPathBuilder.getProvider() definition code for java.security.cert.CertPathBuilder.getProvider() ()
          Returns the provider of this CertPathBuilder.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

CertPathBuilder sample code for java.security.cert.CertPathBuilder(java.security.cert.CertPathBuilderSpi, java.security.Provider, java.lang.String) definition code for java.security.cert.CertPathBuilder(java.security.cert.CertPathBuilderSpi, java.security.Provider, java.lang.String)

protected CertPathBuilder(CertPathBuilderSpi sample code for java.security.cert.CertPathBuilderSpi definition code for java.security.cert.CertPathBuilderSpi  builderSpi,
                          Provider sample code for java.security.Provider definition code for java.security.Provider  provider,
                          String sample code for java.lang.String definition code for 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
provider - the provider
algorithm - the algorithm name
Method Detail

getInstance sample code for java.security.cert.CertPathBuilder.getInstance(java.lang.String) definition code for java.security.cert.CertPathBuilder.getInstance(java.lang.String)

public static CertPathBuilder sample code for java.security.cert.CertPathBuilder definition code for java.security.cert.CertPathBuilder  getInstance(String sample code for java.lang.String definition code for java.lang.String  algorithm)
                                   throws NoSuchAlgorithmException sample code for java.security.NoSuchAlgorithmException definition code for java.security.NoSuchAlgorithmException 
Returns a CertPathBuilder object that implements the specified algorithm.

If the default provider package provides an implementation of the specified CertPathBuilder algorithm, an instance of CertPathBuilder containing that implementation is returned. If the requested algorithm is not available in the default package, other packages are searched.

Parameters:
algorithm - the name of the requested CertPathBuilder algorithm
Returns:
a CertPathBuilder object that implements the specified algorithm
Throws:
NoSuchAlgorithmException sample code for java.security.NoSuchAlgorithmException definition code for java.security.NoSuchAlgorithmException - if the requested algorithm is not available in the default provider package or any of the other provider packages that were searched

getInstance sample code for java.security.cert.CertPathBuilder.getInstance(java.lang.String, java.lang.String) definition code for java.security.cert.CertPathBuilder.getInstance(java.lang.String, java.lang.String)

public static CertPathBuilder sample code for java.security.cert.CertPathBuilder definition code for java.security.cert.CertPathBuilder  getInstance(String sample code for java.lang.String definition code for java.lang.String  algorithm,
                                          String sample code for java.lang.String definition code for java.lang.String  provider)
                                   throws NoSuchAlgorithmException sample code for java.security.NoSuchAlgorithmException definition code for java.security.NoSuchAlgorithmException ,
                                          NoSuchProviderException sample code for java.security.NoSuchProviderException definition code for java.security.NoSuchProviderException 
Returns a CertPathBuilder object that implements the specified algorithm, as supplied by the specified provider.

Parameters:
algorithm - the name of the requested CertPathBuilder algorithm
provider - the name of the provider
Returns:
a CertPathBuilder object that implements the specified algorithm, as supplied by the specified provider
Throws:
NoSuchAlgorithmException sample code for java.security.NoSuchAlgorithmException definition code for java.security.NoSuchAlgorithmException - if the requested algorithm is not available from the specified provider
NoSuchProviderException sample code for java.security.NoSuchProviderException definition code for java.security.NoSuchProviderException - if the provider has not been configured
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the provider is null

getInstance sample code for java.security.cert.CertPathBuilder.getInstance(java.lang.String, java.security.Provider) definition code for java.security.cert.CertPathBuilder.getInstance(java.lang.String, java.security.Provider)

public static CertPathBuilder sample code for java.security.cert.CertPathBuilder definition code for java.security.cert.CertPathBuilder  getInstance(String sample code for java.lang.String definition code for java.lang.String  algorithm,
                                          Provider sample code for java.security.Provider definition code for java.security.Provider  provider)
                                   throws NoSuchAlgorithmException sample code for java.security.NoSuchAlgorithmException definition code for java.security.NoSuchAlgorithmException 
Returns a CertPathBuilder object that implements the specified algorithm, as supplied by the specified provider. Note: the provider doesn't have to be registered.

Parameters:
algorithm - the name of the requested CertPathBuilder algorithm
provider - the provider
Returns:
a CertPathBuilder object that implements the specified algorithm, as supplied by the specified provider
Throws:
NoSuchAlgorithmException sample code for java.security.NoSuchAlgorithmException definition code for java.security.NoSuchAlgorithmException - if the requested algorithm is not available from the specified provider
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the provider is null.

getProvider sample code for java.security.cert.CertPathBuilder.getProvider() definition code for java.security.cert.CertPathBuilder.getProvider()

public final Provider sample code for java.security.Provider definition code for java.security.Provider  getProvider()
Returns the provider of this CertPathBuilder.

Returns:
the provider of this CertPathBuilder

getAlgorithm sample code for java.security.cert.CertPathBuilder.getAlgorithm() definition code for java.security.cert.CertPathBuilder.getAlgorithm()

public final String sample code for java.lang.String definition code for java.lang.String  getAlgorithm()
Returns the name of the algorithm of this CertPathBuilder.

Returns:
the name of the algorithm of this CertPathBuilder

build sample code for java.security.cert.CertPathBuilder.build(java.security.cert.CertPathParameters) definition code for java.security.cert.CertPathBuilder.build(java.security.cert.CertPathParameters)

public final CertPathBuilderResult sample code for java.security.cert.CertPathBuilderResult definition code for java.security.cert.CertPathBuilderResult  build(CertPathParameters sample code for java.security.cert.CertPathParameters definition code for java.security.cert.CertPathParameters  params)
                                  throws CertPathBuilderException sample code for java.security.cert.CertPathBuilderException definition code for java.security.cert.CertPathBuilderException ,
                                         InvalidAlgorithmParameterException sample code for java.security.InvalidAlgorithmParameterException definition code for java.security.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 sample code for java.security.cert.CertPathBuilderException definition code for java.security.cert.CertPathBuilderException - if the builder is unable to construct a certification path that satisfies the specified parameters
InvalidAlgorithmParameterException sample code for java.security.InvalidAlgorithmParameterException definition code for java.security.InvalidAlgorithmParameterException - if the specified parameters are inappropriate for this CertPathBuilder

getDefaultType sample code for java.security.cert.CertPathBuilder.getDefaultType() definition code for java.security.cert.CertPathBuilder.getDefaultType()

public static final String sample code for java.lang.String definition code for java.lang.String  getDefaultType()
Returns the default CertPathBuilder type as specified in the Java security properties file, or the string "PKIX" if no such property exists. The Java security properties file is located in the file named <JAVA_HOME>/lib/security/java.security, where <JAVA_HOME> refers to the directory where the JDK was installed.

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 (in the Java security properties file) to the desired type.

Returns:
the default CertPathBuilder type as specified in the Java security properties file, or the string "PKIX" if no such property exists.