| java.lang.Object java.security.cert.CertificateFactory
CertificateFactory | public class CertificateFactory (Code) | | This class defines the functionality of a certificate factory, which is
used to generate certificate, certification path (CertPath )
and certificate revocation list (CRL) objects from their encodings.
For encodings consisting of multiple certificates, use
generateCertificates when you want to
parse a collection of possibly unrelated certificates.
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 .
The following example reads a file with Base64 encoded certificates,
which are each bounded at the beginning by -----BEGIN CERTIFICATE-----, and
bounded at the end by -----END CERTIFICATE-----. We convert the
FileInputStream (which does not support mark
and reset ) to a BufferedInputStream (which
supports those methods), so that each call to
generateCertificate consumes only one certificate, and the
read position of the input stream is positioned to the next certificate in
the file:
FileInputStream fis = new FileInputStream(filename);
BufferedInputStream bis = new BufferedInputStream(fis);
CertificateFactory cf = CertificateFactory.getInstance("X.509");
while (bis.available() > 0) {
Certificate cert = cf.generateCertificate(bis);
System.out.println(cert.toString());
}
The following example parses a PKCS#7-formatted certificate reply stored
in a file and extracts all the certificates from it:
FileInputStream fis = new FileInputStream(filename);
CertificateFactory cf = CertificateFactory.getInstance("X.509");
Collection c = cf.generateCertificates(fis);
Iterator i = c.iterator();
while (i.hasNext()) {
Certificate cert = (Certificate)i.next();
System.out.println(cert);
}
author: Hemma Prafullchandra author: Jan Luehe author: Sean Mullan version: 1.15, 02/02/00 See Also: Certificate See Also: X509Certificate See Also: CertPath See Also: CRL See Also: X509CRL since: 1.2 |
Method Summary | |
final public CRL | generateCRL(InputStream inStream) 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. | final public Collection | generateCRLs(InputStream inStream) 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. | final public CertPath | generateCertPath(InputStream inStream) Generates a CertPath object and initializes it with
the data read from the InputStream inStream. | final public CertPath | generateCertPath(InputStream inStream, String encoding) Generates a CertPath object and initializes it with
the data read from the InputStream inStream. | final public CertPath | generateCertPath(List certificates) 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 . | final public Certificate | generateCertificate(InputStream inStream) 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. | final public Collection | generateCertificates(InputStream inStream) 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. | final public Iterator | getCertPathEncodings() Returns an iteration of the CertPath encodings supported
by this certificate factory, with the default encoding first. | final public static CertificateFactory | getInstance(String type) Generates a certificate factory object that implements the
specified certificate type. | final public static CertificateFactory | getInstance(String type, String provider) Generates a certificate factory object for the specified
certificate type from the specified provider.
Parameters: type - the certificate type Parameters: provider - the name of the provider. | final public static CertificateFactory | getInstance(String type, Provider provider) Generates a certificate factory object for the specified
certificate type from the specified provider. | final public Provider | getProvider() Returns the provider of this certificate factory. | final public String | getType() Returns the name of the certificate type associated with this
certificate factory. |
CertificateFactory | protected CertificateFactory(CertificateFactorySpi certFacSpi, Provider provider, String type)(Code) | | Creates a CertificateFactory object of the given type, and encapsulates
the given provider implementation (SPI object) in it.
Parameters: certFacSpi - the provider implementation. Parameters: provider - the provider. Parameters: type - the certificate type. |
generateCRL | final public CRL generateCRL(InputStream inStream) throws CRLException(Code) | | 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
java.io.InputStream.mark(int) mark and
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.
Parameters: inStream - an input stream with the CRL data. a CRL object initialized with the datafrom the input stream. exception: CRLException - on parsing errors. |
generateCRLs | final public Collection generateCRLs(InputStream inStream) throws CRLException(Code) | | 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 sequence of DER-encoded CRLs.
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
java.io.InputStream.mark(int) mark and
java.io.InputStream.reset reset , this method will
consume the entire input stream.
Parameters: inStream - the input stream with the CRLs. a (possibly empty) collection view ofjava.security.cert.CRL objects initialized with the data from the inputstream. exception: CRLException - on parsing errors. |
generateCertPath | final public CertPath generateCertPath(InputStream inStream) throws CertificateException(Code) | | 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. The name of the default
encoding is the first element of the Iterator returned by
the
CertificateFactory.getCertPathEncodings getCertPathEncodings method.
Parameters: inStream - an InputStream containing the data a CertPath initialized with the data from theInputStream exception: CertificateException - if an exception occurs while decoding since: 1.4 |
generateCertPath | final public CertPath generateCertPath(InputStream inStream, String encoding) throws CertificateException(Code) | | 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. See Appendix A in the
Java Certification Path API Programmer's Guide
for information about standard encoding names and their formats.
Parameters: inStream - an InputStream containing the data Parameters: encoding - the encoding used for the data a CertPath initialized with the data from theInputStream exception: CertificateException - if an exception occurs while decoding orthe encoding requested is not supported since: 1.4 |
generateCertPath | final public CertPath generateCertPath(List certificates) throws CertificateException(Code) | | 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 - a List of Certificate s a CertPath initialized with the supplied list ofcertificates exception: CertificateException - if an exception occurs since: 1.4 |
generateCertificate | final public Certificate generateCertificate(InputStream inStream) throws CertificateException(Code) | | 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
java.io.InputStream.mark(int) mark and
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 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 - an input stream with the certificate data. a certificate object initialized with the datafrom the input stream. exception: CertificateException - on parsing errors. |
generateCertificates | final public Collection generateCertificates(InputStream inStream) throws CertificateException(Code) | | 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 sequence of DER-encoded certificates
in the formats described for
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
java.io.InputStream.mark(int) mark and
java.io.InputStream.reset reset , this method will
consume the entire input stream.
Parameters: inStream - the input stream with the certificates. a (possibly empty) collection view ofjava.security.cert.Certificate objectsinitialized with the data from the input stream. exception: CertificateException - on parsing errors. |
getCertPathEncodings | final public Iterator getCertPathEncodings()(Code) | | 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 and their formats.
Attempts to modify the returned Iterator via its
remove method result in an
UnsupportedOperationException .
an Iterator over the names of the supportedCertPath encodings (as String s) since: 1.4 |
getInstance | final public static CertificateFactory getInstance(String type) throws CertificateException(Code) | | Generates a certificate factory object that implements the
specified certificate type. If the default provider package
provides an implementation of the requested certificate type,
an instance of certificate factory containing that
implementation is returned.
If the type is not available in the default
package, other packages are searched.
Parameters: type - the name of the requested certificate type.See Appendix A in the Java Cryptography Architecture API Specification & Reference for information about standard certificate types. a certificate factory object for the specified type. exception: CertificateException - if the requested certificate type isnot available in the default provider package or any of the otherprovider packages that were searched. |
getInstance | final public static CertificateFactory getInstance(String type, Provider provider) throws CertificateException(Code) | | Generates a certificate factory object for the specified
certificate type from the specified provider.
Note: the provider doesn't have to be registered.
Parameters: type - the certificate type Parameters: provider - the provider a certificate factory object for the specified type. exception: CertificateException - if the certificate type isnot available from the specified provider. exception: IllegalArgumentException - if the provider isnull. See Also: Provider since: 1.4 |
getProvider | final public Provider getProvider()(Code) | | Returns the provider of this certificate factory.
the provider of this certificate factory. |
getType | final public String getType()(Code) | | Returns the name of the certificate type associated with this
certificate factory.
the name of the certificate type associated with thiscertificate factory. |
|
|