FileDocCategorySizeDatePackage
CertPathBuilder.javaAPI DocJava SE 6 API10855Tue Jun 10 00:25:48 BST 2008java.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 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 {@link #build 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.

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.

see
CertPath
version
1.13 04/21/06
since
1.4
author
Sean Mullan
author
Yassir Elley

Fields Summary
private static final String
CPB_TYPE
private static final Debug
debug
private CertPathBuilderSpi
builderSpi
private Provider
provider
private String
algorithm
Constructors Summary
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.

param
builderSpi the provider implementation
param
provider the provider
param
algorithm the algorithm name


                                          
         
	  
    
	this.builderSpi = builderSpi;
	this.provider = provider;
	this.algorithm = algorithm;
    
Methods Summary
public final java.security.cert.CertPathBuilderResultbuild(java.security.cert.CertPathParameters params)
Attempts to build a certification path using the specified algorithm parameter set.

param
params the algorithm parameters
return
the result of the build algorithm
throws
CertPathBuilderException if the builder is unable to construct a certification path that satisfies the specified parameters
throws
InvalidAlgorithmParameterException if the specified parameters are inappropriate for this CertPathBuilder

	return builderSpi.engineBuild(params);
    
public final java.lang.StringgetAlgorithm()
Returns the name of the algorithm of this CertPathBuilder.

return
the name of the algorithm of this CertPathBuilder

	return this.algorithm;
    
public static final java.lang.StringgetDefaultType()
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. <JAVA_HOME> refers to the value of the java.home system property, and specifies the directory where the JRE is 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.

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

        String cpbtype;
        cpbtype = (String)AccessController.doPrivileged(new PrivilegedAction() {
            public Object run() {
                return Security.getProperty(CPB_TYPE);
            }
        });
        if (cpbtype == null) {
            cpbtype = "PKIX";
        }
        return cpbtype;
    
public static java.security.cert.CertPathBuildergetInstance(java.lang.String algorithm)
Returns a 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 {@link Security#getProviders() Security.getProviders()} method.

param
algorithm the name of the requested CertPathBuilder algorithm. See Appendix A in the Java Certification Path API Programmer's Guide for information about standard algorithm names.
return
a CertPathBuilder object that implements the specified algorithm.
throws
NoSuchAlgorithmException if no Provider supports a CertPathBuilderSpi implementation for the specified algorithm.
see
java.security.Provider

	Instance instance = GetInstance.getInstance("CertPathBuilder", 
	    CertPathBuilderSpi.class, algorithm);
	return new CertPathBuilder((CertPathBuilderSpi)instance.impl,
	    instance.provider, algorithm);
    
public static java.security.cert.CertPathBuildergetInstance(java.lang.String algorithm, java.lang.String provider)
Returns a 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 {@link Security#getProviders() Security.getProviders()} method.

param
algorithm the name of the requested CertPathBuilder algorithm. See Appendix A in the Java Certification Path API Programmer's Guide for information about standard algorithm names.
param
provider the name of the provider.
return
a CertPathBuilder object that implements the specified algorithm.
throws
NoSuchAlgorithmException if a CertPathBuilderSpi implementation for the specified algorithm is not available from the specified provider.
throws
NoSuchProviderException if the specified provider is not registered in the security provider list.
exception
IllegalArgumentException if the provider is null or empty.
see
java.security.Provider

	Instance instance = GetInstance.getInstance("CertPathBuilder", 
	    CertPathBuilderSpi.class, algorithm, provider);
	return new CertPathBuilder((CertPathBuilderSpi)instance.impl,
	    instance.provider, algorithm);
    
public static java.security.cert.CertPathBuildergetInstance(java.lang.String algorithm, java.security.Provider provider)
Returns a 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.

param
algorithm the name of the requested CertPathBuilder algorithm. See Appendix A in the Java Certification Path API Programmer's Guide for information about standard algorithm names.
param
provider the provider.
return
a CertPathBuilder object that implements the specified algorithm.
exception
NoSuchAlgorithmException if a CertPathBuilderSpi implementation for the specified algorithm is not available from the specified Provider object.
exception
IllegalArgumentException if the provider is null.
see
java.security.Provider

	Instance instance = GetInstance.getInstance("CertPathBuilder", 
	    CertPathBuilderSpi.class, algorithm, provider);
	return new CertPathBuilder((CertPathBuilderSpi)instance.impl,
	    instance.provider, algorithm);
    
public final java.security.ProvidergetProvider()
Returns the provider of this CertPathBuilder.

return
the provider of this CertPathBuilder

	return this.provider;