# CertPathBuilder

public class **CertPathBuilder** extends [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)  
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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilder.html#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.

The `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilder.html#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);
 
```

Android provides the following `CertPathBuilder` algorithms:

| Algorithm | Supported API Levels |
|---|---|
| PKIX | 1+ |

This algorithm is described in the [CertPathBuilder section](https://developers.google.com/j2objc/javadoc/jre/technotes/guides/security/StandardNames.html#CertPathBuilder) 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.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPath.html`

### Protected Constructor Summary

|---|---|
|   | [CertPathBuilder](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilder.html#CertPathBuilder(java.security.cert.CertPathBuilderSpi,%20java.security.Provider,%20java.lang.String))([CertPathBuilderSpi](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilderSpi.html) builderSpi, [Provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html) provider, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) algorithm) Creates a `CertPathBuilder` object of the given algorithm, and encapsulates the given provider implementation (SPI object) in it. |

### Public Method Summary

|---|---|
| final [CertPathBuilderResult](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilderResult.html) | [build](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilder.html#build(java.security.cert.CertPathParameters))([CertPathParameters](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathParameters.html) params) Attempts to build a certification path using the specified algorithm parameter set. |
| final [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getAlgorithm](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilder.html#getAlgorithm())() Returns the name of the algorithm of this `CertPathBuilder`. |
| final static [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getDefaultType](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilder.html#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](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilder.html) | [getInstance](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilder.html#getInstance(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) algorithm) Returns a `CertPathBuilder` object that implements the specified algorithm. |
| static [CertPathBuilder](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilder.html) | [getInstance](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilder.html#getInstance(java.lang.String,%20java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) algorithm, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) provider) Returns a `CertPathBuilder` object that implements the specified algorithm. |
| static [CertPathBuilder](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilder.html) | [getInstance](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilder.html#getInstance(java.lang.String,%20java.security.Provider))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) algorithm, [Provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html) provider) Returns a `CertPathBuilder` object that implements the specified algorithm. |
| final [Provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html) | [getProvider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilder.html#getProvider())() Returns the provider of this `CertPathBuilder`. |
| final [CertPathChecker](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathChecker.html) | [getRevocationChecker](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilder.html#getRevocationChecker())() Returns a `CertPathChecker` that the encapsulated `CertPathBuilderSpi` implementation uses to check the revocation status of certificates. |

### Inherited Method Summary

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

## Protected Constructors

#### protected
**CertPathBuilder**
([CertPathBuilderSpi](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilderSpi.html) builderSpi, [Provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html) provider, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) 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 |
|---|---|

## Public Methods

#### public final [CertPathBuilderResult](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilderResult.html)
**build**
([CertPathParameters](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathParameters.html) params)

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](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilderException.html) | if the builder is unable to construct a certification path that satisfies the specified parameters |
| [InvalidAlgorithmParameterException](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/InvalidAlgorithmParameterException.html) | if the specified parameters are inappropriate for this `CertPathBuilder` |
|---|---|

#### public final [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**getAlgorithm**
()

Returns the name of the algorithm of this `CertPathBuilder`.

##### Returns

- the name of the algorithm of this `CertPathBuilder`

#### public static final [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**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.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html`

#### public static [CertPathBuilder](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilder.html)
**getInstance**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#getProviders()` method.

##### Parameters

| algorithm | the name of the requested `CertPathBuilder` algorithm. See the CertPathBuilder section in the [Java Cryptography Architecture Standard Algorithm Name Documentation](https://developers.google.com/j2objc/javadoc/jre/technotes/guides/security/StandardNames.html#CertPathBuilder) for information about standard algorithm names. |
|---|---|

##### Returns

- a `CertPathBuilder` object that implements the specified algorithm.

##### Throws

| [NoSuchAlgorithmException](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/NoSuchAlgorithmException.html) | if no Provider supports a CertPathBuilderSpi implementation for the specified algorithm. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html`

#### public static [CertPathBuilder](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilder.html)
**getInstance**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) algorithm, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#getProviders()` method.

##### Parameters

| algorithm | the name of the requested `CertPathBuilder` algorithm. See the CertPathBuilder section in the [Java Cryptography Architecture Standard Algorithm Name Documentation](https://developers.google.com/j2objc/javadoc/jre/technotes/guides/security/StandardNames.html#CertPathBuilder) for information about standard algorithm names. |
| provider | the name of the provider. |
|---|---|

##### Returns

- a `CertPathBuilder` object that implements the specified algorithm.

##### Throws

| [NoSuchAlgorithmException](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/NoSuchAlgorithmException.html) | if a CertPathBuilderSpi implementation for the specified algorithm is not available from the specified provider. |
| [NoSuchProviderException](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/NoSuchProviderException.html) | if the specified provider is not registered in the security provider list. |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if the `provider` is null or empty. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html`

#### public static [CertPathBuilder](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathBuilder.html)
**getInstance**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) algorithm, [Provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html) 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.

##### Parameters

| algorithm | the name of the requested `CertPathBuilder` algorithm. See the CertPathBuilder section in the [Java Cryptography Architecture Standard Algorithm Name Documentation](https://developers.google.com/j2objc/javadoc/jre/technotes/guides/security/StandardNames.html#CertPathBuilder) for information about standard algorithm names. |
| provider | the provider. |
|---|---|

##### Returns

- a `CertPathBuilder` object that implements the specified algorithm.

##### Throws

| [NoSuchAlgorithmException](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/NoSuchAlgorithmException.html) | if a CertPathBuilderSpi implementation for the specified algorithm is not available from the specified Provider object. |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if the `provider` is null. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html`

#### public final [Provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html)
**getProvider**
()

Returns the provider of this `CertPathBuilder`.

##### Returns

- the provider of this `CertPathBuilder`

#### public final [CertPathChecker](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPathChecker.html)
**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

| [UnsupportedOperationException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/UnsupportedOperationException.html) | if the service provider does not support this method |
|---|---|