Java Doc for CertPath.java in  » 6.0-JDK-Core » security » java » security » cert » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » security » java.security.cert 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.security.cert.CertPath

CertPath
abstract public class CertPath implements Serializable(Code)
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 CertPath.getEncoded() getEncoded() method, for instance).

All CertPath objects are also Serializable. CertPath objects are resolved into an alternate CertPathRep 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 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.
See Also:   CertificateFactory
See Also:   CertPathBuilder
version:
   1.18 05/05/07
author:
   Yassir Elley
since:
   1.4


Inner Class :protected static class CertPathRep implements Serializable


Constructor Summary
protected  CertPath(String type)
     Creates a CertPath of the specified type.

Method Summary
public  booleanequals(Object other)
     Compares this certification path for equality with the specified object.
abstract public  List<? extends Certificate>getCertificates()
     Returns the list of certificates in this certification path.
abstract public  byte[]getEncoded()
     Returns the encoded form of this certification path, using the default encoding.
abstract public  byte[]getEncoded(String encoding)
     Returns the encoded form of this certification path, using the specified encoding.
abstract public  Iterator<String>getEncodings()
     Returns an iteration of the encodings supported by this certification path, with the default encoding first.
public  StringgetType()
     Returns the type of Certificates in this certification path.
public  inthashCode()
     Returns the hashcode for this certification path.
public  StringtoString()
     Returns a string representation of this certification path.
protected  ObjectwriteReplace()
     Replaces the CertPath to be serialized with a CertPathRep object.


Constructor Detail
CertPath
protected CertPath(String type)(Code)
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 ofCertificates in this path





Method Detail
equals
public boolean equals(Object other)(Code)
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.
Parameters:
  other - the object to test for equality with this certification path true if the specified object is equal to this certification path,false otherwise




getCertificates
abstract public List<? extends Certificate> getCertificates()(Code)
Returns the list of certificates in this certification path. The List returned must be immutable and thread-safe. an immutable List of Certificates(may be empty, but not null)



getEncoded
abstract public byte[] getEncoded() throws CertificateEncodingException(Code)
Returns the encoded form of this certification path, using the default encoding. the encoded bytes
exception:
  CertificateEncodingException - if an encoding error occurs



getEncoded
abstract public byte[] getEncoded(String encoding) throws CertificateEncodingException(Code)
Returns the encoded form of this certification path, using the specified encoding.
Parameters:
  encoding - the name of the encoding to use the encoded bytes
exception:
  CertificateEncodingException - if an encoding error occurs orthe encoding requested is not supported



getEncodings
abstract public Iterator<String> getEncodings()(Code)
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. an Iterator over the names of the supportedencodings (as Strings)



getType
public String getType()(Code)
Returns the type of Certificates in this certification path. This is the same string that would be returned by java.security.cert.Certificate.getType cert.getType() for all Certificates in the certification path. the type of Certificates in this certificationpath (never null)



hashCode
public int hashCode()(Code)
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. the hashcode value for this certification path



toString
public String toString()(Code)
Returns a string representation of this certification path. This calls the toString method on each of the Certificates in the path. a string representation of this certification path



writeReplace
protected Object writeReplace() throws ObjectStreamException(Code)
Replaces the CertPath to be serialized with a CertPathRep object. the CertPathRep to be serialized
throws:
  ObjectStreamException - if a CertPathRep object representing this certification path could not be created



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.