com.aspose.words

Class PdfDigitalSignatureDetails

java.lang.Object

com.aspose.words.PdfDigitalSignatureDetails

public class PdfDigitalSignatureDetails
extends java.lang.Object

Contains details for signing a PDF document with a digital signature.

At the moment digitally signing PDF documents is only available on .NET 2.0 or higher.

To digitally sign a PDF document when it is created by Aspose.Words, set the PdfSaveOptions.getDigitalSignatureDetails() / PdfSaveOptions.setDigitalSignatureDetails(com.aspose.words.PdfDigitalSignatureDetails) property to a valid PdfDigitalSignatureDetails object and then save the document in the PDF format passing the PdfSaveOptions as a parameter into the Document.save(java.lang.String, com.aspose.words.SaveOptions) method.

Aspose.Words creates a PKCS#7 signature over the whole PDF document and uses the "Adobe.PPKMS" filter and "adbe.pkcs7.sha1" subfilter when creating a digital signature.

See Also:

PdfSaveOptions.getDigitalSignatureDetails(), PdfSaveOptions.setDigitalSignatureDetails(com.aspose.words.PdfDigitalSignatureDetails)

Constructor Summary

Constructors

Constructor and Description
PdfDigitalSignatureDetails() Initializes an instance of this class.
PdfDigitalSignatureDetails(CertificateHolder certificateHolder, java.lang.String reason, java.lang.String location, java.util.Date signatureDate) Initializes an instance of this class.

Method Summary

Modifier and Type	Method and Description
CertificateHolder	getCertificateHolder() Returns the certificate holder object that contains the certificate was used to sign the document.
int	getHashAlgorithm() Gets the hash algorithm.
java.lang.String	getLocation() Gets the location of the signing.
java.lang.String	getReason() Gets the reason for the signing.
java.util.Date	getSignatureDate() Gets the date of the signing.
PdfDigitalSignatureTimestampSettings	getTimestampSettings() Gets the digital signature timestamp settings.
void	setCertificateHolder(CertificateHolder value) Returns the certificate holder object that contains the certificate was used to sign the document.
void	setHashAlgorithm(int value) Sets the hash algorithm.
void	setLocation(java.lang.String value) Sets the location of the signing.
void	setReason(java.lang.String value) Sets the reason for the signing.
void	setSignatureDate(java.util.Date value) Sets the date of the signing.
void	setTimestampSettings(PdfDigitalSignatureTimestampSettings value) Sets the digital signature timestamp settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfDigitalSignatureDetails

public PdfDigitalSignatureDetails()

Initializes an instance of this class.

PdfDigitalSignatureDetails

public PdfDigitalSignatureDetails(CertificateHolder certificateHolder,
                                  java.lang.String reason,
                                  java.lang.String location,
                                  java.util.Date signatureDate)

Initializes an instance of this class.

Parameters:

certificateHolder - A certificate holder which contains the certificate itself.

reason - The reason for signing.

location - The location of signing.

signatureDate - The date and time of signing.

Method Detail

getCertificateHolder

public CertificateHolder getCertificateHolder()

Returns the certificate holder object that contains the certificate was used to sign the document.

Returns:

The certificate holder object that contains the certificate was used to sign the document.

setCertificateHolder

public void setCertificateHolder(CertificateHolder value)

Returns the certificate holder object that contains the certificate was used to sign the document.

Parameters:

value - The certificate holder object that contains the certificate was used to sign the document.

getReason

public java.lang.String getReason()

Gets the reason for the signing. The default value is null.

Returns:

The reason for the signing.

setReason

public void setReason(java.lang.String value)

Sets the reason for the signing. The default value is null.

Parameters:

value - The reason for the signing.

getLocation

public java.lang.String getLocation()

Gets the location of the signing. The default value is null.

Returns:

The location of the signing.

setLocation

public void setLocation(java.lang.String value)

Sets the location of the signing. The default value is null.

Parameters:

value - The location of the signing.

getSignatureDate

public java.util.Date getSignatureDate()

Gets the date of the signing.

The default value is the current time.

This value will appear in the digital signature as an unverified computer time.

Returns:

The date of the signing.

setSignatureDate

public void setSignatureDate(java.util.Date value)

Sets the date of the signing.

The default value is the current time.

This value will appear in the digital signature as an unverified computer time.

Parameters:

value - The date of the signing.

getHashAlgorithm

public int getHashAlgorithm()

Gets the hash algorithm. The default value is the SHA-256 algorithm.

Returns:

The hash algorithm. The returned value is one of PdfDigitalSignatureHashAlgorithm constants.

setHashAlgorithm

public void setHashAlgorithm(int value)

Sets the hash algorithm. The default value is the SHA-256 algorithm.

Parameters:

value - The hash algorithm. The value must be one of PdfDigitalSignatureHashAlgorithm constants.

getTimestampSettings

public PdfDigitalSignatureTimestampSettings getTimestampSettings()

Gets the digital signature timestamp settings.

The default value is null and the digital signature will not be time-stamped. When this property is set to a valid PdfDigitalSignatureTimestampSettings object, then the digital signature in the PDF document will be time-stamped.

Returns:

The digital signature timestamp settings.

setTimestampSettings

public void setTimestampSettings(PdfDigitalSignatureTimestampSettings value)

Sets the digital signature timestamp settings.

The default value is null and the digital signature will not be time-stamped. When this property is set to a valid PdfDigitalSignatureTimestampSettings object, then the digital signature in the PDF document will be time-stamped.

Parameters:

value - The digital signature timestamp settings.