com.lowagie.text.pdf
public class PdfSignatureAppearance extends Object
Nested Class Summary | |
---|---|
static class | PdfSignatureAppearance.RangeStream |
interface | PdfSignatureAppearance.SignatureEvent
An interface to retrieve the signature dictionary for modification. |
Field Summary | |
---|---|
boolean | acro6Layers
Holds value of property acro6Layers. |
PdfTemplate[] | app |
byte[] | bout |
int | boutLen |
Certificate[] | certChain |
int | certificationLevel |
String | contact
Holds value of property contact. |
CRL[] | crlList |
PdfDictionary | cryptoDictionary |
static int | CERTIFIED_FORM_FILLING |
static int | CERTIFIED_FORM_FILLING_AND_ANNOTATIONS |
static int | CERTIFIED_NO_CHANGES_ALLOWED |
String | digestEncryptionAlgorithm |
HashMap | exclusionLocations |
byte[] | externalDigest |
byte[] | externalRSAdata |
String | fieldName |
PdfName | filter |
PdfTemplate | frm |
Image | image
Holds value of property image. |
float | imageScale
Holds value of property imageScale. |
Font | layer2Font
Holds value of property layer2Font. |
String | layer2Text |
String | layer4Text
Holds value of property layer4Text. |
String | location |
static float | MARGIN |
boolean | newField |
static int | NOT_CERTIFIED |
OutputStream | originalout |
int | page |
Rectangle | pageRect |
boolean | preClosed |
PrivateKey | privKey |
String | provider |
static String | questionMark
Commands to draw a yellow question mark in a stream content |
RandomAccessFile | raf |
int[] | range |
String | reason |
Rectangle | rect |
int | render |
int | runDirection
Holds value of property runDirection. |
PdfSignatureAppearance.SignatureEvent | signatureEvent
Holds value of property signatureEvent. |
Image | signatureGraphic |
Calendar | signDate |
ByteBuffer | sigout |
PdfSigGenericPKCS | sigStandard |
PdfStamper | stamper |
static PdfName | SELF_SIGNED
The self signed filter. |
static int | SignatureRenderDescription
The rendering mode is just the description |
static int | SignatureRenderGraphicAndDescription
The rendering mode is an image and the description |
static int | SignatureRenderNameAndDescription
The rendering mode is the name of the signer and the description |
File | tempFile |
static float | TOP_SECTION |
static PdfName | VERISIGN_SIGNED
The VeriSign filter. |
PdfStamperImp | writer |
static PdfName | WINCER_SIGNED
The Windows Certificate Security. |
Constructor Summary | |
---|---|
PdfSignatureAppearance(PdfStamperImp writer) |
Method Summary | |
---|---|
void | addDocMDP(PdfDictionary crypto) |
void | close(PdfDictionary update)
This is the last method to be called when using external signatures. |
static float | fitText(Font font, String text, Rectangle rect, float maxFontSize, int runDirection)
Fits the text to some rectangle adjusting the font size as needed. |
PdfTemplate | getAppearance()
Gets the main appearance layer.
|
Certificate[] | getCertChain()
Gets the certificate chain. |
int | getCertificationLevel()
Gets the certified status of this document. |
String | getContact()
Gets the signing contact. |
CRL[] | getCrlList()
Gets the certificate revocation list. |
PdfDictionary | getCryptoDictionary()
Gets the user made signature dictionary. |
String | getFieldName()
Gets the field name. |
PdfName | getFilter()
Gets the filter used to sign the document. |
Image | getImage()
Gets the background image for the layer 2. |
float | getImageScale()
Gets the scaling to be applied to the background image. |
PdfTemplate | getLayer(int layer)
Gets a template layer to create a signature appearance. |
Font | getLayer2Font()
Gets the n2 and n4 layer font. |
String | getLayer2Text()
Gets the signature text identifying the signer if set by setLayer2Text(). |
String | getLayer4Text()
Gets the text identifying the signature status if set by setLayer4Text(). |
String | getLocation()
Gets the signing location. |
String | getNewSigName()
Gets a new signature fied name that doesn't clash with any existing name. |
OutputStream | getOriginalout() |
int | getPage()
Gets the page number of the field. |
Rectangle | getPageRect()
Gets the rectangle that represent the position and dimension of the signature in the page. |
PrivateKey | getPrivKey()
Gets the private key. |
String | getProvider()
Returns the Cryptographic Service Provider that will sign the document. |
InputStream | getRangeStream()
Gets the document bytes that are hashable when using external signatures. |
String | getReason()
Gets the signing reason. |
Rectangle | getRect()
Gets the rectangle representing the signature dimensions. |
int | getRender()
Gets the rendering mode for this signature. |
int | getRunDirection() Gets the run direction. |
PdfSignatureAppearance.SignatureEvent | getSignatureEvent()
Getter for property signatureEvent. |
Image | getSignatureGraphic()
Gets the Image object to render. |
Calendar | getSignDate()
Gets the signature date. |
ByteBuffer | getSigout() |
PdfSigGenericPKCS | getSigStandard()
Gets the instance of the standard signature dictionary. |
PdfStamper | getStamper()
Gets the PdfStamper associated with this instance. |
File | getTempFile()
Gets the temporary file. |
PdfTemplate | getTopLayer()
Gets the template that aggregates all appearance layers. |
boolean | isAcro6Layers()
Gets the Acrobat 6.0 layer mode. |
boolean | isInvisible()
Gets the visibility status of the signature. |
boolean | isNewField()
Checks if a new field was created. |
boolean | isPreClosed()
Checks if the document is in the process of closing. |
void | preClose()
This is the first method to be called when using external signatures. |
void | preClose(HashMap exclusionSizes)
This is the first method to be called when using external signatures. |
void | setAcro6Layers(boolean acro6Layers)
Acrobat 6.0 and higher recomends that only layer n2 and n4 be present. |
void | setCertificationLevel(int certificationLevel)
Sets the document type to certified instead of simply signed. |
void | setContact(String contact)
Sets the signing contact. |
void | setCrypto(PrivateKey privKey, Certificate[] certChain, CRL[] crlList, PdfName filter)
Sets the cryptographic parameters. |
void | setCryptoDictionary(PdfDictionary cryptoDictionary)
Sets a user made signature dictionary. |
void | setExternalDigest(byte[] digest, byte[] RSAdata, String digestEncryptionAlgorithm)
Sets the digest/signature to an external calculated value. |
void | setImage(Image image)
Sets the background image for the layer 2. |
void | setImageScale(float imageScale)
Sets the scaling to be applied to the background image. |
void | setLayer2Font(Font layer2Font)
Sets the n2 and n4 layer font. |
void | setLayer2Text(String text)
Sets the signature text identifying the signer. |
void | setLayer4Text(String text)
Sets the text identifying the signature status. |
void | setLocation(String location)
Sets the signing location. |
void | setOriginalout(OutputStream originalout) |
void | setProvider(String provider)
Sets the Cryptographic Service Provider that will sign the document.
|
void | setReason(String reason)
Sets the signing reason. |
void | setRender(int render)
Sets the rendering mode for this signature.
|
void | setRunDirection(int runDirection) Sets the run direction in the n2 and n4 layer. |
void | setSignatureEvent(PdfSignatureAppearance.SignatureEvent signatureEvent)
Sets the signature event to allow modification of the signature dictionary. |
void | setSignatureGraphic(Image signatureGraphic)
Sets the Image object to render when Render is set to SignatureRenderGraphicAndDescription |
void | setSignDate(Calendar signDate)
Sets the signature date. |
void | setSigout(ByteBuffer sigout) |
void | setStamper(PdfStamper stamper) |
void | setTempFile(File tempFile) |
void | setVisibleSignature(Rectangle pageRect, int page, String fieldName)
Sets the signature to be visible. |
void | setVisibleSignature(String fieldName)
Sets the signature to be visible. |
update
is a PdfDictionary
that must have exactly the
same keys as the ones provided in preClose.
Parameters: update a PdfDictionary
with the key/value that will fill the holes defined
in preClose
Throws: DocumentException on error IOException on error
Parameters: font the font to use text the text rect the rectangle where the text must fit maxFontSize the maximum font size runDirection the run direction
Returns: the calculated font size that makes the text fit
Consult PPKAppearances.pdf for further details.
Returns: the main appearance layer
Throws: DocumentException on error
Returns: the certificate chain
Returns: the certified status
Returns: the signing contact
Returns: the certificate revocation list
Returns: the user made signature dictionary
Returns: the field name
Returns: the filter used to sign the document
Returns: the background image for the layer 2
Returns: the scaling to be applied to the background image
Consult PPKAppearances.pdf for further details.
Parameters: layer the layer
Returns: a template
Returns: the n2 and n4 layer font
Returns: the signature text identifying the signer
Returns: the text identifying the signature status
Returns: the signing location
Returns: a new signature fied name
Returns: the page number of the field
Returns: the rectangle that represent the position and dimension of the signature in the page
Returns: the private key
Returns: provider the name of the provider, for example "SUN",
or null
to use the default provider.
Returns: the document bytes that are hashable
Returns: the signing reason
Returns: the rectangle representing the signature dimensions. It may be null
or have zero width or height for invisible signatures
Returns: the rendering mode for this signature
Returns: the run direction
Returns: Value of property signatureEvent.
Returns: the image
Returns: the signature date
The main use is to insert external signatures.
Returns: the instance of the standard signature dictionary
PdfStamper
associated with this instance.Returns: the PdfStamper
associated with this instance
Returns: the temporary file or null
is the document is created in memory
Consult PPKAppearances.pdf for further details.
Returns: the template that aggregates all appearance layers
Returns: the Acrobat 6.0 layer mode
Returns: the visibility status of the signature
Returns: true
if a new field was created, false
if signing
an existing field or if the signature is invisible
Returns: true
if the document is in the process of closing,
false
otherwise
If calling preClose() dont't call PdfStamper.close().
No external signatures are allowed if this methos is called.
Throws: IOException on error DocumentException on error
If calling preClose() dont't call PdfStamper.close().
If using an external signature exclusionSizes
must contain at least
the PdfName.CONTENTS
key with the size that it will take in the
document. Note that due to the hex string coding this size should be
byte_size*2+2.
Parameters: exclusionSizes a HashMap
with names and sizes to be excluded in the signature
calculation. The key is a PdfName
and the value an
Integer
. At least the PdfName.CONTENTS
must be present
Throws: IOException on error DocumentException on error
Parameters: acro6Layers if true
only the layers n2 and n4 will be present
Parameters: certificationLevel the values can be: NOT_CERTIFIED
, CERTIFIED_NO_CHANGES_ALLOWED
,
CERTIFIED_FORM_FILLING
and CERTIFIED_FORM_FILLING_AND_ANNOTATIONS
Parameters: contact the signing contact
Parameters: privKey the private key certChain the certificate chain crlList the certificate revocation list. It may be null
filter the crytographic filter type. It can be SELF_SIGNED, VERISIGN_SIGNED or WINCER_SIGNED
Parameters: cryptoDictionary a user made signature dictionary
Parameters: digest the digest. This is the actual signature RSAdata the extra data that goes into the data tag in PKCS#7 digestEncryptionAlgorithm the encryption algorithm. It may must be null
if the digest
is also null
. If the digest
is not null
then it may be "RSA" or "DSA"
Parameters: image the background image for the layer 2
Parameters: imageScale the scaling to be applied to the background image
Parameters: layer2Font the n2 and n4 font
Parameters: text the signature text identifying the signer. If null
or not set
a standard description will be used
Parameters: text the text identifying the signature status. If null
or not set
the description "Signature Not Verified" will be used
Parameters: location the signing location
Parameters: provider the name of the provider, for example "SUN", or
null
to use the default provider.
Parameters: reason the signing reason
SignatureRenderDescription
,
SignatureRenderNameAndDescription
or SignatureRenderGraphicAndDescription
.
The two last modes should be used with Acrobat 6 layer type.Parameters: render the render mode
Parameters: runDirection the run direction
Parameters: signatureEvent the signature event
SignatureRenderGraphicAndDescription
Parameters: signatureGraphic image rendered. If null
the mode is defaulted
to SignatureRenderDescription
Parameters: signDate the signature date
Parameters: pageRect the position and dimension of the field in the page page the page to place the field. The fist page is 1 fieldName the field name or null
to generate automatically a new field name
Parameters: fieldName the existing empty signature field name