com.pdf_tools.fourheights.pdftoolbox.pdf.forms

Class SignatureField

java.lang.Object

com.pdf_tools.fourheights.pdftoolbox.internal.NativeBase

com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

com.pdf_tools.fourheights.pdftoolbox.pdf.forms.SignatureField

public class SignatureField
extends NativeObject

A digital signature field

The existence of signature fields does not necessarily mean that the document is signed. This depends on the property getIsSigned().

All properties are taken from information in the PDF, not from the actual digital signature. For some properties, those values are redundant and the value from the actual digital signature should take precedence.

The existence of a signed signature field does not imply, that the signature is valid, the signature is actually not validated at all.

Method Summary

Modifier and Type	Method and Description
static SignatureField	createDynamicObject(long handle)
java.lang.String	getContactInfo() The contact information of the signer (Getter)
java.time.OffsetDateTime	getDate() The date and time of signing (Getter)
boolean	getIsSigned() Whether the field is signed (Getter)
boolean	getIsVisible() The visibility of the signature field (Getter)
java.lang.String	getLocation() The location of signing (Getter)
java.lang.String	getName() The name of the person or authority signing the document.
java.lang.String	getReason() The reason for the signing (Getter)

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

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

Method Detail

createDynamicObject

public static SignatureField createDynamicObject(long handle)

getIsSigned

public boolean getIsSigned()

Whether the field is signed (Getter)

• If true the signature field contains an actual digital signature.
• If false the signature field is a placeholder that is yet to be signed. All properties except getIsVisible() can be ignored.

Note: The digital signature itself is not validated.

Throws:

java.lang.IllegalStateException - if the object has already been closed

getIsVisible

public boolean getIsVisible()

The visibility of the signature field (Getter)

If true, the signature field has a visual appearance on the page.

Throws:

java.lang.IllegalStateException - if the object has already been closed

getName

public java.lang.String getName()

The name of the person or authority signing the document. (Getter)

This property represents the name as stored in the PDF.

Note: This property should be used with care, as the value can differ from the name as stored in the signer certificate. If that's the case, the name in the signer certificate should be used.

Throws:

java.lang.IllegalStateException - if the object 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 object has already been closed

getReason

public java.lang.String getReason()

The reason for the signing (Getter)

Throws:

java.lang.IllegalStateException - if the object 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 object has already been closed

getDate

public java.time.OffsetDateTime getDate()
                                 throws CorruptException

The date and time of signing (Getter)

Depending on the signature handler, this may be a normal unverified computer time or a time generated in a verifiable way from a secure time server.

Note: This property should be used with care, as the value can differ from the date as stored in the cryptographic signature itself. If that's the case, the name in the signer certificate should be used.

Throws:

java.lang.IllegalStateException - if the object has already been closed

CorruptException - The date is corrupt.