com.crionics.jpdf
Class SignerModule

java.lang.Object
  PdfModule
      com.crionics.jpdf.AbstractModule
          com.crionics.jpdf.SignerModule

public final class SignerModule
extends AbstractModule

This Object is used to access all the Signature Form Field present in a Pdf Document.

Field Summary

Fields inherited from class com.crionics.jpdf.AbstractModule

MOD_CREATOR, MOD_DESCRIPTION, MOD_ENCRYPTION, MOD_MERGER, MOD_PRINTER, MOD_SECURITY, MOD_SIGNER, MOD_TEMPLATE

Method Summary

boolean	containsSignature(java.lang.String fieldName) Search for the existence of a field with the specified name
SignatureField	getSignature(java.lang.String SignatureName) Retrieves the signature with the given name
java.util.List	getSignatureList() Retrieve all the signatures in the PDF document.
boolean	hasSignatures() Return true if the document contains form fields
java.security.KeyStore	loadAKFKeyStore(java.io.InputStream is) Opens a KeyStore from the given inputstream, using the password
java.security.KeyStore	loadFDFKeyStore(java.io.InputStream is) Opens a KeyStore from the given inputstream, using the password
java.security.KeyStore	loadP7BKeyStore(java.io.InputStream is) Opens a KeyStore from the given inputstream, using the password
void	showJCEInfo(boolean fullDescription) Handy method which displays all the installed JCE providers on the console.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

containsSignature

public boolean containsSignature(java.lang.String fieldName)
                          throws java.io.IOException,
                                 PdfException

Search for the existence of a field with the specified name

Parameters:

fieldName - The name of the field to search for.

Returns:

true if there a field exist with the specified name, false otherwise.

Throws:

java.io.IOException - Raised if a problem occured while reading the file.

PdfException - Raised if a problem occured while parsing the file.

getSignature

public SignatureField getSignature(java.lang.String SignatureName)
                            throws PdfException,
                                   java.io.IOException

Retrieves the signature with the given name

Parameters:

SignatureName - The name of the signature.

Returns:

The Signature found. null if not found

Throws:

PdfException - Raised if a problem occured while parsing the file.

java.io.IOException - Raised if a problem occured while reading the file.

getSignatureList

public java.util.List getSignatureList()
                                throws PdfException,
                                       java.io.IOException

Retrieve all the signatures in the PDF document.

Returns:

A list of Signature objects.

Throws:

PdfException - Raised if a problem occured while parsing the file.

java.io.IOException - Raised if a problem occured while reading the file.

hasSignatures

public boolean hasSignatures()
                      throws java.io.IOException,
                             PdfException

Return true if the document contains form fields

Returns:

true if the document contains form fields

Throws:

java.io.IOException - Raised if a problem occured while reading the file.

PdfException - Raised if a problem occured while parsing the file.

loadAKFKeyStore

public java.security.KeyStore loadAKFKeyStore(java.io.InputStream is)
                                       throws java.io.IOException,
                                              PdfException

Opens a KeyStore from the given inputstream, using the password

Parameters:

is - an inputstream pointing at the data

Returns:

the loaded keystore

Throws:

PdfException - Raised if a problem occured while parsing the file.

java.io.IOException - Raised if a problem occured while reading the file.

loadFDFKeyStore

public java.security.KeyStore loadFDFKeyStore(java.io.InputStream is)
                                       throws PdfException,
                                              java.io.IOException

Opens a KeyStore from the given inputstream, using the password

Parameters:

is - an inputstream pointing at the data

Returns:

the loaded keystore

Throws:

PdfException - Raised if a problem occured while parsing the file.

java.io.IOException - Raised if a problem occured while reading the file.

loadP7BKeyStore

public java.security.KeyStore loadP7BKeyStore(java.io.InputStream is)
                                       throws java.io.IOException,
                                              java.security.GeneralSecurityException,
                                              PdfException

Opens a KeyStore from the given inputstream, using the password

Parameters:

is - an inputstream pointing at the data

Returns:

the loaded keystore

Throws:

java.security.KeyStoreException

java.security.NoSuchAlgorithmException

java.security.cert.CertificateException

PdfException - Raised if a problem occured while parsing the file.

java.io.IOException - Raised if a problem occured while reading the file.

java.security.GeneralSecurityException

showJCEInfo

public void showJCEInfo(boolean fullDescription)

Handy method which displays all the installed JCE providers on the console. Crionics support might ask you to use this method to verify your installation.

Parameters:

fullDescription - if true, shows details about the algithms supported in each JCE