OpenJDK 27 · java.security.cert.CertificateFactorySpi

Access	Constructor and Description
public	CertificateFactorySpi() Constructor for subclasses to call.

Method Summary

Modifier and Type	Method and Description
public abstract Certificate	Returns: a certificate object initialized with the data from the input stream. engineGenerateCertificate(InputStream an input stream with the certificate data. inStream) Generates a certificate object and initializes it with the data read from the input stream `inStream`.
public abstract Collection<? extends Certificate>	Returns: a (possibly empty) collection view of java.security.cert.Certificate objects initialized with the data from the input stream. engineGenerateCertificates(InputStream the input stream with the certificates. inStream) Returns a (possibly empty) collection view of the certificates read from the given input stream `inStream`.
public CertPath	Returns: a `CertPath` initialized with the data from the `InputStream` engineGenerateCertPath(InputStream an `InputStream` containing the data inStream) Generates a `CertPath` object and initializes it with the data read from the `InputStream` inStream.
public CertPath	Returns: a `CertPath` initialized with the data from the `InputStream` engineGenerateCertPath(InputStream an `InputStream` containing the data inStream, String the encoding used for the data encoding) Generates a `CertPath` object and initializes it with the data read from the `InputStream` inStream.
public CertPath	Returns: a `CertPath` initialized with the supplied list of certificates engineGenerateCertPath(List<? extends Certificate> a `List` of `Certificate`s certificates) Generates a `CertPath` object and initializes it with a `List` of `Certificate`s.
public abstract CRL	Returns: a CRL object initialized with the data from the input stream. engineGenerateCRL(InputStream an input stream with the CRL data. inStream) Generates a certificate revocation list (CRL) object and initializes it with the data read from the input stream `inStream`.
public abstract Collection<? extends CRL>	Returns: a (possibly empty) collection view of java.security.cert.CRL objects initialized with the data from the input stream. engineGenerateCRLs(InputStream the input stream with the CRLs. inStream) Returns a (possibly empty) collection view of the CRLs read from the given input stream `inStream`.
public Iterator<String>	Returns: an `Iterator` over the names of the supported `CertPath` encodings (as `String`s) engineGetCertPathEncodings() Returns an iteration of the `CertPath` encodings supported by this certificate factory, with the default encoding first.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

CertificateFactorySpi	back to summary
public CertificateFactorySpi() Constructor for subclasses to call.

Method Detail

engineGenerateCertificate back to summary

engineGenerateCertificate	back to summary
public abstract Certificate engineGenerateCertificate(InputStream inStream) throws CertificateException 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 `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. Parameters inStream:InputStream an input stream with the certificate data. Returns:Certificate a certificate object initialized with the data from the input stream. Exceptions CertificateException: on parsing errors.

public abstract Certificate engineGenerateCertificate(InputStream inStream) throws CertificateException

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 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.

Parameters

inStream:InputStream: an input stream with the certificate data.

Returns:Certificate

a certificate object initialized with the data from the input stream.

Exceptions

CertificateException:: on parsing errors.

engineGenerateCertificates back to summary

engineGenerateCertificates	back to summary
public abstract Collection<? extends Certificate> engineGenerateCertificates(InputStream inStream) throws CertificateException 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 `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. Parameters inStream:InputStream the input stream with the certificates. Returns:Collection<? extends Certificate> a (possibly empty) collection view of java.security.cert.Certificate objects initialized with the data from the input stream. Exceptions CertificateException: on parsing errors.

public abstract Collection<? extends Certificate> engineGenerateCertificates(InputStream inStream) throws CertificateException

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 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.

Parameters

inStream:InputStream: the input stream with the certificates.

Returns:Collection<? extends Certificate>

a (possibly empty) collection view of java.security.cert.Certificate objects initialized with the data from the input stream.

Exceptions

CertificateException:: on parsing errors.

engineGenerateCertPath back to summary

engineGenerateCertPath	back to summary
public CertPath engineGenerateCertPath(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. 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`. Parameters inStream:InputStream an `InputStream` containing the data Returns:CertPath a `CertPath` initialized with the data from the `InputStream` Exceptions CertificateException: if an exception occurs while decoding UnsupportedOperationException: if the method is not supported Since 1.4

public CertPath engineGenerateCertPath(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.

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.

Parameters

inStream:InputStream: an InputStream containing the data

Returns:CertPath

a CertPath initialized with the data from the InputStream

Exceptions

CertificateException:: if an exception occurs while decoding
UnsupportedOperationException:: if the method is not supported

Since

1.4

engineGenerateCertPath back to summary

engineGenerateCertPath	back to summary
public CertPath engineGenerateCertPath(InputStream inStream, String encoding) 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 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`. Parameters inStream:InputStream an `InputStream` containing the data encoding:String the encoding used for the data Returns:CertPath a `CertPath` initialized with the data from the `InputStream` Exceptions CertificateException: if an exception occurs while decoding or the encoding requested is not supported UnsupportedOperationException: if the method is not supported Since 1.4

public CertPath engineGenerateCertPath(InputStream inStream, String encoding) 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 specified encoding.

Parameters

inStream:InputStream: an InputStream containing the data
encoding:String: the encoding used for the data

Returns:CertPath

a CertPath initialized with the data from the InputStream

Exceptions

CertificateException:: if an exception occurs while decoding or the encoding requested is not supported
UnsupportedOperationException:: if the method is not supported

Since

1.4

engineGenerateCertPath back to summary

engineGenerateCertPath	back to summary
public CertPath engineGenerateCertPath(List<? extends Certificate> certificates) throws CertificateException Generates a `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`. Parameters certificates:List<? extends Certificate> a `List` of `Certificate`s Returns:CertPath a `CertPath` initialized with the supplied list of certificates Exceptions CertificateException: if an exception occurs UnsupportedOperationException: if the method is not supported Since 1.4

public CertPath engineGenerateCertPath(List<? extends Certificate> certificates) throws CertificateException

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.

Parameters

certificates:List<? extends Certificate>: a List of Certificates

Returns:CertPath

a CertPath initialized with the supplied list of certificates

Exceptions

CertificateException:: if an exception occurs
UnsupportedOperationException:: if the method is not supported

Since

1.4

engineGenerateCRL back to summary

engineGenerateCRL	back to summary
public abstract CRL engineGenerateCRL(InputStream inStream) throws CRLException 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 `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. Parameters inStream:InputStream an input stream with the CRL data. Returns:CRL a CRL object initialized with the data from the input stream. Exceptions CRLException: on parsing errors.

public abstract CRL engineGenerateCRL(InputStream inStream) throws CRLException

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 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.

Parameters

inStream:InputStream: an input stream with the CRL data.

Returns:CRL

a CRL object initialized with the data from the input stream.

Exceptions

CRLException:: on parsing errors.

engineGenerateCRLs back to summary

engineGenerateCRLs	back to summary
public abstract Collection<? extends CRL> engineGenerateCRLs(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 `mark` and `reset`, this method will consume the entire input stream. Parameters inStream:InputStream the input stream with the CRLs. Returns:Collection<? extends CRL> a (possibly empty) collection view of java.security.cert.CRL objects initialized with the data from the input stream. Exceptions CRLException: on parsing errors.

public abstract Collection<? extends CRL> engineGenerateCRLs(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 mark and reset, this method will consume the entire input stream.

Parameters

inStream:InputStream: the input stream with the CRLs.

Returns:Collection<? extends CRL>

a (possibly empty) collection view of java.security.cert.CRL objects initialized with the data from the input stream.

Exceptions

CRLException:: on parsing errors.

engineGetCertPathEncodings back to summary

engineGetCertPathEncodings	back to summary
public Iterator<String> engineGetCertPathEncodings() Returns an iteration of the `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`. Returns:Iterator<String> an `Iterator` over the names of the supported `CertPath` encodings (as `String`s) Exceptions UnsupportedOperationException: if the method is not supported Since 1.4 External Specification Java Security Standard Algorithm Names

public Iterator<String> engineGetCertPathEncodings()

Returns an iteration of the 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.

Returns:Iterator<String>

an Iterator over the names of the supported CertPath encodings (as Strings)

Exceptions

UnsupportedOperationException:: if the method is not supported

Since

1.4

External Specification

Java Security Standard Algorithm Names

public abstract Class CertificateFactorySpi

Constructor Summary

Method Summary

Constructor Detail

Method Detail