java.security.cert
Class CertPath

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.security.cert.CertPath
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public abstract class CertPath
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements Serializable sample code for java.io.Serializable definition code for java.io.Serializable

An immutable sequence of certificates (a certification path).

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

All CertPath objects have a type, a list of Certificates, 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 Certificates in the certification path. For each certificate cert in a certification path certPath, cert.getType().equals(certPath.getType()) must be true.

The list of Certificates is an ordered List of zero or more Certificates. This List and all of the Certificates 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 getEncoded() sample code for java.security.cert.CertPath.getEncoded() definition code for java.security.cert.CertPath.getEncoded() method, for instance).

All CertPath objects are also Serializable. CertPath objects are resolved into an alternate CertPathRep sample code for java.security.cert.CertPath.CertPathRep definition code for java.security.cert.CertPath.CertPathRep 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 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 sample code for java.security.cert.TrustAnchor definition code for java.security.cert.TrustAnchor should not be included in the certification path. Unvalidated X.509 CertPaths may not follow these conventions. PKIX CertPathValidators will detect any departure from these conventions that cause the certification path to be invalid and throw a CertPathValidatorException.

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.

Since:
1.4
See Also:
CertificateFactory sample code for java.security.cert.CertificateFactory definition code for java.security.cert.CertificateFactory , CertPathBuilder sample code for java.security.cert.CertPathBuilder definition code for java.security.cert.CertPathBuilder , Serialized Form

Nested Class Summary
protected static class CertPath.CertPathRep sample code for java.security.cert.CertPath.CertPathRep definition code for java.security.cert.CertPath.CertPathRep
          Alternate CertPath class for serialization.
 
Constructor Summary
protected CertPath sample code for java.security.cert.CertPath.CertPath(java.lang.String) definition code for java.security.cert.CertPath.CertPath(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  type)
          Creates a CertPath of the specified type.
 
Method Summary
 boolean equals sample code for java.security.cert.CertPath.equals(java.lang.Object) definition code for java.security.cert.CertPath.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  other)
          Compares this certification path for equality with the specified object.
abstract  List sample code for java.util.List definition code for java.util.List <? extends Certificate sample code for java.security.cert.Certificate definition code for java.security.cert.Certificate > getCertificates sample code for java.security.cert.CertPath.getCertificates() definition code for java.security.cert.CertPath.getCertificates() ()
          Returns the list of certificates in this certification path.
abstract  byte[] getEncoded sample code for java.security.cert.CertPath.getEncoded() definition code for java.security.cert.CertPath.getEncoded() ()
          Returns the encoded form of this certification path, using the default encoding.
abstract  byte[] getEncoded sample code for java.security.cert.CertPath.getEncoded(java.lang.String) definition code for java.security.cert.CertPath.getEncoded(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  encoding)
          Returns the encoded form of this certification path, using the specified encoding.
abstract  Iterator sample code for java.util.Iterator definition code for java.util.Iterator <String sample code for java.lang.String definition code for java.lang.String > getEncodings sample code for java.security.cert.CertPath.getEncodings() definition code for java.security.cert.CertPath.getEncodings() ()
          Returns an iteration of the encodings supported by this certification path, with the default encoding first.
 String sample code for java.lang.String definition code for java.lang.String getType sample code for java.security.cert.CertPath.getType() definition code for java.security.cert.CertPath.getType() ()
          Returns the type of Certificates in this certification path.
 int hashCode sample code for java.security.cert.CertPath.hashCode() definition code for java.security.cert.CertPath.hashCode() ()
          Returns the hashcode for this certification path.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for java.security.cert.CertPath.toString() definition code for java.security.cert.CertPath.toString() ()
          Returns a string representation of this certification path.
protected  Object sample code for java.lang.Object definition code for java.lang.Object writeReplace sample code for java.security.cert.CertPath.writeReplace() definition code for java.security.cert.CertPath.writeReplace() ()
          Replaces the CertPath to be serialized with a CertPathRep object.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

CertPath sample code for java.security.cert.CertPath(java.lang.String) definition code for java.security.cert.CertPath(java.lang.String)

protected CertPath(String sample code for java.lang.String definition code for java.lang.String  type)
Creates a CertPath of the specified type.

This constructor is protected because most users should use a CertificateFactory to create CertPaths.

Parameters:
type - the standard name of the type of Certificates in this path
Method Detail

getType sample code for java.security.cert.CertPath.getType() definition code for java.security.cert.CertPath.getType()

public String sample code for java.lang.String definition code for java.lang.String  getType()
Returns the type of Certificates in this certification path. This is the same string that would be returned by cert.getType() sample code for java.security.cert.Certificate.getType() definition code for java.security.cert.Certificate.getType() for all Certificates in the certification path.

Returns:
the type of Certificates in this certification path (never null)

getEncodings sample code for java.security.cert.CertPath.getEncodings() definition code for java.security.cert.CertPath.getEncodings()

public abstract Iterator sample code for java.util.Iterator definition code for java.util.Iterator <String sample code for java.lang.String definition code for java.lang.String > 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)

equals sample code for java.security.cert.CertPath.equals(java.lang.Object) definition code for java.security.cert.CertPath.equals(java.lang.Object)

public boolean equals(Object sample code for java.lang.Object definition code for java.lang.Object  other)
Compares this certification path for equality with the specified object. Two 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 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.

Overrides:
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) in class Object sample code for java.lang.Object definition code for java.lang.Object
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
See Also:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

hashCode sample code for java.security.cert.CertPath.hashCode() definition code for java.security.cert.CertPath.hashCode()

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.

Overrides:
hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
the hashcode value for this certification path
See Also:
Object.equals(java.lang.Object) sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

toString sample code for java.security.cert.CertPath.toString() definition code for java.security.cert.CertPath.toString()

public String sample code for java.lang.String definition code for java.lang.String  toString()
Returns a string representation of this certification path. This calls the toString method on each of the Certificates in the path.

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a string representation of this certification path

getEncoded sample code for java.security.cert.CertPath.getEncoded() definition code for java.security.cert.CertPath.getEncoded()

public abstract byte[] getEncoded()
                           throws CertificateEncodingException sample code for java.security.cert.CertificateEncodingException definition code for java.security.cert.CertificateEncodingException 
Returns the encoded form of this certification path, using the default encoding.

Returns:
the encoded bytes
Throws:
CertificateEncodingException sample code for java.security.cert.CertificateEncodingException definition code for java.security.cert.CertificateEncodingException - if an encoding error occurs

getEncoded sample code for java.security.cert.CertPath.getEncoded(java.lang.String) definition code for java.security.cert.CertPath.getEncoded(java.lang.String)

public abstract byte[] getEncoded(String sample code for java.lang.String definition code for java.lang.String  encoding)
                           throws CertificateEncodingException sample code for java.security.cert.CertificateEncodingException definition code for java.security.cert.CertificateEncodingException 
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 sample code for java.security.cert.CertificateEncodingException definition code for java.security.cert.CertificateEncodingException - if an encoding error occurs or the encoding requested is not supported

getCertificates sample code for java.security.cert.CertPath.getCertificates() definition code for java.security.cert.CertPath.getCertificates()

public abstract List sample code for java.util.List definition code for java.util.List <? extends Certificate sample code for java.security.cert.Certificate definition code for java.security.cert.Certificate > getCertificates()
Returns the list of certificates in this certification path. The List returned must be immutable and thread-safe.

Returns:
an immutable List of Certificates (may be empty, but not null)

writeReplace sample code for java.security.cert.CertPath.writeReplace() definition code for java.security.cert.CertPath.writeReplace()

protected Object sample code for java.lang.Object definition code for java.lang.Object  writeReplace()
                       throws ObjectStreamException sample code for java.io.ObjectStreamException definition code for java.io.ObjectStreamException 
Replaces the CertPath to be serialized with a CertPathRep object.

Returns:
the CertPathRep to be serialized
Throws:
ObjectStreamException sample code for java.io.ObjectStreamException definition code for java.io.ObjectStreamException - if a CertPathRep object representing this certification path could not be created