java.security.cert

Class CertificateFactorySpi


public abstract class CertificateFactorySpi
extends Object

CertificateFactorySpi is the abstract class Service Provider Interface (SPI) for the CertificateFactory class. A provider must implement all the abstract methods if they wish to supply a certificate factory for a particular certificate type. Ex: X.509 Certificate factories are used to generate certificates and certificate revocation lists (CRL) from their encoding.
Since:
1.2

Constructor Summary

CertificateFactorySpi()
Constructs a new CertificateFactorySpi

Method Summary

abstract CRL
engineGenerateCRL(InputStream inStream)
Generates a CRL based on the encoded data read from the InputStream.
CertPath
engineGenerateCertPath(Certificate> certificates)
Generate a CertPath and initialize it with the certificates in the List argument.
CertPath
engineGenerateCertPath(InputStream inStream)
Generate a CertPath and initialize it with data parsed from the input stream.
CertPath
engineGenerateCertPath(InputStream inStream, String encoding)
Generate a CertPath and initialize it with data parsed from the input stream, using the specified encoding.
abstract Certificate
engineGenerateCertificate(InputStream inStream)
Generates a Certificate based on the encoded data read from the InputStream.
Iterator
engineGetCertPathEncodings()
Returns an Iterator of CertPath encodings supported by this factory, with the default encoding first.
abstract Collection
extends CRL> engineGenerateCRLs(InputStream inStream)
Generates CRLs based on the encoded data read from the InputStream.
abstract Collection
extends Certificate> engineGenerateCertificates(InputStream inStream)
Returns a collection of certificates that were read from the input stream.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CertificateFactorySpi

public CertificateFactorySpi()
Constructs a new CertificateFactorySpi

Method Details

engineGenerateCRL

public abstract CRL engineGenerateCRL(InputStream inStream)
            throws CRLException
Generates a CRL based on the encoded data read from the InputStream. The input stream must contain only one CRL. If there exists a specialized CRL class for the CRL format handled by the certificate factory then the return CRL should be a typecast of it. Ex: A X.509 CertificateFactory should return X509CRL.
Parameters:
inStream - an input stream containing the CRL data
Returns:
a CRL initialized with InputStream data.
Throws:
CRLException - CRL parsing error

engineGenerateCertPath

public CertPath engineGenerateCertPath(Certificate> certificates)
            throws CertificateException
Generate a CertPath and initialize it with the certificates in the List argument.
Parameters:
certificates - The list of certificates with which to create the CertPath.
Returns:
A CertPath initialized from the certificates.
Throws:
CertificateException - If an error occurs generating the CertPath.

engineGenerateCertPath

public CertPath engineGenerateCertPath(InputStream inStream)
            throws CertificateException
Generate a CertPath and initialize it with data parsed from the input stream. The default encoding of this factory is used.
Parameters:
inStream - The InputStream containing the CertPath data.
Returns:
A CertPath initialized from the input stream data.
Throws:
CertificateException - If an error occurs decoding the CertPath.

engineGenerateCertPath

public CertPath engineGenerateCertPath(InputStream inStream,
                                       String encoding)
            throws CertificateException
Generate a CertPath and initialize it with data parsed from the input stream, using the specified encoding.
Parameters:
inStream - The InputStream containing the CertPath data.
encoding - The encoding of the InputStream data.
Returns:
A CertPath initialized from the input stream data.
Throws:
CertificateException - If an error occurs decoding the CertPath.

engineGenerateCertificate

public abstract Certificate engineGenerateCertificate(InputStream inStream)
            throws CertificateException
Generates a Certificate based on the encoded data read from the InputStream. The input stream must contain only one certificate. If there exists a specialized certificate class for the certificate format handled by the certificate factory then the return Ceritificate should be a typecast of it. Ex: A X.509 CertificateFactory should return X509Certificate. For X.509 certificates, the certificate in inStream must be DER encoded and supplied in binary or printable (Base64) encoding. If the certificate is in Base64 encoding, it must be bounded by -----BEGIN CERTIFICATE-----, and -----END CERTIFICATE-----.
Parameters:
inStream - an input stream containing the certificate data
Returns:
a certificate initialized with InputStream data.
Throws:
CertificateException - Certificate parsing error

engineGetCertPathEncodings

public Iterator engineGetCertPathEncodings()
Returns an Iterator of CertPath encodings supported by this factory, with the default encoding first. The returned Iterator cannot be modified.
Returns:
The Iterator of supported encodings.

extends CRL> engineGenerateCRLs

public abstract Collectionextends CRL> engineGenerateCRLs(InputStream inStream)
            throws CRLException
Generates CRLs based on the encoded data read from the InputStream. For a X.509 certificate factory, the stream may contain a single DER encoded CRL or a PKCS#7 CRL set. This is a PKCS#7 SignedData object with the most significant field being crls. If no CRLs are present, then an empty collection is returned.
Parameters:
inStream - an input stream containing the CRLs
Returns:
a collection of CRLs initialized with the InputStream data.
Throws:
CRLException - CRL parsing error

extends Certificate> engineGenerateCertificates

public abstract Collectionextends Certificate> engineGenerateCertificates(InputStream inStream)
            throws CertificateException
Returns a collection of certificates that were read from the input stream. It may be empty, have only one, or have multiple certificates. For a X.509 certificate factory, the stream may contain a single DER encoded certificate or a PKCS#7 certificate chain. This is a PKCS#7 SignedData object with the most significant field being certificates. If no CRLs are present, then an empty collection is returned.
Parameters:
inStream - an input stream containing the certificates
Returns:
a collection of certificates initialized with the InputStream data.
Throws:
CertificateException - Certificate parsing error

CertificateFactorySpi.java --- Certificate Factory Class Copyright (C) 1999,2003 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.