OpenJDK 27 · sun.security.provider.X509Factory · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final String	BEGIN_CERT
public static final int	BER_ITERATION_COUNT
private static final Cache<Object, X509CertImpl>	certCache
private static final Cache<Object, X509CRLImpl>	crlCache
private static final int	ENC_MAX_LENGTH
public static final String	END_CERT

Access	Constructor and Description
public	X509Factory()

Method Summary

Modifier and Type	Method and Description
private static <V> V	addIfNotPresent(Cache<Object, V> cache, byte[] encoding, V value) Add the X509CertImpl or X509CRLImpl to the cache.
public static X509CertImpl	cachedGetX509Cert(byte[] encoding)
public Certificate	Returns: an X.509 certificate object initialized with the data from the input stream. engineGenerateCertificate(InputStream an input stream with the certificate data. is) Implements abstract java.security.cert.CertificateFactorySpi.engineGenerateCertificate. Generates an X.509 certificate object and initializes it with the data read from the input stream `is`.
public Collection<? extends Certificate>	Returns: a (possibly empty) collection view of X.509 certificate objects initialized with the data from the input stream. engineGenerateCertificates(InputStream the input stream with the certificates. is) Implements abstract java.security.cert.CertificateFactorySpi.engineGenerateCertificates. Returns a (possibly empty) collection view of X.509 certificates read from the given input stream `is`.
public CertPath	Returns: a `CertPath` initialized with the data from the `InputStream` engineGenerateCertPath(InputStream an `InputStream` containing the data inStream) Overrides java.security.cert.CertificateFactorySpi.engineGenerateCertPath. 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) Overrides java.security.cert.CertificateFactorySpi.engineGenerateCertPath. 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) Overrides java.security.cert.CertificateFactorySpi.engineGenerateCertPath. Generates a `CertPath` object and initializes it with a `List` of `Certificate`s.
public CRL	Returns: an X.509 CRL object initialized with the data from the input stream. engineGenerateCRL(InputStream an input stream with the CRL data. is) Implements abstract java.security.cert.CertificateFactorySpi.engineGenerateCRL. Generates an X.509 certificate revocation list (CRL) object and initializes it with the data read from the given input stream `is`.
public Collection<? extends CRL>	Returns: a (possibly empty) collection view of X.509 CRL objects initialized with the data from the input stream. engineGenerateCRLs(InputStream the input stream with the CRLs. is) Implements abstract java.security.cert.CertificateFactorySpi.engineGenerateCRLs. Returns a (possibly empty) collection view of X.509 CRLs read from the given input stream `is`.
public Iterator<String>	Returns: an `Iterator` over the names of the supported `CertPath` encodings (as `String`s) engineGetCertPathEncodings() Overrides java.security.cert.CertificateFactorySpi.engineGetCertPathEncodings. Returns an iteration of the `CertPath` encodings supported by this certificate factory, with the default encoding first.
private static <V> V	getFromCache(Cache<Object, V> cache, byte[] encoding) Get the X509CertImpl or X509CRLImpl from the cache.
public static X509CertImpl	Returns: An X509CertImpl object that is either a cached certificate or a newly built X509CertImpl from the provided X509Certificate intern(X509Certificate The source X509Certificate c) Return an interned X509CertImpl for the given certificate.
public static X509CRLImpl	Returns: An X509CRLImpl object that is either a cached CRL or a newly built X509CRLImpl from the provided X509CRL intern(X509CRL The source X509CRL c) Return an interned X509CRLImpl for the given certificate.
private Collection<? extends Certificate>	parseX509orPKCS7Cert(InputStream is)
private Collection<? extends CRL>	parseX509orPKCS7CRL(InputStream is)
private static int	Returns: The current tag, used to check EOC in indefinite-length BER readBERInternal(InputStream Read from this InputStream is, ByteArrayOutputStream Write into this OutputStream bout, int Tag already read (-1 mean not read) tag, int nesting depth limit depth) Read one BER data block.
private static int	readFully(InputStream in, ByteArrayOutputStream bout, int length) Read from the stream until length bytes have been read or EOF has been reached.
private static byte[]	Returns: byte block or null if end of stream readOneBlock(InputStream the InputStream is) Returns an ASN.1 SEQUENCE from a stream, which might be a BER-encoded binary block or a PEM-style BASE64-encoded ASCII data.

BEGIN_CERT	back to summary
public static final String BEGIN_CERT

BER_ITERATION_COUNT	back to summary
public static final int BER_ITERATION_COUNT

certCache	back to summary
private static final Cache<Object, X509CertImpl> certCache

crlCache	back to summary
private static final Cache<Object, X509CRLImpl> crlCache

ENC_MAX_LENGTH	back to summary
private static final int ENC_MAX_LENGTH

END_CERT	back to summary
public static final String END_CERT

X509Factory	back to summary
public X509Factory()

Method Detail

addIfNotPresent	back to summary
private static <V> V addIfNotPresent(Cache<Object, V> cache, byte[] encoding, V value) Add the X509CertImpl or X509CRLImpl to the cache.

cachedGetX509Cert	back to summary
public static X509CertImpl cachedGetX509Cert(byte[] encoding) throws CertificateException

engineGenerateCertificate back to summary

engineGenerateCertificate	back to summary
public Certificate engineGenerateCertificate(InputStream is) throws CertificateException Implements abstract java.security.cert.CertificateFactorySpi.engineGenerateCertificate. Generates an X.509 certificate object and initializes it with the data read from the input stream `is`. Parameters is:InputStream an input stream with the certificate data. Returns:Certificate an X.509 certificate object initialized with the data from the input stream. Annotations @Override Exceptions CertificateException: on parsing errors.

public Certificate engineGenerateCertificate(InputStream is) throws CertificateException

Implements abstract java.security.cert.CertificateFactorySpi.engineGenerateCertificate.

Generates an X.509 certificate object and initializes it with the data read from the input stream is.

Parameters

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

Returns:Certificate

an X.509 certificate object initialized with the data from the input stream.

Annotations

@Override

Exceptions

CertificateException:: on parsing errors.

engineGenerateCertificates back to summary

engineGenerateCertificates	back to summary
public Collection<? extends Certificate> engineGenerateCertificates(InputStream is) throws CertificateException Implements abstract java.security.cert.CertificateFactorySpi.engineGenerateCertificates. Returns a (possibly empty) collection view of X.509 certificates read from the given input stream `is`. Parameters is:InputStream the input stream with the certificates. Returns:Collection<? extends Certificate> a (possibly empty) collection view of X.509 certificate objects initialized with the data from the input stream. Annotations @Override Exceptions CertificateException: on parsing errors.

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

Implements abstract java.security.cert.CertificateFactorySpi.engineGenerateCertificates.

Returns a (possibly empty) collection view of X.509 certificates read from the given input stream is.

Parameters

is:InputStream: the input stream with the certificates.

Returns:Collection<? extends Certificate>

a (possibly empty) collection view of X.509 certificate objects initialized with the data from the input stream.

Annotations

@Override

Exceptions

CertificateException:: on parsing errors.

engineGenerateCertPath back to summary

engineGenerateCertPath	back to summary
public CertPath engineGenerateCertPath(InputStream inStream) throws CertificateException Overrides java.security.cert.CertificateFactorySpi.engineGenerateCertPath. 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. Parameters inStream:InputStream an `InputStream` containing the data Returns:CertPath a `CertPath` initialized with the data from the `InputStream` Annotations @Override Exceptions CertificateException: if an exception occurs while decoding Since 1.4

public CertPath engineGenerateCertPath(InputStream inStream) throws CertificateException

Overrides java.security.cert.CertificateFactorySpi.engineGenerateCertPath.

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.

Parameters

inStream:InputStream: an InputStream containing the data

Returns:CertPath

a CertPath initialized with the data from the InputStream

Annotations

@Override

Exceptions

CertificateException:: if an exception occurs while decoding

Since

1.4

engineGenerateCertPath back to summary

engineGenerateCertPath	back to summary
public CertPath engineGenerateCertPath(InputStream inStream, String encoding) throws CertificateException Overrides java.security.cert.CertificateFactorySpi.engineGenerateCertPath. 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` Annotations @Override Exceptions CertificateException: if an exception occurs while decoding or the encoding requested is not supported Since 1.4

public CertPath engineGenerateCertPath(InputStream inStream, String encoding) throws CertificateException

Overrides java.security.cert.CertificateFactorySpi.engineGenerateCertPath.

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

Annotations

@Override

Exceptions

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

Since

1.4

engineGenerateCertPath back to summary

engineGenerateCertPath	back to summary
public CertPath engineGenerateCertPath(List<? extends Certificate> certificates) throws CertificateException Overrides java.security.cert.CertificateFactorySpi.engineGenerateCertPath. 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. Parameters certificates:List<? extends Certificate> a `List` of `Certificate`s Returns:CertPath a `CertPath` initialized with the supplied list of certificates Annotations @Override Exceptions CertificateException: if an exception occurs Since 1.4

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

Overrides java.security.cert.CertificateFactorySpi.engineGenerateCertPath.

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

Annotations

@Override

Exceptions

CertificateException:: if an exception occurs

Since

1.4

engineGenerateCRL back to summary

engineGenerateCRL	back to summary
public CRL engineGenerateCRL(InputStream is) throws CRLException Implements abstract java.security.cert.CertificateFactorySpi.engineGenerateCRL. Generates an X.509 certificate revocation list (CRL) object and initializes it with the data read from the given input stream `is`. Parameters is:InputStream an input stream with the CRL data. Returns:CRL an X.509 CRL object initialized with the data from the input stream. Annotations @Override Exceptions CRLException: on parsing errors.

public CRL engineGenerateCRL(InputStream is) throws CRLException

Implements abstract java.security.cert.CertificateFactorySpi.engineGenerateCRL.

Generates an X.509 certificate revocation list (CRL) object and initializes it with the data read from the given input stream is.

Parameters

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

Returns:CRL

an X.509 CRL object initialized with the data from the input stream.

Annotations

@Override

Exceptions

CRLException:: on parsing errors.

engineGenerateCRLs back to summary

engineGenerateCRLs	back to summary
public Collection<? extends CRL> engineGenerateCRLs(InputStream is) throws CRLException Implements abstract java.security.cert.CertificateFactorySpi.engineGenerateCRLs. Returns a (possibly empty) collection view of X.509 CRLs read from the given input stream `is`. Parameters is:InputStream the input stream with the CRLs. Returns:Collection<? extends CRL> a (possibly empty) collection view of X.509 CRL objects initialized with the data from the input stream. Annotations @Override Exceptions CRLException: on parsing errors.

public Collection<? extends CRL> engineGenerateCRLs(InputStream is) throws CRLException

Implements abstract java.security.cert.CertificateFactorySpi.engineGenerateCRLs.

Returns a (possibly empty) collection view of X.509 CRLs read from the given input stream is.

Parameters

is:InputStream: the input stream with the CRLs.

Returns:Collection<? extends CRL>

a (possibly empty) collection view of X.509 CRL objects initialized with the data from the input stream.

Annotations

@Override

Exceptions

CRLException:: on parsing errors.

engineGetCertPathEncodings back to summary

engineGetCertPathEncodings	back to summary
public Iterator<String> engineGetCertPathEncodings() Overrides java.security.cert.CertificateFactorySpi.engineGetCertPathEncodings. Returns an iteration of the `CertPath` encodings supported by this certificate factory, with the default encoding first. 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 `String`s) Annotations @Override Since 1.4

public Iterator<String> engineGetCertPathEncodings()

Overrides java.security.cert.CertificateFactorySpi.engineGetCertPathEncodings.

Returns an iteration of the CertPath encodings supported by this certificate factory, with the default encoding first.

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)

Annotations

@Override

Since

1.4

getFromCache	back to summary
private static <V> V getFromCache(Cache<Object, V> cache, byte[] encoding) Get the X509CertImpl or X509CRLImpl from the cache.

intern	back to summary
public static X509CertImpl intern(X509Certificate c) throws CertificateException Return an interned X509CertImpl for the given certificate. If the given X509Certificate or X509CertImpl is already present in the cert cache, the cached object is returned. Otherwise, if it is a X509Certificate, it is first converted to a X509CertImpl. Then the X509CertImpl is added to the cache and returned. Note that all certificates created via generateCertificate(InputStream) are already interned and this method does not need to be called. It is useful for certificates that cannot be created via generateCertificate() and for converting other X509Certificate implementations to an X509CertImpl. Parameters c:X509Certificate The source X509Certificate Returns:X509CertImpl An X509CertImpl object that is either a cached certificate or a newly built X509CertImpl from the provided X509Certificate Exceptions CertificateException: if failures occur while obtaining the DER encoding for certificate data.

intern

back to summary

public static X509CertImpl intern(X509Certificate c) throws CertificateException

Return an interned X509CertImpl for the given certificate. If the given X509Certificate or X509CertImpl is already present in the cert cache, the cached object is returned. Otherwise, if it is a X509Certificate, it is first converted to a X509CertImpl. Then the X509CertImpl is added to the cache and returned. Note that all certificates created via generateCertificate(InputStream) are already interned and this method does not need to be called. It is useful for certificates that cannot be created via generateCertificate() and for converting other X509Certificate implementations to an X509CertImpl.

Parameters

c:X509Certificate: The source X509Certificate

Returns:X509CertImpl

An X509CertImpl object that is either a cached certificate or a newly built X509CertImpl from the provided X509Certificate

Exceptions

CertificateException:: if failures occur while obtaining the DER encoding for certificate data.

intern	back to summary
public static X509CRLImpl intern(X509CRL c) throws CRLException Return an interned X509CRLImpl for the given certificate. For more information, see intern(X509Certificate). Parameters c:X509CRL The source X509CRL Returns:X509CRLImpl An X509CRLImpl object that is either a cached CRL or a newly built X509CRLImpl from the provided X509CRL Exceptions CRLException: if failures occur while obtaining the DER encoding for CRL data.

intern

back to summary

public static X509CRLImpl intern(X509CRL c) throws CRLException

Return an interned X509CRLImpl for the given certificate. For more information, see intern(X509Certificate).

Parameters

c:X509CRL: The source X509CRL

Returns:X509CRLImpl

An X509CRLImpl object that is either a cached CRL or a newly built X509CRLImpl from the provided X509CRL

Exceptions

CRLException:: if failures occur while obtaining the DER encoding for CRL data.

parseX509orPKCS7Cert	back to summary
private Collection<? extends Certificate> parseX509orPKCS7Cert(InputStream is) throws CertificateException, IOException

parseX509orPKCS7CRL	back to summary
private Collection<? extends CRL> parseX509orPKCS7CRL(InputStream is) throws CRLException, IOException

readBERInternal	back to summary
private static int readBERInternal(InputStream is, ByteArrayOutputStream bout, int tag, int depth) throws IOException Read one BER data block. This method is aware of indefinite-length BER encoding and will read all the subsections in a recursive way Parameters is:InputStream Read from this InputStream bout:ByteArrayOutputStream Write into this OutputStream tag:int Tag already read (-1 mean not read) depth:int nesting depth limit Returns:int The current tag, used to check EOC in indefinite-length BER Exceptions IOException: Any parsing error

readBERInternal

back to summary

private static int readBERInternal(InputStream is, ByteArrayOutputStream bout, int tag, int depth) throws IOException

Read one BER data block. This method is aware of indefinite-length BER encoding and will read all the subsections in a recursive way

Parameters

is:InputStream: Read from this InputStream
bout:ByteArrayOutputStream: Write into this OutputStream
tag:int: Tag already read (-1 mean not read)
depth:int: nesting depth limit

Returns:int

The current tag, used to check EOC in indefinite-length BER

Exceptions

IOException:: Any parsing error

readFully	back to summary
private static int readFully(InputStream in, ByteArrayOutputStream bout, int length) throws IOException Read from the stream until length bytes have been read or EOF has been reached. Return the number of bytes actually read.

readOneBlock	back to summary
private static byte[] readOneBlock(InputStream is) throws IOException Returns an ASN.1 SEQUENCE from a stream, which might be a BER-encoded binary block or a PEM-style BASE64-encoded ASCII data. In the latter case, it's de-BASE64'ed before return. After the reading, the input stream pointer is after the BER block, or after the newline character after the -----END SOMETHING----- line. Parameters is:InputStream the InputStream Returns:byte[] byte block or null if end of stream Exceptions IOException: If any parsing error

readOneBlock

back to summary

private static byte[] readOneBlock(InputStream is) throws IOException

Returns an ASN.1 SEQUENCE from a stream, which might be a BER-encoded binary block or a PEM-style BASE64-encoded ASCII data. In the latter case, it's de-BASE64'ed before return. After the reading, the input stream pointer is after the BER block, or after the newline character after the -----END SOMETHING----- line.

Parameters

is:InputStream: the InputStream

Returns:byte[]

byte block or null if end of stream

Exceptions

IOException:: If any parsing error

public Class X509Factory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail