java.security.cert: public class: CertPathBuilder

java.security.cert
public class: CertPathBuilder [javadoc | source]

java.lang.Object
   java.security.cert.CertPathBuilder

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.

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.

Also see:

CertPath

since: 1.4 -

author: Sean - Mullan

author: Yassir - Elley

Constructor:

Constructor:
protected CertPathBuilder(CertPathBuilderSpi builderSpi, Provider provider, String algorithm) { this.builderSpi = builderSpi; this.provider = provider; this.algorithm = 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

 protected CertPathBuilder(CertPathBuilderSpi builderSpi,
    Provider provider,
    String algorithm) {
                                         
        this.builderSpi = builderSpi;
        this.provider = provider;
        this.algorithm = algorithm;
}

CertPathBuilder

Parameters:

builderSpi - the provider implementation

provider - the provider

algorithm - the algorithm name

Method from java.security.cert.CertPathBuilder Summary:
build, getAlgorithm, getDefaultType, getInstance, getInstance, getInstance, getProvider

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from java.security.cert.CertPathBuilder Detail:
public final CertPathBuilderResult build(CertPathParameters params) throws CertPathBuilderException, InvalidAlgorithmParameterException { return builderSpi.engineBuild(params); } Attempts to build a certification path using the specified algorithm parameter set.
public final String getAlgorithm() { return this.algorithm; } Returns the name of the algorithm of this `CertPathBuilder`.
public static final String getDefaultType() { String cpbtype; cpbtype = AccessController.doPrivileged(new PrivilegedAction< String >() { public String run() { return Security.getProperty(CPB_TYPE); } }); if (cpbtype == null) { cpbtype = "PKIX"; } return cpbtype; } 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.
public static CertPathBuilder getInstance(String algorithm) throws NoSuchAlgorithmException { Instance instance = GetInstance.getInstance("CertPathBuilder", CertPathBuilderSpi.class, algorithm); return new CertPathBuilder((CertPathBuilderSpi)instance.impl, instance.provider, 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 Security.getProviders() method.
public static CertPathBuilder getInstance(String algorithm, String provider) throws NoSuchProviderException, NoSuchAlgorithmException { Instance instance = GetInstance.getInstance("CertPathBuilder", CertPathBuilderSpi.class, algorithm, provider); return new CertPathBuilder((CertPathBuilderSpi)instance.impl, instance.provider, algorithm); } 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 Security.getProviders() method.
public static CertPathBuilder getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException { Instance instance = GetInstance.getInstance("CertPathBuilder", CertPathBuilderSpi.class, algorithm, provider); return new CertPathBuilder((CertPathBuilderSpi)instance.impl, instance.provider, algorithm); } 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.
public final Provider getProvider() { return this.provider; } Returns the provider of this `CertPathBuilder`.

Method from java.security.cert.CertPathBuilder Detail:

 public final CertPathBuilderResult build(CertPathParameters params) throws CertPathBuilderException, InvalidAlgorithmParameterException {
        return builderSpi.engineBuild(params);
}

Attempts to build a certification path using the specified algorithm parameter set.

 public final String getAlgorithm() {
        return this.algorithm;
}

CertPathBuilder

 public static final String getDefaultType() {
        String cpbtype;
        cpbtype = AccessController.doPrivileged(new PrivilegedAction< String >() {
            public String run() {
                return Security.getProperty(CPB_TYPE);
            }
        });
        if (cpbtype == null) {
            cpbtype = "PKIX";
        }
        return cpbtype;
}

CertPathBuilder

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.

 public static CertPathBuilder getInstance(String algorithm) throws NoSuchAlgorithmException {
        Instance instance = GetInstance.getInstance("CertPathBuilder",
            CertPathBuilderSpi.class, algorithm);
        return new CertPathBuilder((CertPathBuilderSpi)instance.impl,
            instance.provider, algorithm);
}

CertPathBuilder

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.

 public static CertPathBuilder getInstance(String algorithm,
    String provider) throws NoSuchProviderException, NoSuchAlgorithmException {
        Instance instance = GetInstance.getInstance("CertPathBuilder",
            CertPathBuilderSpi.class, algorithm, provider);
        return new CertPathBuilder((CertPathBuilderSpi)instance.impl,
            instance.provider, algorithm);
}

CertPathBuilder

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.

 public static CertPathBuilder getInstance(String algorithm,
    Provider provider) throws NoSuchAlgorithmException {
        Instance instance = GetInstance.getInstance("CertPathBuilder",
            CertPathBuilderSpi.class, algorithm, provider);
        return new CertPathBuilder((CertPathBuilderSpi)instance.impl,
            instance.provider, algorithm);
}

CertPathBuilder

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.

 public final Provider getProvider() {
        return this.provider;
}

CertPathBuilder