Nutrient Java SDK/io.nutrient.sdk.signing/DigitalSignatureOptions

DigitalSignatureOptions

public final class DigitalSignatureOptions

Options for creating a digital signature on a PDF document. A digital signature requires a certificate (PFX/P12 file) to cryptographically sign the document. Additional metadata such as signer name, reason, and location can optionally be included. For PAdES-T compliance, configure a to include a trusted timestamp.

Constructors

DigitalSignatureOptions

public void DigitalSignatureOptions()

Functions

getCertificatePassword

public final String getCertificatePassword()

The password to decrypt the PFX/P12 certificate file.

getCertificatePath

public final String getCertificatePath()

The file path to the PFX/P12 certificate file.

getCertificateSerialNumber

public final String getCertificateSerialNumber()

The serial number of the certificate to use from the operating-system certificate store or a smartcard.

getCertification

public final SignatureCertificationLevel getCertification()

The certification (DocMDP) level of the signature.

public final String getContactInfo()

Contact information for the signer.

public final SignatureFormat getFormat()

The container format of the signature.

getHashAlgorithm

public final SignatureHashAlgorithm getHashAlgorithm()

The hash algorithm to use for the signature.

public final SignatureKeySource getKeySource()

Where the signing key and certificate come from.

public final SignatureLevel getLevel()

The PAdES baseline level to produce.

public final String getLocation()

The location where the document was signed.

public final Pkcs11Options getPkcs11()

The PKCS#11 module and key location.

public final String getReason()

The reason for signing the document.

public final String getSignerName()

The name of the person or entity signing the document.

getSmartCardPin

public final String getSmartCardPin()

The PIN used to unlock a smartcard key.

public final TimestampConfiguration getTimestamp()

Optional timestamp configuration for PAdES-T compliance.

setCertificatePassword

public final void setCertificatePassword(String value)

The password to decrypt the PFX/P12 certificate file.

setCertificatePath

public final void setCertificatePath(String value)

The file path to the PFX/P12 certificate file.

setCertificateSerialNumber

public final void setCertificateSerialNumber(String value)

The serial number of the certificate to use from the operating-system certificate store or a smartcard.

setCertificateStream

public final void setCertificateStream(FileInputStream value)

A stream containing the PFX/P12 certificate data.

setCertification

public final void setCertification(SignatureCertificationLevel value)

The certification (DocMDP) level of the signature.

public final void setContactInfo(String value)

Contact information for the signer.

public final void setFormat(SignatureFormat value)

The container format of the signature.

setHashAlgorithm

public final void setHashAlgorithm(SignatureHashAlgorithm value)

The hash algorithm to use for the signature.

public final void setKeySource(SignatureKeySource value)

Where the signing key and certificate come from.

public final void setLevel(SignatureLevel value)

The PAdES baseline level to produce.

public final void setLocation(String value)

The location where the document was signed.

public final void setPkcs11(Pkcs11Options value)

The PKCS#11 module and key location.

public final void setReason(String value)

The reason for signing the document.

public final void setSignerName(String value)

The name of the person or entity signing the document.

setSmartCardPin

public final void setSmartCardPin(String value)

The PIN used to unlock a smartcard key.

public final void setTimestamp(TimestampConfiguration value)

Optional timestamp configuration for PAdES-T compliance.