public abstract class CertPath extends Object implements Serializable
This is an abstract class that defines the methods common to all
CertPaths. Subclasses can handle different kinds of
certificates (X.509, PGP, etc.).
CertPath objects have a type, a list of
Certificates, and one or more supported encodings. Because the
CertPath class is immutable, a
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
Certificates in the certification path. For each
cert in a certification path
cert.getType().equals(certPath.getType()) must be
The list of
Certificates is an ordered
zero or more
List and all
Certificates contained in it must be immutable.
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
CertPath is considered the default encoding. This
encoding is used if no encoding is explicitly requested (for the
getEncoded() method, for instance).
CertPath objects are also
CertPath objects are resolved into an alternate
CertPathRep object during serialization. This allows
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
By convention, X.509
CertPaths (consisting of
X509Certificates), 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
TrustAnchor should not be
included in the certification path. Unvalidated X.509
may not follow these conventions. PKIX
detect any departure from these conventions that cause the certification
path to be invalid and throw a
Every implementation of the Java platform is required to support the
CertPath objects must be thread-safe. That is, multiple
threads may concurrently invoke the methods defined in this class on a
CertPath object (or more than one) with no
ill effects. This is also true for the
List returned by
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
List objects in question are immutable.
CertPathBuilder, Serialized Form
|Modifier and Type||Class and Description|
|Modifier||Constructor and Description|
|Modifier and Type||Method and Description|
Compares this certification path for equality with the specified object.
Returns the list of certificates in this certification path.
Returns the encoded form of this certification path, using the default encoding.
Returns the encoded form of this certification path, using the specified encoding.
Returns an iteration of the encodings supported by this certification path, with the default encoding first.
Returns the type of
Returns the hashcode for this certification path.
Returns a string representation of this certification path.
protected CertPath(String type)
CertPathof the specified type.
This constructor is protected because most users should use a
CertificateFactory to create
type- the standard name of the type of
Certificates in this path
public String getType()
Certificates in this certification path. This is the same string that would be returned by
Certificates in the certification path.
Certificates in this certification path (never null)
public abstract Iterator<String> getEncodings()
removemethod result in an
Iteratorover the names of the supported encodings (as Strings)
public boolean equals(Object other)
CertPaths are equal if and only if their types are equal and their certificate
Lists (and by implication the
Certificates in those
Lists) are equal. A
CertPathis never equal to an object that is not a
This algorithm is implemented by this method. If it is overridden, the behavior specified here must be maintained.
other- the object to test for equality with this certification path
public int hashCode()
This ensures that
hashCode = path.getType().hashCode(); hashCode = 31*hashCode + path.getCertificates().hashCode();
path1.hashCode()==path2.hashCode()for any two certification paths,
path2, as required by the general contract of
public String toString()
toStringmethod on each of the
Certificates in the path.
public abstract byte getEncoded() throws CertificateEncodingException
CertificateEncodingException- if an encoding error occurs
public abstract byte getEncoded(String encoding) throws CertificateEncodingException
encoding- the name of the encoding to use
CertificateEncodingException- if an encoding error occurs or the encoding requested is not supported
public abstract List<? extends Certificate> getCertificates()
Listreturned must be immutable and thread-safe.
Certificates (may be empty, but not null)
protected Object writeReplace() throws ObjectStreamException
CertPathto be serialized with a
CertPathRepto be serialized
ObjectStreamException- if a
CertPathRepobject representing this certification path could not be created
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2023, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.