org.apache.pdfbox.examples.signature

Class CreateVisibleSignature

java.lang.Object

org.apache.pdfbox.examples.signature.CreateSignatureBase

org.apache.pdfbox.examples.signature.CreateVisibleSignature

All Implemented Interfaces:

SignatureInterface

public class CreateVisibleSignature
extends CreateSignatureBase

This is an example for visual signing a pdf.

Author:

Vakhtang Koroghlishvili

See Also:

CreateSignature

Constructor Summary

Constructors

Constructor and Description
CreateVisibleSignature(KeyStore keystore, char[] pin) Initialize the signature creator with a keystore (pkcs12) and pin that should be used for the signature.

Method Summary

Modifier and Type	Method and Description
boolean	isLateExternalSigning()
static void	main(String[] args) Arguments are [0] key store [1] pin [2] document that will be signed [3] image of visible signature
void	setLateExternalSigning(boolean lateExternalSigning) Set late external signing.
void	setVisibleSignatureProperties(String name, String location, String reason, boolean visualSignEnabled) Set visible signature properties for existing signature fields.
void	setVisibleSignatureProperties(String name, String location, String reason, int preferredSize, int page, boolean visualSignEnabled) Set visible signature properties for new signature fields.
void	setVisibleSignDesigner(int zoomPercent, InputStream imageStream) Set visible signature designer for an existing signature field.
void	setVisibleSignDesigner(String filename, int x, int y, int zoomPercent, InputStream imageStream, int page) Set visible signature designer for a new signature field.
void	signPDF(File inputFile, File signedFile, String tsaUrl) Sign pdf file and create new file that ends with "_signed.pdf".
void	signPDF(File inputFile, File signedFile, String tsaUrl, String signatureFieldName) Sign pdf file and create new file that ends with "_signed.pdf".

Methods inherited from class org.apache.pdfbox.examples.signature.CreateSignatureBase

isExternalSigning, setCertificateChain, setExternalSigning, setPrivateKey, setTsaUrl, sign

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateVisibleSignature

public CreateVisibleSignature(KeyStore keystore,
                              char[] pin)
                       throws KeyStoreException,
                              UnrecoverableKeyException,
                              NoSuchAlgorithmException,
                              IOException,
                              CertificateException

Initialize the signature creator with a keystore (pkcs12) and pin that should be used for the signature.

Parameters:

keystore - is a pkcs12 keystore.

pin - is the pin for the keystore / private key

Throws:

KeyStoreException - if the keystore has not been initialized (loaded)

NoSuchAlgorithmException - if the algorithm for recovering the key cannot be found

UnrecoverableKeyException - if the given password is wrong

CertificateException - if the certificate is not valid as signing time

IOException - if no certificate could be found

Method Detail

isLateExternalSigning

public boolean isLateExternalSigning()

setLateExternalSigning

public void setLateExternalSigning(boolean lateExternalSigning)

Set late external signing. Enable this if you want to activate the demo code where the signature is kept and added in an extra step without using PDFBox methods. This is disabled by default.

Parameters:

lateExternalSigning -

setVisibleSignDesigner

public void setVisibleSignDesigner(String filename,
                                   int x,
                                   int y,
                                   int zoomPercent,
                                   InputStream imageStream,
                                   int page)
                            throws IOException

Set visible signature designer for a new signature field.

Parameters:

filename -

x - position of the signature field

y - position of the signature field

zoomPercent - increase (positive value) or decrease (negative value) image with x percent.

imageStream - input stream of an image.

page - the signature should be placed on

Throws:

IOException

setVisibleSignDesigner

public void setVisibleSignDesigner(int zoomPercent,
                                   InputStream imageStream)
                            throws IOException

Set visible signature designer for an existing signature field.

Parameters:

zoomPercent - increase (positive value) or decrease (negative value) image with x percent.

imageStream - input stream of an image.

Throws:

IOException

setVisibleSignatureProperties

public void setVisibleSignatureProperties(String name,
                                          String location,
                                          String reason,
                                          int preferredSize,
                                          int page,
                                          boolean visualSignEnabled)

Set visible signature properties for new signature fields.

Parameters:

name -

location -

reason -

preferredSize -

page -

visualSignEnabled -

setVisibleSignatureProperties

public void setVisibleSignatureProperties(String name,
                                          String location,
                                          String reason,
                                          boolean visualSignEnabled)

Set visible signature properties for existing signature fields.

Parameters:

name -

location -

reason -

visualSignEnabled -

signPDF

public void signPDF(File inputFile,
                    File signedFile,
                    String tsaUrl)
             throws IOException

Sign pdf file and create new file that ends with "_signed.pdf".

Parameters:

inputFile - The source pdf document file.

signedFile - The file to be signed.

tsaUrl - optional TSA url

Throws:

IOException

signPDF

public void signPDF(File inputFile,
                    File signedFile,
                    String tsaUrl,
                    String signatureFieldName)
             throws IOException

Sign pdf file and create new file that ends with "_signed.pdf".

Parameters:

inputFile - The source pdf document file.

signedFile - The file to be signed.

tsaUrl - optional TSA url

signatureFieldName - optional name of an existing (unsigned) signature field

Throws:

IOException

main

public static void main(String[] args)
                 throws KeyStoreException,
                        CertificateException,
                        IOException,
                        NoSuchAlgorithmException,
                        UnrecoverableKeyException

Arguments are [0] key store [1] pin [2] document that will be signed [3] image of visible signature

Parameters:

args -

Throws:

KeyStoreException

CertificateException

IOException

NoSuchAlgorithmException

UnrecoverableKeyException