# CertPath

public abstract class **CertPath** extends [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)  
implements [Serializable](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Serializable.html) An immutable sequence of certificates (a certification path).


This is an abstract class that defines the methods common to all
`CertPath`s. Subclasses can handle different kinds of
certificates (X.509, PGP, etc.).


All `CertPath` objects have a type, a list of
`Certificate`s, and one or more supported encodings. Because the
`CertPath` class is immutable, a `CertPath` cannot
change in any externally visible way after being constructed. This
stipulation applies to all public fields and methods of this class and any
added or overridden by subclasses.


The type is a `String` that identifies the type of
`Certificate`s in the certification path. For each
certificate `cert` in a certification path `certPath`,
`cert.getType().equals(certPath.getType())` must be
`true`.


The list of `Certificate`s is an ordered `List` of
zero or more `Certificate`s. This `List` and all
of the `Certificate`s contained in it must be immutable.


Each `CertPath` object must support one or more encodings
so that the object can be translated into a byte array for storage or
transmission to other parties. Preferably, these encodings should be
well-documented standards (such as PKCS#7). One of the encodings supported
by a `CertPath` is considered the default encoding. This
encoding is used if no encoding is explicitly requested (for the
`https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPath.html#getEncoded()` method, for instance).


All `CertPath` objects are also `Serializable`.
`CertPath` objects are resolved into an alternate
`https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPath.CertPathRep.html` object during serialization. This allows
a `CertPath` object to be serialized into an equivalent
representation regardless of its underlying implementation.


`CertPath` objects can be created with a
`CertificateFactory` or they can be returned by other classes,
such as a `CertPathBuilder`.


By convention, X.509 `CertPath`s (consisting of
`X509Certificate`s), are ordered starting with the target
certificate and ending with a certificate issued by the trust anchor. That
is, the issuer of one certificate is the subject of the following one. The
certificate representing the `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/TrustAnchor.html` should not be
included in the certification path. Unvalidated X.509 `CertPath`s
may not follow these conventions. PKIX `CertPathValidator`s will
detect any departure from these conventions that cause the certification
path to be invalid and throw a `CertPathValidatorException`.

Every implementation of the Java platform is required to support the
following standard `CertPath` encodings:

- `PKCS7`
- `PkiPath`

These encodings are described in the [CertPath Encodings section](https://developers.google.com/j2objc/javadoc/jre/technotes/guides/security/StandardNames.html#CertPathEncodings) of the Java Cryptography Architecture Standard Algorithm Name Documentation. Consult the release documentation for your implementation to see if any other encodings are supported.


**Concurrent Access**


All `CertPath` objects must be thread-safe. That is, multiple
threads may concurrently invoke the methods defined in this class on a
single `CertPath` object (or more than one) with no
ill effects. This is also true for the `List` returned by
`CertPath.getCertificates`.


Requiring `CertPath` objects to be immutable and thread-safe
allows them to be passed around to various pieces of code without worrying
about coordinating access. Providing this thread-safety is
generally not difficult, since the `CertPath` and
`List` objects in question are immutable.

##### See Also

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

### Nested Class Summary

|---|---|---|---|
| class | [CertPath.CertPathRep](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPath.CertPathRep.html) || Alternate `CertPath` class for serialization. |

### Protected Constructor Summary

|---|---|
|   | [CertPath](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPath.html#CertPath(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) type) Creates a `CertPath` of the specified type. |

### Public Method Summary

|---|---|
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPath.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) other) Compares this certification path for equality with the specified object. |
| abstract [List](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/List.html)\<? extends [Certificate](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/Certificate.html)\> | [getCertificates](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPath.html#getCertificates())() Returns the list of certificates in this certification path. |
| abstract byte\[\] | [getEncoded](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPath.html#getEncoded(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) encoding) Returns the encoded form of this certification path, using the specified encoding. |
| abstract byte\[\] | [getEncoded](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPath.html#getEncoded())() Returns the encoded form of this certification path, using the default encoding. |
| abstract [Iterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Iterator.html)\<[String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)\> | [getEncodings](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPath.html#getEncodings())() Returns an iteration of the encodings supported by this certification path, with the default encoding first. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getType](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPath.html#getType())() Returns the type of `Certificate`s in this certification path. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPath.html#hashCode())() Returns the hashcode for this certification path. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPath.html#toString())() Returns a string representation of this certification path. |

### Protected Method Summary

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [writeReplace](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertPath.html#writeReplace())() Replaces the `CertPath` to be serialized with a `CertPathRep` object. |

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

Creates a `CertPath` of the specified type.


This constructor is protected because most users should use a
`CertificateFactory` to create `CertPath`s.

##### Parameters

| type | the standard name of the type of `Certificate`s in this path |
|---|---|

## Public Methods

#### public boolean
**equals**
([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) other)

Compares this certification path for equality with the specified
object. Two `CertPath`s are equal if and only if their
types are equal and their certificate `List`s (and by
implication the `Certificate`s in those `List`s)
are equal. A `CertPath` is never equal to an object that is
not a `CertPath`.


This algorithm is implemented by this method. If it is overridden,
the behavior specified here must be maintained.

##### Parameters

| other | the object to test for equality with this certification path |
|---|---|

##### Returns

- true if the specified object is equal to this certification path, false otherwise

#### public abstract [List](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/List.html)\<? extends [Certificate](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/Certificate.html)\>
**getCertificates**
()

Returns the list of certificates in this certification path.
The `List` returned must be immutable and thread-safe.

##### Returns

- an immutable `List` of `Certificate`s (may be empty, but not null)

#### public abstract byte\[\]
**getEncoded**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) encoding)

Returns the encoded form of this certification path, using the
specified encoding.

##### Parameters

| encoding | the name of the encoding to use |
|---|---|

##### Returns

- the encoded bytes

##### Throws

| [CertificateEncodingException](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertificateEncodingException.html) | if an encoding error occurs or the encoding requested is not supported |
|---|---|

#### public abstract byte\[\]
**getEncoded**
()

Returns the encoded form of this certification path, using the default
encoding.

##### Returns

- the encoded bytes

##### Throws

| [CertificateEncodingException](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertificateEncodingException.html) | if an encoding error occurs |
|---|---|

#### public abstract [Iterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Iterator.html)\<[String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)\>
**getEncodings**
()

Returns an iteration of the encodings supported by this certification
path, with the default encoding first. Attempts to modify the returned
`Iterator` via its `remove` method result in an
`UnsupportedOperationException`.

##### Returns

- an `Iterator` over the names of the supported encodings (as Strings)

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

Returns the type of `Certificate`s in this certification
path. This is the same string that would be returned by
`https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/Certificate.html#getType()`
for all `Certificate`s in the certification path.

##### Returns

- the type of `Certificate`s in this certification path (never null)

#### public int
**hashCode**
()

Returns the hashcode for this certification path. The hash code of
a certification path is defined to be the result of the following
calculation:

    hashCode = path.getType().hashCode();
      hashCode = 31*hashCode + path.getCertificates().hashCode();
     
This ensures that `path1.equals(path2)` implies that `path1.hashCode()==path2.hashCode()` for any two certification paths, `path1` and `path2`, as required by the general contract of `Object.hashCode`.

<br />

##### Returns

- the hashcode value for this certification path

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

Returns a string representation of this certification path.
This calls the `toString` method on each of the
`Certificate`s in the path.

##### Returns

- a string representation of this certification path

## Protected Methods

#### protected [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)
**writeReplace**
()

Replaces the `CertPath` to be serialized with a
`CertPathRep` object.

##### Returns

- the `CertPathRep` to be serialized

##### Throws

| [ObjectStreamException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ObjectStreamException.html) | if a `CertPathRep` object representing this certification path could not be created |
|---|---|