java.security.cert.CertificateFactorySpi 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.InputStream;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.security.Provider;
import java.security.NoSuchAlgorithmException;
import java.security.NoSuchProviderException;
/**
* This class defines the Service Provider Interface (SPI)
* for the CertificateFactory class.
* All the abstract methods in this class must be implemented by each
* cryptographic service provider who wishes to supply the implementation
* of a certificate factory for a particular certificate type, e.g., X.509.
*
*
Certificate factories are used to generate certificate, certification path
* (CertPath) and certificate revocation list (CRL) objects from
* their encodings.
*
*
A certificate factory for X.509 must return certificates that are an
* instance of java.security.cert.X509Certificate, and CRLs
* that are an instance of java.security.cert.X509CRL.
*
* @author Hemma Prafullchandra
* @author Jan Luehe
* @author Sean Mullan
*
* @version 1.9, 02/02/00
*
* @see CertificateFactory
* @see Certificate
* @see X509Certificate
* @see CertPath
* @see CRL
* @see X509CRL
*
* @since 1.2
*/
public abstract class CertificateFactorySpi
{
public CertificateFactorySpi() { }
/**
* Generates a certificate object and initializes it with
* the data read from the input stream inStream.
*
*
In order to take advantage of the specialized certificate format
* supported by this certificate factory,
* the returned certificate object can be typecast to the corresponding
* certificate class. For example, if this certificate
* factory implements X.509 certificates, the returned certificate object
* can be typecast to the X509Certificate class.
*
*
In the case of a certificate factory for X.509 certificates, the
* certificate provided in inStream must be DER-encoded and
* may be supplied in binary or printable (Base64) encoding. If the
* certificate is provided in Base64 encoding, it must be bounded at
* the beginning by -----BEGIN CERTIFICATE-----, and must be bounded at
* the end by -----END CERTIFICATE-----.
*
*
Note that if the given input stream does not support
* {@link java.io.InputStream#mark(int) mark} and
* {@link java.io.InputStream#reset() reset}, this method will
* consume the entire input stream. Otherwise, each call to this
* method consumes one certificate and the read position of the input stream
* is positioned to the next available byte after the the inherent
* end-of-certificate marker. If the data in the
* input stream does not contain an inherent end-of-certificate marker (other
* than EOF) and there is trailing data after the certificate is parsed, a
* CertificateException is thrown.
*
* @param inStream an input stream with the certificate data.
*
* @return a certificate object initialized with the data
* from the input stream.
*
* @exception CertificateException on parsing errors.
*/
public abstract Certificate engineGenerateCertificate(InputStream inStream)
throws CertificateException;
/**
* Generates a CertPath object and initializes it with
* the data read from the InputStream inStream. The data
* is assumed to be in the default encoding.
*
* @param inStream an InputStream containing the data
* @return a CertPath initialized with the data from the
* InputStream
* @exception CertificateException if an exception occurs while decoding
* @since 1.4
*/
public CertPath engineGenerateCertPath(InputStream inStream)
throws CertificateException
{
return null;
}
/**
* Generates a CertPath object and initializes it with
* the data read from the InputStream inStream. The data
* is assumed to be in the specified encoding.
*
*
This method was added to version 1.4 of the Java 2 Platform
* Standard Edition. In order to maintain backwards compatibility with
* existing service providers, this method cannot be abstract
* and by default throws an UnsupportedOperationException.
*
* @param inStream an InputStream containing the data
* @param encoding the encoding used for the data
* @return a CertPath initialized with the data from the
* InputStream
* @exception CertificateException if an exception occurs while decoding or
* the encoding requested is not supported
* @exception UnsupportedOperationException if the method is not supported
* @since 1.4
*/
public CertPath engineGenerateCertPath(InputStream inStream, String
encoding) throws CertificateException
{
return null;
}
/**
* Generates a CertPath object and initializes it with
* a List of Certificates.
*
* The certificates supplied must be of a type supported by the
* CertificateFactory. They will be copied out of the supplied
* List object.
*
*
This method was added to version 1.4 of the Java 2 Platform
* Standard Edition. In order to maintain backwards compatibility with
* existing service providers, this method cannot be abstract
* and by default throws an UnsupportedOperationException.
*
* @param certificates a List of Certificates
* @return a CertPath initialized with the supplied list of
* certificates
* @exception CertificateException if an exception occurs
* @exception UnsupportedOperationException if the method is not supported
* @since 1.4
*/
public CertPath engineGenerateCertPath(List certificates)
throws CertificateException
{
return null;
}
/**
* Returns an iteration of the CertPath encodings supported
* by this certificate factory, with the default encoding first. See
* Appendix A in the
*
* Java Certification Path API Programmer's Guide
* for information about standard encoding names.
*
* Attempts to modify the returned Iterator via its
* remove method result in an
* UnsupportedOperationException.
*
*
This method was added to version 1.4 of the Java 2 Platform
* Standard Edition. In order to maintain backwards compatibility with
* existing service providers, this method cannot be abstract
* and by default throws an UnsupportedOperationException.
*
* @return an Iterator over the names of the supported
* CertPath encodings (as Strings)
* @exception UnsupportedOperationException if the method is not supported
* @since 1.4
*/
public Iterator engineGetCertPathEncodings() {
return null;
}
/**
* Returns a (possibly empty) collection view of the certificates read
* from the given input stream inStream.
*
*
In order to take advantage of the specialized certificate format
* supported by this certificate factory, each element in
* the returned collection view can be typecast to the corresponding
* certificate class. For example, if this certificate
* factory implements X.509 certificates, the elements in the returned
* collection can be typecast to the X509Certificate class.
*
*
In the case of a certificate factory for X.509 certificates,
* inStream may contain a single DER-encoded certificate
* in the formats described for
* {@link CertificateFactory#generateCertificate(java.io.InputStream)
* generateCertificate}.
* In addition, inStream may contain a PKCS#7 certificate
* chain. This is a PKCS#7 SignedData object, with the only
* significant field being certificates. In particular, the
* signature and the contents are ignored. This format allows multiple
* certificates to be downloaded at once. If no certificates are present,
* an empty collection is returned.
*
*
Note that if the given input stream does not support
* {@link java.io.InputStream#mark(int) mark} and
* {@link java.io.InputStream#reset() reset}, this method will
* consume the entire input stream.
*
* @param inStream the input stream with the certificates.
*
* @return a (possibly empty) collection view of
* java.security.cert.Certificate objects
* initialized with the data from the input stream.
*
* @exception CertificateException on parsing errors.
*/
public abstract Collection engineGenerateCertificates(InputStream inStream)
throws CertificateException;
/**
* Generates a certificate revocation list (CRL) object and initializes it
* with the data read from the input stream inStream.
*
*
In order to take advantage of the specialized CRL format
* supported by this certificate factory,
* the returned CRL object can be typecast to the corresponding
* CRL class. For example, if this certificate
* factory implements X.509 CRLs, the returned CRL object
* can be typecast to the X509CRL class.
*
*
Note that if the given input stream does not support
* {@link java.io.InputStream#mark(int) mark} and
* {@link java.io.InputStream#reset() reset}, this method will
* consume the entire input stream. Otherwise, each call to this
* method consumes one CRL and the read position of the input stream
* is positioned to the next available byte after the the inherent
* end-of-CRL marker. If the data in the
* input stream does not contain an inherent end-of-CRL marker (other
* than EOF) and there is trailing data after the CRL is parsed, a
* CRLException is thrown.
*
* @param inStream an input stream with the CRL data.
*
* @return a CRL object initialized with the data
* from the input stream.
*
* @exception CRLException on parsing errors.
*/
public abstract CRL engineGenerateCRL(InputStream inStream)
throws CRLException;
/**
* Returns a (possibly empty) collection view of the CRLs read
* from the given input stream inStream.
*
*
In order to take advantage of the specialized CRL format
* supported by this certificate factory, each element in
* the returned collection view can be typecast to the corresponding
* CRL class. For example, if this certificate
* factory implements X.509 CRLs, the elements in the returned
* collection can be typecast to the X509CRL class.
*
*
In the case of a certificate factory for X.509 CRLs,
* inStream may contain a single DER-encoded CRL.
* In addition, inStream may contain a PKCS#7 CRL
* set. This is a PKCS#7 SignedData object, with the only
* significant field being crls. In particular, the
* signature and the contents are ignored. This format allows multiple
* CRLs to be downloaded at once. If no CRLs are present,
* an empty collection is returned.
*
*
Note that if the given input stream does not support
* {@link java.io.InputStream#mark(int) mark} and
* {@link java.io.InputStream#reset() reset}, this method will
* consume the entire input stream.
*
* @param inStream the input stream with the CRLs.
*
* @return a (possibly empty) collection view of
* java.security.cert.CRL objects initialized with the data from the input
* stream.
*
* @exception CRLException on parsing errors.
*/
public abstract Collection engineGenerateCRLs(InputStream inStream)
throws CRLException;
}