java.security.cert
Class CertificateFactorySpi

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.security.cert.CertificateFactorySpi

public abstract class CertificateFactorySpi
extends Object sample code for java.lang.Object definition code for java.lang.Object

This class defines the Service Provider Interface (SPI) for the 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.

Since:
1.2
See Also:
CertificateFactory sample code for java.security.cert.CertificateFactory definition code for java.security.cert.CertificateFactory , Certificate sample code for java.security.cert.Certificate definition code for java.security.cert.Certificate , X509Certificate sample code for java.security.cert.X509Certificate definition code for java.security.cert.X509Certificate , CertPath sample code for java.security.cert.CertPath definition code for java.security.cert.CertPath , CRL sample code for java.security.cert.CRL definition code for java.security.cert.CRL , X509CRL sample code for java.security.cert.X509CRL definition code for java.security.cert.X509CRL

Constructor Summary
CertificateFactorySpi sample code for java.security.cert.CertificateFactorySpi.CertificateFactorySpi() definition code for java.security.cert.CertificateFactorySpi.CertificateFactorySpi() ()
           
 
Method Summary
abstract  Certificate sample code for java.security.cert.Certificate definition code for java.security.cert.Certificate engineGenerateCertificate sample code for java.security.cert.CertificateFactorySpi.engineGenerateCertificate(java.io.InputStream) definition code for java.security.cert.CertificateFactorySpi.engineGenerateCertificate(java.io.InputStream) (InputStream sample code for java.io.InputStream definition code for java.io.InputStream  inStream)
          Generates a certificate object and initializes it with the data read from the input stream inStream.
abstract  Collection sample code for java.util.Collection definition code for java.util.Collection <? extends Certificate sample code for java.security.cert.Certificate definition code for java.security.cert.Certificate > engineGenerateCertificates sample code for java.security.cert.CertificateFactorySpi.engineGenerateCertificates(java.io.InputStream) definition code for java.security.cert.CertificateFactorySpi.engineGenerateCertificates(java.io.InputStream) (InputStream sample code for java.io.InputStream definition code for java.io.InputStream  inStream)
          Returns a (possibly empty) collection view of the certificates read from the given input stream inStream.
 CertPath sample code for java.security.cert.CertPath definition code for java.security.cert.CertPath engineGenerateCertPath sample code for java.security.cert.CertificateFactorySpi.engineGenerateCertPath(java.io.InputStream) definition code for java.security.cert.CertificateFactorySpi.engineGenerateCertPath(java.io.InputStream) (InputStream sample code for java.io.InputStream definition code for java.io.InputStream  inStream)
          Generates a CertPath object and initializes it with the data read from the InputStream inStream.
 CertPath sample code for java.security.cert.CertPath definition code for java.security.cert.CertPath engineGenerateCertPath sample code for java.security.cert.CertificateFactorySpi.engineGenerateCertPath(java.io.InputStream, java.lang.String) definition code for java.security.cert.CertificateFactorySpi.engineGenerateCertPath(java.io.InputStream, java.lang.String) (InputStream sample code for java.io.InputStream definition code for java.io.InputStream  inStream, String sample code for java.lang.String definition code for java.lang.String  encoding)
          Generates a CertPath object and initializes it with the data read from the InputStream inStream.
 CertPath sample code for java.security.cert.CertPath definition code for java.security.cert.CertPath engineGenerateCertPath sample code for java.security.cert.CertificateFactorySpi.engineGenerateCertPath(java.util.List) definition code for java.security.cert.CertificateFactorySpi.engineGenerateCertPath(java.util.List) (List sample code for java.util.List definition code for java.util.List <? extends Certificate sample code for java.security.cert.Certificate definition code for java.security.cert.Certificate > certificates)
          Generates a CertPath object and initializes it with a List of Certificates.
abstract  CRL sample code for java.security.cert.CRL definition code for java.security.cert.CRL engineGenerateCRL sample code for java.security.cert.CertificateFactorySpi.engineGenerateCRL(java.io.InputStream) definition code for java.security.cert.CertificateFactorySpi.engineGenerateCRL(java.io.InputStream) (InputStream sample code for java.io.InputStream definition code for java.io.InputStream  inStream)
          Generates a certificate revocation list (CRL) object and initializes it with the data read from the input stream inStream.
abstract  Collection sample code for java.util.Collection definition code for java.util.Collection <? extends CRL sample code for java.security.cert.CRL definition code for java.security.cert.CRL > engineGenerateCRLs sample code for java.security.cert.CertificateFactorySpi.engineGenerateCRLs(java.io.InputStream) definition code for java.security.cert.CertificateFactorySpi.engineGenerateCRLs(java.io.InputStream) (InputStream sample code for java.io.InputStream definition code for java.io.InputStream  inStream)
          Returns a (possibly empty) collection view of the CRLs read from the given input stream inStream.
 Iterator sample code for java.util.Iterator definition code for java.util.Iterator <String sample code for java.lang.String definition code for java.lang.String > engineGetCertPathEncodings sample code for java.security.cert.CertificateFactorySpi.engineGetCertPathEncodings() definition code for java.security.cert.CertificateFactorySpi.engineGetCertPathEncodings() ()
          Returns an iteration of the CertPath encodings supported by this certificate factory, with the default encoding first.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

CertificateFactorySpi sample code for java.security.cert.CertificateFactorySpi() definition code for java.security.cert.CertificateFactorySpi()

public CertificateFactorySpi()
Method Detail

engineGenerateCertificate sample code for java.security.cert.CertificateFactorySpi.engineGenerateCertificate(java.io.InputStream) definition code for java.security.cert.CertificateFactorySpi.engineGenerateCertificate(java.io.InputStream)

public abstract Certificate sample code for java.security.cert.Certificate definition code for java.security.cert.Certificate  engineGenerateCertificate(InputStream sample code for java.io.InputStream definition code for java.io.InputStream  inStream)
                                               throws CertificateException sample code for java.security.cert.CertificateException definition code for java.security.cert.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 sample code for java.io.InputStream.mark(int) definition code for java.io.InputStream.mark(int) and reset sample code for java.io.InputStream.reset() definition code for java.io.InputStream.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 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.
Returns:
a certificate object initialized with the data from the input stream.
Throws:
CertificateException sample code for java.security.cert.CertificateException definition code for java.security.cert.CertificateException - on parsing errors.

engineGenerateCertPath sample code for java.security.cert.CertificateFactorySpi.engineGenerateCertPath(java.io.InputStream) definition code for java.security.cert.CertificateFactorySpi.engineGenerateCertPath(java.io.InputStream)

public CertPath sample code for java.security.cert.CertPath definition code for java.security.cert.CertPath  engineGenerateCertPath(InputStream sample code for java.io.InputStream definition code for java.io.InputStream  inStream)
                                throws CertificateException sample code for java.security.cert.CertificateException definition code for java.security.cert.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 - an InputStream containing the data
Returns:
a CertPath initialized with the data from the InputStream
Throws:
CertificateException sample code for java.security.cert.CertificateException definition code for java.security.cert.CertificateException - if an exception occurs while decoding
UnsupportedOperationException sample code for java.lang.UnsupportedOperationException definition code for java.lang.UnsupportedOperationException - if the method is not supported
Since:
1.4

engineGenerateCertPath sample code for java.security.cert.CertificateFactorySpi.engineGenerateCertPath(java.io.InputStream, java.lang.String) definition code for java.security.cert.CertificateFactorySpi.engineGenerateCertPath(java.io.InputStream, java.lang.String)

public CertPath sample code for java.security.cert.CertPath definition code for java.security.cert.CertPath  engineGenerateCertPath(InputStream sample code for java.io.InputStream definition code for java.io.InputStream  inStream,
                                       String sample code for java.lang.String definition code for java.lang.String  encoding)
                                throws CertificateException sample code for java.security.cert.CertificateException definition code for java.security.cert.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 - an InputStream containing the data
encoding - the encoding used for the data
Returns:
a CertPath initialized with the data from the InputStream
Throws:
CertificateException sample code for java.security.cert.CertificateException definition code for java.security.cert.CertificateException - if an exception occurs while decoding or the encoding requested is not supported
UnsupportedOperationException sample code for java.lang.UnsupportedOperationException definition code for java.lang.UnsupportedOperationException - if the method is not supported
Since:
1.4

engineGenerateCertPath sample code for java.security.cert.CertificateFactorySpi.engineGenerateCertPath(java.util.List<? extends java.security.cert.Certificate>) definition code for java.security.cert.CertificateFactorySpi.engineGenerateCertPath(java.util.List<? extends java.security.cert.Certificate>)

public CertPath sample code for java.security.cert.CertPath definition code for java.security.cert.CertPath  engineGenerateCertPath(List sample code for java.util.List definition code for java.util.List <? extends Certificate sample code for java.security.cert.Certificate definition code for java.security.cert.Certificate > certificates)
                                throws CertificateException sample code for java.security.cert.CertificateException definition code for java.security.cert.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.

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 - a List of Certificates
Returns:
a CertPath initialized with the supplied list of certificates
Throws:
CertificateException sample code for java.security.cert.CertificateException definition code for java.security.cert.CertificateException - if an exception occurs
UnsupportedOperationException sample code for java.lang.UnsupportedOperationException definition code for java.lang.UnsupportedOperationException - if the method is not supported
Since:
1.4

engineGetCertPathEncodings sample code for java.security.cert.CertificateFactorySpi.engineGetCertPathEncodings() definition code for java.security.cert.CertificateFactorySpi.engineGetCertPathEncodings()

public Iterator sample code for java.util.Iterator definition code for java.util.Iterator <String sample code for java.lang.String definition code for java.lang.String > engineGetCertPathEncodings()
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.

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:
an Iterator over the names of the supported CertPath encodings (as Strings)
Throws:
UnsupportedOperationException sample code for java.lang.UnsupportedOperationException definition code for java.lang.UnsupportedOperationException - if the method is not supported
Since:
1.4

engineGenerateCertificates sample code for java.security.cert.CertificateFactorySpi.engineGenerateCertificates(java.io.InputStream) definition code for java.security.cert.CertificateFactorySpi.engineGenerateCertificates(java.io.InputStream)

public abstract Collection sample code for java.util.Collection definition code for java.util.Collection <? extends Certificate sample code for java.security.cert.Certificate definition code for java.security.cert.Certificate > engineGenerateCertificates(InputStream sample code for java.io.InputStream definition code for java.io.InputStream  inStream)
                                                                      throws CertificateException sample code for java.security.cert.CertificateException definition code for java.security.cert.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 sample code for java.security.cert.CertificateFactory.generateCertificate(java.io.InputStream) definition code for java.security.cert.CertificateFactory.generateCertificate(java.io.InputStream) . 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 sample code for java.io.InputStream.mark(int) definition code for java.io.InputStream.mark(int) and reset sample code for java.io.InputStream.reset() definition code for java.io.InputStream.reset() , this method will consume the entire input stream.

Parameters:
inStream - the input stream with the certificates.
Returns:
a (possibly empty) collection view of java.security.cert.Certificate objects initialized with the data from the input stream.
Throws:
CertificateException sample code for java.security.cert.CertificateException definition code for java.security.cert.CertificateException - on parsing errors.

engineGenerateCRL sample code for java.security.cert.CertificateFactorySpi.engineGenerateCRL(java.io.InputStream) definition code for java.security.cert.CertificateFactorySpi.engineGenerateCRL(java.io.InputStream)

public abstract CRL sample code for java.security.cert.CRL definition code for java.security.cert.CRL  engineGenerateCRL(InputStream sample code for java.io.InputStream definition code for java.io.InputStream  inStream)
                               throws CRLException sample code for java.security.cert.CRLException definition code for java.security.cert.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 sample code for java.io.InputStream.mark(int) definition code for java.io.InputStream.mark(int) and reset sample code for java.io.InputStream.reset() definition code for java.io.InputStream.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.
Returns:
a CRL object initialized with the data from the input stream.
Throws:
CRLException sample code for java.security.cert.CRLException definition code for java.security.cert.CRLException - on parsing errors.

engineGenerateCRLs sample code for java.security.cert.CertificateFactorySpi.engineGenerateCRLs(java.io.InputStream) definition code for java.security.cert.CertificateFactorySpi.engineGenerateCRLs(java.io.InputStream)

public abstract Collection sample code for java.util.Collection definition code for java.util.Collection <? extends CRL sample code for java.security.cert.CRL definition code for java.security.cert.CRL > engineGenerateCRLs(InputStream sample code for java.io.InputStream definition code for java.io.InputStream  inStream)
                                                      throws CRLException sample code for java.security.cert.CRLException definition code for java.security.cert.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 sample code for java.io.InputStream.mark(int) definition code for java.io.InputStream.mark(int) and reset sample code for java.io.InputStream.reset() definition code for java.io.InputStream.reset() , this method will consume the entire input stream.

Parameters:
inStream - the input stream with the CRLs.
Returns:
a (possibly empty) collection view of java.security.cert.CRL objects initialized with the data from the input stream.
Throws:
CRLException sample code for java.security.cert.CRLException definition code for java.security.cert.CRLException - on parsing errors.