de.intarsys.pdf.pd

Class PDSignature

java.lang.Object

de.intarsys.pdf.cos.COSBasedObject

de.intarsys.pdf.pd.PDObject

de.intarsys.pdf.pd.PDSignature

All Implemented Interfaces:

ICOSObjectListener, de.intarsys.tools.attribute.IAttributeSupport

Direct Known Subclasses:

PDDocumentTimeStamp

public class PDSignature
extends PDObject

This class represents the signature object referenced for example in an AcroForm signature field.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PDSignature.MetaClass The meta class implementation

Field Summary

Fields

Modifier and Type	Field and Description
static COSName	CN_Type_Sig
static COSName	DK_ByteRange
static COSName	DK_Cert
static COSName	DK_Changes
static COSName	DK_ContactInfo
static COSName	DK_Contents
static COSName	DK_Filter
static COSName	DK_Location
static COSName	DK_M
static COSName	DK_Name
static COSName	DK_Prop_AuthTime
static COSName	DK_Prop_AuthType
static COSName	DK_Prop_Build
static COSName	DK_R
static COSName	DK_Reason
static COSName	DK_Reference
static COSName	DK_SubFilter
static COSName	DK_V
static PDSignature.MetaClass	META The meta class instance

Fields inherited from class de.intarsys.pdf.pd.PDObject

DK_Subtype, DK_Type

Method Summary

Methods

Modifier and Type	Method and Description
COSArray	cosGetByteRange()
PDAFSignatureField	getAcroFormField()
PDBuildProperties	getBuildProperties()
List	getCert() Get a List of certificates, the first one is the certificate of the signer himself.
String	getContactInfo()
byte[]	getContentBytes()
CDSDate	getDate()
COSName	getFilter() Filter is a name for the original signature creator, for example: Adobe.PPKLite
String	getLocation()
String	getName()
String	getReason()
List	getSignatureReferences()
COSName	getSubFilter() SubFilter is the name of a encoding and storage algorithm.
void	invalidateCaches() Invalidate all local caches as the base object may have changed.
void	setAcroFormField(PDAFSignatureField acroFormField)
void	setBuildProperties(PDBuildProperties buildProperties)
void	setCert(byte[] certificate) Sets certificates in the /Cert field.
void	setCert(List certificates) Sets certificates in the /Cert field.
void	setContactInfo(String contactInfo)
void	setDate(CDSDate date)
void	setFilter(COSName filter) Set the name of the signature creator, for example: Adobe.PPKLite
void	setLocation(String location)
void	setName(String name)
void	setReason(String reason)
void	setSignatureReferences(List signatureReferences)
void	setSubFilter(COSName subfilter) Set the name of the encoding algorithm

Methods inherited from class de.intarsys.pdf.pd.PDObject

cosGetFieldDescendant, cosGetFieldInheritable, cosGetFieldInherited, cosGetSubtype, cosGetType, cosRemoveFieldInheritable, cosSetFieldInheritable, cosSetSubtype, cosSetType, getDoc, getGenericChildren, getGenericParent, setGenericParent, toString

Methods inherited from class de.intarsys.pdf.cos.COSBasedObject

changed, cosGetArray, cosGetDict, cosGetDoc, cosGetField, cosGetObject, cosGetStream, cosHasField, cosRemoveField, cosSetField, getAttribute, getFieldBoolean, getFieldDate, getFieldFixed, getFieldFixedArray, getFieldInt, getFieldMLString, getFieldString, removeAttribute, setAttribute, setFieldBoolean, setFieldFixed, setFieldInt, setFieldMLString, setFieldName, setFieldObject, setFieldString

Methods inherited from class java.lang.Object

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

Field Detail

META

public static final PDSignature.MetaClass META

The meta class instance

CN_Type_Sig

public static final COSName CN_Type_Sig

DK_Filter

public static final COSName DK_Filter

DK_SubFilter

public static final COSName DK_SubFilter

DK_Contents

public static final COSName DK_Contents

DK_Cert

public static final COSName DK_Cert

DK_ByteRange

public static final COSName DK_ByteRange

DK_Reference

public static final COSName DK_Reference

DK_Changes

public static final COSName DK_Changes

DK_Name

public static final COSName DK_Name

DK_M

public static final COSName DK_M

DK_Location

public static final COSName DK_Location

DK_Reason

public static final COSName DK_Reason

DK_ContactInfo

public static final COSName DK_ContactInfo

DK_R

public static final COSName DK_R

DK_V

public static final COSName DK_V

DK_Prop_Build

public static final COSName DK_Prop_Build

DK_Prop_AuthTime

public static final COSName DK_Prop_AuthTime

DK_Prop_AuthType

public static final COSName DK_Prop_AuthType

Method Detail

cosGetByteRange

public COSArray cosGetByteRange()

Returns:

the byte range for the signature or null

getAcroFormField

public PDAFSignatureField getAcroFormField()

getBuildProperties

public PDBuildProperties getBuildProperties()

getCert

public List getCert()

Get a List of certificates, the first one is the certificate of the signer himself. Followed by certificates of certificate authoritys.

A certificate is stored as DER encoded byte[]

Returns:

a List of certificates or null

getContactInfo

public String getContactInfo()

Returns:

how to contact the signer or null

getContentBytes

public byte[] getContentBytes()

Returns:

content of '/Contents' field or an empty byte array if the content could not be read

getDate

public CDSDate getDate()

Returns:

the date the signature took place

getFilter

public COSName getFilter()

Filter is a name for the original signature creator, for example: Adobe.PPKLite

Returns:

name of the signature creator

getLocation

public String getLocation()

Returns:

where the document was signed or null

getName

public String getName()

Returns:

name of the signer or null

getReason

public String getReason()

Returns:

reason for signing this document or null

getSignatureReferences

public List getSignatureReferences()

getSubFilter

public COSName getSubFilter()

SubFilter is the name of a encoding and storage algorithm.

Returns:

the name of the encoding algorithm

invalidateCaches

public void invalidateCaches()

Description copied from class: COSBasedObject

Invalidate all local caches as the base object may have changed.

Overrides:

invalidateCaches in class COSBasedObject

setAcroFormField

public void setAcroFormField(PDAFSignatureField acroFormField)

setBuildProperties

public void setBuildProperties(PDBuildProperties buildProperties)

setCert

public void setCert(byte[] certificate)

Sets certificates in the /Cert field.

Parameters:

certificate - a DER encoded byte[]

setCert

public void setCert(List certificates)

Sets certificates in the /Cert field.

Parameters:

certificates - a list of DER encoded byte[]

setContactInfo

public void setContactInfo(String contactInfo)

Parameters:

contactInfo - how to contact the signer, may be null

setDate

public void setDate(CDSDate date)

setFilter

public void setFilter(COSName filter)

Set the name of the signature creator, for example: Adobe.PPKLite

Parameters:

filter - name of the signature creator

setLocation

public void setLocation(String location)

Parameters:

location - location the signer signed the document, may be null

setName

public void setName(String name)

Parameters:

name - name of the signer, may be null

setReason

public void setReason(String reason)

Parameters:

reason - reason why is document was signed, may be null

setSignatureReferences

public void setSignatureReferences(List signatureReferences)

setSubFilter

public void setSubFilter(COSName subfilter)

Set the name of the encoding algorithm

Parameters:

subfilter - name of the encoding algorithm