Package eu.europa.esig.dss.pades

Class PAdESTimestampParameters

java.lang.Object

eu.europa.esig.dss.model.TimestampParameters

eu.europa.esig.dss.cades.signature.CAdESTimestampParameters

eu.europa.esig.dss.pades.PAdESTimestampParameters

All Implemented Interfaces:

SerializableTimestampParameters, PAdESCommonParameters, Serializable

public class PAdESTimestampParameters
extends CAdESTimestampParameters
implements PAdESCommonParameters

Parameters for a PAdES timestamp creation

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PdfSignatureCache	pdfSignatureCache	The internal signature processing variable
protected Date	timestampDate	Date of the timestamp

Fields inherited from class eu.europa.esig.dss.model.TimestampParameters

digestAlgorithm

Constructor Summary

Constructors

Constructor	Description
PAdESTimestampParameters()	Empty constructor
PAdESTimestampParameters(DigestAlgorithm digestAlgorithm)	Default constructor

Method Summary

Modifier and Type	Method	Description
String	getAppName()	Returns name of an application used to create a signature/timestamp
int	getContentSize()	Returns a length of the reserved /Contents attribute
String	getDeterministicId()	Returns the deterministic identifier to be used to define a documentId on signing/timestamping, when necessary
String	getFilter()	Returns Filter value
SignatureImageParameters	getImageParameters()	Returns SignatureImageParameters for field's visual representation
char[]	getPasswordProtection()	Returns a password used to encrypt a document
PdfSignatureCache	getPdfSignatureCache()	Returns an internal variable, used to cache data in order to accelerate signing process
Date	getSigningDate()	Returns a claimed signing time
String	getSubFilter()	Returns SubFilter value
void	reinit()	This method re-inits signature parameters to clean temporary settings
void	setAppName(String appName)	Sets signing application name
void	setContentSize(int timestampSize)	This setter allows reserving more than the default size for a timestamp Default : 9472 bytes
void	setFilter(String timestampFilter)	Sets the filter
void	setImageParameters(SignatureImageParameters timestampImageParameters)	Sets the SignatureImageParameters for a visual timestamp creation
void	setPasswordProtection(char[] passwordProtection)	Sets password to the document
void	setPasswordProtection(String passwordProtection)	Deprecated. since DSS 5.12.
void	setSubFilter(String timestampSubFilter)	Sets the sub filter

Methods inherited from class eu.europa.esig.dss.model.TimestampParameters

equals, getDigestAlgorithm, hashCode, setDigestAlgorithm, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface eu.europa.esig.dss.pades.PAdESCommonParameters

getDigestAlgorithm

Field Details

pdfSignatureCache

protected PdfSignatureCache pdfSignatureCache

The internal signature processing variable

timestampDate

protected Date timestampDate

Date of the timestamp

Constructor Details

PAdESTimestampParameters

public PAdESTimestampParameters()

Empty constructor

PAdESTimestampParameters

public PAdESTimestampParameters(DigestAlgorithm digestAlgorithm)

Default constructor

Parameters:

digestAlgorithm - DigestAlgorithm

Method Details

getFilter

public String getFilter()

Description copied from interface: PAdESCommonParameters

Returns Filter value

Specified by:

getFilter in interface PAdESCommonParameters

Returns:

String filter

setFilter

public void setFilter(String timestampFilter)

Sets the filter

Parameters:

timestampFilter - String

getSubFilter

public String getSubFilter()

Description copied from interface: PAdESCommonParameters

Returns SubFilter value

Specified by:

getSubFilter in interface PAdESCommonParameters

Returns:

String subFilter

setSubFilter

public void setSubFilter(String timestampSubFilter)

Sets the sub filter

Parameters:

timestampSubFilter - String

getAppName

public String getAppName()

Description copied from interface: PAdESCommonParameters

Returns name of an application used to create a signature/timestamp

Specified by:

getAppName in interface PAdESCommonParameters

Returns:

String

setAppName

public void setAppName(String appName)

Sets signing application name

Parameters:

appName - String

getImageParameters

public SignatureImageParameters getImageParameters()

Description copied from interface: PAdESCommonParameters

Returns SignatureImageParameters for field's visual representation

Specified by:

getImageParameters in interface PAdESCommonParameters

Returns:

SignatureImageParameters

setImageParameters

public void setImageParameters(SignatureImageParameters timestampImageParameters)

Sets the SignatureImageParameters for a visual timestamp creation

Parameters:

timestampImageParameters - SignatureImageParameters

getContentSize

public int getContentSize()

Description copied from interface: PAdESCommonParameters

Returns a length of the reserved /Contents attribute

Specified by:

getContentSize in interface PAdESCommonParameters

Returns:

int content size

setContentSize

public void setContentSize(int timestampSize)

This setter allows reserving more than the default size for a timestamp Default : 9472 bytes

Parameters:

timestampSize - representing the reserved space for /Context element

getSigningDate

public Date getSigningDate()

Description copied from interface: PAdESCommonParameters

Returns a claimed signing time

Specified by:

getSigningDate in interface PAdESCommonParameters

Returns:

Date

setPasswordProtection

@Deprecated
public void setPasswordProtection(String passwordProtection)

Deprecated.

since DSS 5.12. Use #setPasswordBinaries(passwordProtection.toCharArray())

Sets a password string

Parameters:

passwordProtection - String password to set

getPasswordProtection

public char[] getPasswordProtection()

Description copied from interface: PAdESCommonParameters

Returns a password used to encrypt a document

Specified by:

getPasswordProtection in interface PAdESCommonParameters

Returns:

char array representing a password string

setPasswordProtection

public void setPasswordProtection(char[] passwordProtection)

Sets password to the document

Parameters:

passwordProtection - char array representing a password of the document

getDeterministicId

public String getDeterministicId()

Description copied from interface: PAdESCommonParameters

Returns the deterministic identifier to be used to define a documentId on signing/timestamping, when necessary

Specified by:

getDeterministicId in interface PAdESCommonParameters

Returns:

the unique ID for the document

getPdfSignatureCache

public PdfSignatureCache getPdfSignatureCache()

Description copied from interface: PAdESCommonParameters

Returns an internal variable, used to cache data in order to accelerate signing process

Specified by:

getPdfSignatureCache in interface PAdESCommonParameters

Returns:

PdfSignatureCache

reinit

public void reinit()

Description copied from interface: PAdESCommonParameters

This method re-inits signature parameters to clean temporary settings

Specified by:

reinit in interface PAdESCommonParameters