java.security.cert

Class CertPath

java.lang.Object

java.security.cert.CertPath

All Implemented Interfaces:

Serializable

public abstract class CertPath
extends Object
implements Serializable

This class represents an immutable sequence, or path, of security certificates. The path type must match the type of each certificate in the path, or in other words, for all instances of cert in a certpath object, cert.getType().equals(certpath.getType()) will return true.

Since this class is immutable, it is thread-safe. During serialization, the path is consolidated into a CertPath.CertPathRep, which preserves the data regardless of the underlying implementation of the path.

Since:

1.4

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CertPath.CertPathRep The serialized representation of a path.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CertPath(String type) Create a certificate path with the given type.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o) Compares this path to another for semantic equality.
abstract List<? extends Certificate>	getCertificates() Returns the immutable, thread-safe list of certificates in this path.
abstract byte[]	getEncoded() Returns the encoded form of this path, via the default encoding.
abstract byte[]	getEncoded(String encoding) Returns the encoded form of this path, via the specified encoding.
abstract Iterator<String>	getEncodings() Get an immutable iterator over the path encodings (all String names), starting with the default encoding.
String	getType() Get the (non-null) type of all certificates in the path.
int	hashCode() Returns the hashcode of this certificate path.
String	toString() Convert this Object to a human-readable String.
protected Object	writeReplace() Serializes the path in its encoded form, to ensure reserialization with the appropriate factory object without worrying about list implementation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CertPath

protected CertPath(String type)

Create a certificate path with the given type. Most code should use CertificateFactory to create CertPaths.

Parameters:

type - the type of the path

Method Detail

getType

public String getType()

Get the (non-null) type of all certificates in the path.

Returns:

the path certificate type

getEncodings

public abstract Iterator<String> getEncodings()

Get an immutable iterator over the path encodings (all String names), starting with the default encoding. The iterator will throw an UnsupportedOperationException if an attempt is made to remove items from the list.

Returns:

the iterator of supported encodings in the path

equals

public boolean equals(Object o)

Compares this path to another for semantic equality. To be equal, both must be instances of CertPath, with the same type, and identical certificate lists. Overriding classes must not change this behavior.

Overrides:

equals in class Object

Parameters:

o - the object to compare to

Returns:

true if the two are equal

See Also:

Object.hashCode()

hashCode

public int hashCode()

Returns the hashcode of this certificate path. This is defined as:
31 * getType().hashCode() + getCertificates().hashCode().

Overrides:

hashCode in class Object

Returns:

the hashcode

See Also:

Object.equals(Object), System.identityHashCode(Object)

toString

public String toString()

Description copied from class: Object

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:

toString in class Object

Returns:

the String representing this Object, which may be null

See Also:

Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)

getEncoded

public abstract byte[] getEncoded()
                           throws CertificateEncodingException

Returns the encoded form of this path, via the default encoding.

Returns:

the encoded form

Throws:

CertificateEncodingException - if encoding fails

getEncoded

public abstract byte[] getEncoded(String encoding)
                           throws CertificateEncodingException

Returns the encoded form of this path, via the specified encoding.

Parameters:

encoding - the encoding to use

Returns:

the encoded form

Throws:

CertificateEncodingException - if encoding fails or does not exist

getCertificates

public abstract List<? extends Certificate> getCertificates()

Returns the immutable, thread-safe list of certificates in this path.

Returns:

the list of certificates, non-null but possibly empty

writeReplace

protected Object writeReplace()
                       throws ObjectStreamException

Serializes the path in its encoded form, to ensure reserialization with the appropriate factory object without worrying about list implementation. The result will always be an instance of CertPath.CertPathRep.

Returns:

the replacement object

Throws:

ObjectStreamException - if the replacement creation fails