public abstract class CertificateFactorySpi extends Object
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
.
Constructor | Description |
---|---|
CertificateFactorySpi() |
Constructor for subclasses to call. |
Modifier and Type | Method | Description |
---|---|---|
abstract Certificate |
engineGenerateCertificate |
Generates a certificate object and initializes it with the data read from the input stream inStream . |
abstract Collection |
engineGenerateCertificates |
Returns a (possibly empty) collection view of the certificates read from the given input stream inStream . |
CertPath |
engineGenerateCertPath |
Generates a CertPath object and initializes it with the data read from the InputStream inStream. |
CertPath |
engineGenerateCertPath |
Generates a CertPath object and initializes it with the data read from the InputStream inStream. |
CertPath |
engineGenerateCertPath |
Generates a CertPath object and initializes it with a List of Certificate s. |
abstract CRL |
engineGenerateCRL |
Generates a certificate revocation list (CRL) object and initializes it with the data read from the input stream inStream . |
abstract Collection |
engineGenerateCRLs |
Returns a (possibly empty) collection view of the CRLs read from the given input stream inStream . |
Iterator |
engineGetCertPathEncodings() |
Returns an iteration of the CertPath encodings supported by this certificate factory, with the default encoding first. |
public CertificateFactorySpi()
public abstract Certificate engineGenerateCertificate(InputStream inStream) throws CertificateException
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 mark
and 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 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.
inStream
- an input stream with the certificate data.CertificateException
- on parsing errors.public CertPath engineGenerateCertPath(InputStream inStream) throws CertificateException
CertPath
object and initializes it with the data read from the InputStream
inStream. The data is assumed to be in the default 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
.
inStream
- an InputStream
containing the dataCertPath
initialized with the data from the InputStream
CertificateException
- if an exception occurs while decodingUnsupportedOperationException
- if the method is not supportedpublic CertPath engineGenerateCertPath(InputStream inStream, String encoding) throws CertificateException
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
.
inStream
- an InputStream
containing the dataencoding
- the encoding used for the dataCertPath
initialized with the data from the InputStream
CertificateException
- if an exception occurs while decoding or the encoding requested is not supportedUnsupportedOperationException
- if the method is not supportedpublic CertPath engineGenerateCertPath(List<? extends Certificate> certificates) throws CertificateException
CertPath
object and initializes it with a List
of Certificate
s. 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
.
certificates
- a List
of Certificate
sCertPath
initialized with the supplied list of certificatesCertificateException
- if an exception occursUnsupportedOperationException
- if the method is not supportedpublic Iterator<String> engineGetCertPathEncodings()
CertPath
encodings supported by this certificate factory, with the default encoding first. See the CertPath Encodings section in the Java Security Standard Algorithm Names Specification 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
.
Iterator
over the names of the supported CertPath
encodings (as String
s)UnsupportedOperationException
- if the method is not supportedpublic abstract Collection<? extends Certificate> engineGenerateCertificates(InputStream inStream) throws CertificateException
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 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 mark
and reset
, this method will consume the entire input stream.
inStream
- the input stream with the certificates.CertificateException
- on parsing errors.public abstract CRL engineGenerateCRL(InputStream inStream) throws CRLException
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 mark
and 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 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.
inStream
- an input stream with the CRL data.CRLException
- on parsing errors.public abstract Collection<? extends CRL> engineGenerateCRLs(InputStream inStream) throws CRLException
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 mark
and reset
, this method will consume the entire input stream.
inStream
- the input stream with the CRLs.CRLException
- on parsing errors.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/security/cert/CertificateFactorySpi.html