Package eu.europa.esig.dss.pdf

Class PdfSigDictWrapper

java.lang.Object

eu.europa.esig.dss.pdf.PdfSigDictWrapper

All Implemented Interfaces:

PdfSignatureDictionary

public class PdfSigDictWrapper
extends Object
implements PdfSignatureDictionary

The default implementation of PdfSignatureDictionary

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PdfSigDictWrapper()	Default constructor
	PdfSigDictWrapper(PdfDict dictionary)	Deprecated. since DSS 6.3.

Method Summary

Modifier and Type	Method	Description
boolean	checkConsistency(PdfSignatureDictionary signatureDictionary)	Verifies the equality of the current PdfSignatureDictionary with provided signatureDictionary.
ByteRange	getByteRange()	Gets the signed/timestamped ByteRange
CMS	getCMS()	Gets the CMS from /Contents
String	getContactInfo()	Gets the signer's contact info
byte[]	getContents()	Gets /Contents binaries (CMSSignedData)
CertificationPermission	getDocMDP()	Returns a /DocMDP dictionary, when present
SigFieldPermissions	getFieldMDP()	Returns a /FieldMDP dictionary, when present
String	getFilter()	Gets the Filter value
String	getLocation()	Gets the signer's location
String	getReason()	Gets the signing reason
String	getSignerName()	Gets name of the signer
Date	getSigningDate()	Gets the claimed signing time
String	getSubFilter()	Gets the SubFilter value
String	getType()	Gets type of the dictionary
boolean	isConsistent()	Checks if the signature dictionary is consistent.
protected void	setByteRange(ByteRange byteRange)	Sets the /ByteRange value
protected void	setCMS(CMS cms)	Sets the CMS value read from /Contents
protected void	setContactInfo(String contactInfo)	Sets the contact info
protected void	setContents(byte[] contents)	Sets the /Contents signature value
protected void	setDictionary(PdfDict dictionary)	Sets the signature field dictionary
protected void	setDocMDP(CertificationPermission docMDP)	Sets the /DocMPD dictionary value
protected void	setFieldMDP(SigFieldPermissions fieldMDP)	Sets the /FieldMDP dictionary value
protected void	setFilter(String filter)	Sets the /Filter value
protected void	setLocation(String location)	Sets the signer location
protected void	setReason(String reason)	Sets the signing reason
protected void	setSignerName(String signerName)	Sets the name of the signer
protected void	setSigningDate(Date signingDate)	Sets the date of signing
protected void	setSubFilter(String subFilter)	Sets the /SubFilter value
protected void	setType(String type)	Sets the type of the dictionary

Methods inherited from class java.lang.Object

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

Constructor Details

PdfSigDictWrapper

protected PdfSigDictWrapper()

Default constructor

PdfSigDictWrapper

@Deprecated
public PdfSigDictWrapper(PdfDict dictionary)

Deprecated.

since DSS 6.3. Please use new PdfSigDictWrapperFactory(sigFieldDictionary)#create instead

Default constructor

Parameters:

dictionary - PdfDict

Method Details

setDictionary

protected void setDictionary(PdfDict dictionary)

Sets the signature field dictionary

Parameters:

dictionary - PdfDict

getSignerName

public String getSignerName()

Description copied from interface: PdfSignatureDictionary

Gets name of the signer

Specified by:

getSignerName in interface PdfSignatureDictionary

Returns:

String

setSignerName

protected void setSignerName(String signerName)

Sets the name of the signer

Parameters:

signerName - String

getContactInfo

public String getContactInfo()

Description copied from interface: PdfSignatureDictionary

Gets the signer's contact info

Specified by:

getContactInfo in interface PdfSignatureDictionary

Returns:

String

setContactInfo

protected void setContactInfo(String contactInfo)

Sets the contact info

Parameters:

contactInfo - String

getReason

public String getReason()

Description copied from interface: PdfSignatureDictionary

Gets the signing reason

Specified by:

getReason in interface PdfSignatureDictionary

Returns:

String

setReason

protected void setReason(String reason)

Sets the signing reason

Parameters:

reason - String

getLocation

public String getLocation()

Description copied from interface: PdfSignatureDictionary

Gets the signer's location

Specified by:

getLocation in interface PdfSignatureDictionary

Returns:

String

setLocation

protected void setLocation(String location)

Sets the signer location

Parameters:

location - String

getSigningDate

public Date getSigningDate()

Description copied from interface: PdfSignatureDictionary

Gets the claimed signing time

Specified by:

getSigningDate in interface PdfSignatureDictionary

Returns:

Date

setSigningDate

protected void setSigningDate(Date signingDate)

Sets the date of signing

Parameters:

signingDate - Date

getType

public String getType()

Description copied from interface: PdfSignatureDictionary

Gets type of the dictionary

Specified by:

getType in interface PdfSignatureDictionary

Returns:

String

setType

protected void setType(String type)

Sets the type of the dictionary

Parameters:

type - String

getFilter

public String getFilter()

Description copied from interface: PdfSignatureDictionary

Gets the Filter value

Specified by:

getFilter in interface PdfSignatureDictionary

Returns:

String

setFilter

protected void setFilter(String filter)

Sets the /Filter value

Parameters:

filter - String

getSubFilter

public String getSubFilter()

Description copied from interface: PdfSignatureDictionary

Gets the SubFilter value

Specified by:

getSubFilter in interface PdfSignatureDictionary

Returns:

String

setSubFilter

protected void setSubFilter(String subFilter)

Sets the /SubFilter value

Parameters:

subFilter - String

getContents

public byte[] getContents()

Description copied from interface: PdfSignatureDictionary

Gets /Contents binaries (CMSSignedData)

Specified by:

getContents in interface PdfSignatureDictionary

Returns:

/Contents binaries

setContents

protected void setContents(byte[] contents)

Sets the /Contents signature value

Parameters:

contents - byte array

getByteRange

public ByteRange getByteRange()

Description copied from interface: PdfSignatureDictionary

Gets the signed/timestamped ByteRange

Specified by:

getByteRange in interface PdfSignatureDictionary

Returns:

ByteRange

setByteRange

protected void setByteRange(ByteRange byteRange)

Sets the /ByteRange value

Parameters:

byteRange - ByteRange

getDocMDP

public CertificationPermission getDocMDP()

Description copied from interface: PdfSignatureDictionary

Returns a /DocMDP dictionary, when present

Specified by:

getDocMDP in interface PdfSignatureDictionary

Returns:

CertificationPermission

setDocMDP

protected void setDocMDP(CertificationPermission docMDP)

Sets the /DocMPD dictionary value

Parameters:

docMDP - CertificationPermission

getFieldMDP

public SigFieldPermissions getFieldMDP()

Description copied from interface: PdfSignatureDictionary

Returns a /FieldMDP dictionary, when present

Specified by:

getFieldMDP in interface PdfSignatureDictionary

Returns:

SigFieldPermissions

setFieldMDP

protected void setFieldMDP(SigFieldPermissions fieldMDP)

Sets the /FieldMDP dictionary value

Parameters:

fieldMDP - SigFieldPermissions

getCMS

public CMS getCMS()

Description copied from interface: PdfSignatureDictionary

Gets the CMS from /Contents

Specified by:

getCMS in interface PdfSignatureDictionary

Returns:

CMS

setCMS

protected void setCMS(CMS cms)

Sets the CMS value read from /Contents

Parameters:

cms - CMS

checkConsistency

public boolean checkConsistency(PdfSignatureDictionary signatureDictionary)

Description copied from interface: PdfSignatureDictionary

Verifies the equality of the current PdfSignatureDictionary with provided signatureDictionary. NOTE: this method is similar to equals(PdfSignatureDictionary) method, but also modifies the state of the object accessible from isConsistent() method. If none signature dictionary found in the signed revision, NULL may be provided.

Specified by:

checkConsistency in interface PdfSignatureDictionary

Parameters:

signatureDictionary - PdfSignatureDictionary to compare with

Returns:

TRUE if the PdfSignatureDictionary is equal to the provided signatureDictionary, FALSE otherwise

isConsistent

public boolean isConsistent()

Description copied from interface: PdfSignatureDictionary

Checks if the signature dictionary is consistent. NOTE: method checkConsistency(PdfSignatureDictionary) shall be executed before!

Specified by:

isConsistent in interface PdfSignatureDictionary

Returns:

TRUE if the PdfSignatureDictionary is consistent, FALSE otherwise