java.security.cert

Class CertPath

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

protected static class
CertPath.CertPathRep
The serialized representation of a path.

Constructor Summary

CertPath(String type)
Create a certificate path with the given type.

Method Summary

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
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()
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, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

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 Details

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 interface Object
Parameters:
o - the object to compare to
Returns:
true if the two are equal

extends Certificate> getCertificates

public abstract Listextends Certificate> getCertificates()
Returns the immutable, thread-safe list of certificates in this path.
Returns:
the list of certificates, non-null but possibly empty

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

getEncodings

public abstract Iterator 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

getType

public String getType()
Get the (non-null) type of all certificates in the path.
Returns:
the path certificate type

hashCode

public int hashCode()
Returns the hashcode of this certificate path. This is defined as:
31 * getType().hashCode() + getCertificates().hashCode().
Overrides:
hashCode in interface Object
Returns:
the hashcode

toString

public String toString()
Overrides:
toString in interface Object

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

CertPath.java -- a sequence of certificates Copyright (C) 2002, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.