Package com.pdftools.sign

Class SignatureConfiguration

java.lang.Object

com.pdftools.internal.NativeBase

com.pdftools.internal.NativeObject

com.pdftools.sign.SignatureConfiguration

Direct Known Subclasses:

SignatureConfiguration, SignatureConfiguration, SignatureConfiguration, SignatureConfiguration

public class SignatureConfiguration
extends NativeObject

Configuration for signature creation

This configuration controls the signature creation in Signer.sign(com.pdftools.pdf.Document, com.pdftools.sign.SignatureConfiguration, com.pdftools.sys.Stream) and Signer.certify(com.pdftools.pdf.Document, com.pdftools.sign.SignatureConfiguration, com.pdftools.sys.Stream).

Use a pdftools.crypto.providers.Provider to create a signature configuration.

Note that this object can be re-used to sign multiple documents for mass-signing applications.

Method Summary

Modifier and Type	Method	Description
Appearance	getAppearance()	The visual appearance of the signature (Getter)
java.lang.String	getContactInfo()	The contact information of the signer (Getter)
java.lang.String	getFieldName()	The name of the existing signature field (Getter)
java.lang.String	getLocation()	The location of signing (Getter)
java.lang.String	getName()	The name of the signing certificate (Getter)
java.lang.String	getReason()	The reason for signing (Getter)
void	setAppearance(Appearance value)	The visual appearance of the signature (Setter)
void	setContactInfo(java.lang.String value)	The contact information of the signer (Setter)
void	setFieldName(java.lang.String value)	The name of the existing signature field (Setter)
void	setLocation(java.lang.String value)	The location of signing (Setter)
void	setReason(java.lang.String value)	The reason for signing (Setter)

Methods inherited from class com.pdftools.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFieldName

public java.lang.String getFieldName()

The name of the existing signature field (Getter)

The pdftools.pdf.SignatureField.getFieldName of an existing, unsigned signature field to sign. Note that when an existing signature field is signed, the appearance's position is defined by the existing field. Therefore, make sure the getAppearance() fits into the pdftools.pdf.SignatureField.getBoundingBox.

If null a new signature field is created using a unique field name.

Default: null

Throws:

java.lang.IllegalStateException - If the creating provider has already been closed

setFieldName

public void setFieldName(java.lang.String value)

The name of the existing signature field (Setter)

The pdftools.pdf.SignatureField.getFieldName of an existing, unsigned signature field to sign. Note that when an existing signature field is signed, the appearance's position is defined by the existing field. Therefore, make sure the getAppearance() fits into the pdftools.pdf.SignatureField.getBoundingBox.

If null a new signature field is created using a unique field name.

Default: null

Throws:

java.lang.IllegalStateException - If the creating provider has already been closed

getAppearance

public Appearance getAppearance()

The visual appearance of the signature (Getter)

The visual appearance or null to create a signature without a visual appearance.

Default: null

Throws:

java.lang.IllegalStateException - If the creating provider has already been closed

setAppearance

public void setAppearance(Appearance value)

The visual appearance of the signature (Setter)

The visual appearance or null to create a signature without a visual appearance.

Default: null

Throws:

java.lang.IllegalStateException - If the creating provider has already been closed

getName

public java.lang.String getName()

The name of the signing certificate (Getter)

Throws:

java.lang.IllegalStateException - If the creating provider has already been closed

getLocation

public java.lang.String getLocation()

The location of signing (Getter)

The CPU host name or physical location of the signing.

Throws:

java.lang.IllegalStateException - If the creating provider has already been closed

setLocation

public void setLocation(java.lang.String value)

The location of signing (Setter)

The CPU host name or physical location of the signing.

Throws:

java.lang.IllegalStateException - If the creating provider has already been closed

getReason

public java.lang.String getReason()

The reason for signing (Getter)

Throws:

java.lang.IllegalStateException - If the creating provider has already been closed

setReason

public void setReason(java.lang.String value)

The reason for signing (Setter)

Throws:

java.lang.IllegalStateException - If the creating provider has already been closed

getContactInfo

public java.lang.String getContactInfo()

The contact information of the signer (Getter)

Information provided by the signer to enable a recipient to contact the signer to verify the signature. For example, a phone number.

Throws:

java.lang.IllegalStateException - If the creating provider has already been closed

setContactInfo

public void setContactInfo(java.lang.String value)

The contact information of the signer (Setter)

Information provided by the signer to enable a recipient to contact the signer to verify the signature. For example, a phone number.

Throws:

java.lang.IllegalStateException - If the creating provider has already been closed