java.security.cert.CertPath Maven / Gradle / Ivy
/*
This is not an official specification document, and usage is restricted.
NOTICE
(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below. For
example, no permission is given for you to incorporate this file, in
whole or in part, in an implementation of a Java specification.
Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative, as opposed to normative, use. The file and any
files generated from it may be used to generate other informative
documentation, such as a unified set of documents of API signatures for
a platform that includes technologies expressed as Java APIs. The file
may also be used to produce "compilation stubs," which allow
applications to be compiled and validated for such platforms.
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
This work corresponds to the API signatures of JSR 219: Foundation
Profile 1.1. In the event of a discrepency between this work and the
JSR 219 specification, which is available at
http://www.jcp.org/en/jsr/detail?id=219, the latter takes precedence.
*/
package java.security.cert;
import java.io.ByteArrayInputStream;
import java.io.NotSerializableException;
import java.io.ObjectStreamException;
import java.io.Serializable;
import java.util.Iterator;
import java.util.List;
/**
* 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
* {@link #getEncoded() getEncoded()} method, for instance).
*
* All CertPath objects are also Serializable.
* CertPath objects are resolved into an alternate
* {@link CertPathRep CertPathRep} object during serialization. This allows
* a CertPath object to be serialized into an equivalent
* representation regardless of its underlying implementation.
*
* 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.
* Unvalidated X.509 CertPaths
* may not follow these conventions.
*
* 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 CertificateFactory
*
* @version 1.9 03/12/05
* @author Yassir Elley
* @since 1.4
*/
public abstract class CertPath implements Serializable
{
private String type;
/**
* Creates a CertPath of the specified type.
*
* This constructor is protected because most users should use a
* CertificateFactory to create CertPaths.
*
* @param type the standard name of the type of
* Certificates in this path
*/
protected CertPath(String type) { }
/**
* Returns the type of Certificates in this certification
* path. This is the same string that would be returned by
* {@link java.security.cert.Certificate#getType() cert.getType()}
* for all Certificates in the certification path.
*
* @return the type of Certificates in this certification
* path (never null)
*/
public String getType() {
return null;
}
/**
* 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.
*
* @return an Iterator over the names of the supported
* encodings (as Strings)
*/
public abstract Iterator getEncodings();
/**
* 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.
*
* @param other the object to test for equality with this certification path
* @return true if the specified object is equal to this certification path,
* false otherwise
*/
public boolean equals(Object other) {
return false;
}
/**
* 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.
*
* @return the hashcode value for this certification path
*/
public int hashCode() {
return 0;
}
/**
* Returns a string representation of this certification path.
* This calls the toString method on each of the
* Certificates in the path.
*
* @return a string representation of this certification path
*/
public String toString() {
return null;
}
/**
* Returns the encoded form of this certification path, using the default
* encoding.
*
* @return the encoded bytes
* @exception CertificateEncodingException if an encoding error occurs
*/
public abstract byte[] getEncoded() throws CertificateEncodingException;
/**
* Returns the encoded form of this certification path, using the
* specified encoding.
*
* @param encoding the name of the encoding to use
* @return the encoded bytes
* @exception CertificateEncodingException if an encoding error occurs or
* the encoding requested is not supported
*/
public abstract byte[] getEncoded(String encoding)
throws CertificateEncodingException;
/**
* Returns the list of certificates in this certification path.
* The List returned must be immutable and thread-safe.
*
* @return an immutable List of Certificates
* (may be empty, but not null)
*/
public abstract List getCertificates();
/**
* Replaces the CertPath to be serialized with a
* CertPathRep object.
*
* @return the CertPathRep to be serialized
*
* @throws ObjectStreamException if a CertPathRep object
* representing this certification path could not be created
*/
protected Object writeReplace() throws ObjectStreamException {
return null;
}
/**
* Alternate CertPath class for serialization.
*/
protected static class CertPathRep implements Serializable
{
/** The Certificate type */
private String type;
/** The encoded form of the cert path */
private byte[] data;
/**
* Creates a CertPathRep with the specified
* type and encoded form of a certification path.
*
* @param type the standard name of a CertPath type
* @param data the encoded form of the certification path
*/
protected CertPathRep(String type, byte[] data) { }
/**
* Returns a CertPath constructed from the type and data.
*
* @return the resolved CertPath object
*
* @throws ObjectStreamException if a CertPath could not
* be constructed
*/
protected Object readResolve() throws ObjectStreamException {
return null;
}
}
}