FileDocCategorySizeDatePackage
CertificateFactory.javaAPI DocJava SE 5 API18672Fri Aug 26 14:57:16 BST 2005java.security.cert

CertificateFactory

public class CertificateFactory extends Object
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. Otherwise, use generateCertPath when you want to generate a CertPath (a certificate chain) and subsequently validate it with a CertPathValidator.

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.28, 05/05/04
see
Certificate
see
X509Certificate
see
CertPath
see
CRL
see
X509CRL
since
1.2

Fields Summary
private String
type
private Provider
provider
private CertificateFactorySpi
certFacSpi
Constructors Summary
protected CertificateFactory(CertificateFactorySpi certFacSpi, Provider provider, String type)
Creates a CertificateFactory object of the given type, and encapsulates the given provider implementation (SPI object) in it.

param
certFacSpi the provider implementation.
param
provider the provider.
param
type the certificate type.

	this.certFacSpi = certFacSpi;
	this.provider = provider;
	this.type = type;
    
Methods Summary
public final java.security.cert.CRLgenerateCRL(java.io.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. 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.

	return certFacSpi.engineGenerateCRL(inStream);
    
public final java.util.CollectiongenerateCRLs(java.io.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. 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 {@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.

	return certFacSpi.engineGenerateCRLs(inStream);
    
public final java.security.cert.CertPathgenerateCertPath(java.io.InputStream inStream, java.lang.String encoding)
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.

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
since
1.4

        return(certFacSpi.engineGenerateCertPath(inStream, encoding));
    
public final java.security.cert.CertPathgenerateCertPath(java.util.List certificates)
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.

param
certificates a List of Certificates
return
a CertPath initialized with the supplied list of certificates
exception
CertificateException if an exception occurs
since
1.4

        return(certFacSpi.engineGenerateCertPath(certificates));
    
public final java.security.cert.CertPathgenerateCertPath(java.io.InputStream inStream)
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 {@link #getCertPathEncodings getCertPathEncodings} method.

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

        return(certFacSpi.engineGenerateCertPath(inStream));
    
public final java.security.cert.CertificategenerateCertificate(java.io.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. 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 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.

	return certFacSpi.engineGenerateCertificate(inStream);
    
public final java.util.CollectiongenerateCertificates(java.io.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. 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 {@link #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.

	return certFacSpi.engineGenerateCertificates(inStream);
    
public final java.util.IteratorgetCertPathEncodings()
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.

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

        return(certFacSpi.engineGetCertPathEncodings());
    
public static final java.security.cert.CertificateFactorygetInstance(java.lang.String type)
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.

param
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.
return
a certificate factory object for the specified type.
exception
CertificateException if the requested certificate type is not available in the default provider package or any of the other provider packages that were searched.

	try {
	    Instance instance = GetInstance.getInstance("CertificateFactory", 
	    	CertificateFactorySpi.class, type);
	    return new CertificateFactory((CertificateFactorySpi)instance.impl,
	    	instance.provider, type);
	} catch (NoSuchAlgorithmException e) {
	    throw new CertificateException(type + " not found", e);
	}
    
public static final java.security.cert.CertificateFactorygetInstance(java.lang.String type, java.lang.String provider)
Generates a certificate factory object for the specified certificate type from the specified provider.

param
type the certificate type
param
provider the name of the provider.
return
a certificate factory object for the specified type.
exception
CertificateException if the certificate type is not available from the specified provider.
exception
NoSuchProviderException if the provider has not been configured.
see
Provider

	try {
	    Instance instance = GetInstance.getInstance("CertificateFactory",
	    	CertificateFactorySpi.class, type, provider);
	    return new CertificateFactory((CertificateFactorySpi)instance.impl,
	    	instance.provider, type);
	} catch (NoSuchAlgorithmException e) {
	    throw new CertificateException(type + " not found", e);
	}
    
public static final java.security.cert.CertificateFactorygetInstance(java.lang.String type, java.security.Provider provider)
Generates a certificate factory object for the specified certificate type from the specified provider. Note: the provider doesn't have to be registered.

param
type the certificate type
param
provider the provider
return
a certificate factory object for the specified type.
exception
CertificateException if the certificate type is not available from the specified provider.
exception
IllegalArgumentException if the provider is null.
see
Provider
since
1.4

	try {
	    Instance instance = GetInstance.getInstance("CertificateFactory",
	    	CertificateFactorySpi.class, type, provider);
	    return new CertificateFactory((CertificateFactorySpi)instance.impl, 
	    	instance.provider, type);
	} catch (NoSuchAlgorithmException e) {
	    throw new CertificateException(type + " not found", e);
	}
    
public final java.security.ProvidergetProvider()
Returns the provider of this certificate factory.

return
the provider of this certificate factory.

	return this.provider;
    
public final java.lang.StringgetType()
Returns the name of the certificate type associated with this certificate factory.

return
the name of the certificate type associated with this certificate factory.

	return this.type;