**Inheritance:** java.lang.Object ``` public class PdfDigitalSignatureDetails ``` Contains details for signing a PDF document with a digital signature. **Remarks:** At the moment digitally signing PDF documents is only available on .NET 3.5 or higher. To digitally sign a PDF document when it is created by Aspose.Words, set the [PdfSaveOptions.getDigitalSignatureDetails()](../../com.aspose.words/pdfsaveoptions/\#getDigitalSignatureDetails) / [PdfSaveOptions.setDigitalSignatureDetails(com.aspose.words.PdfDigitalSignatureDetails)](../../com.aspose.words/pdfsaveoptions/\#setDigitalSignatureDetails-com.aspose.words.PdfDigitalSignatureDetails) property to a valid [PdfDigitalSignatureDetails](../../com.aspose.words/pdfdigitalsignaturedetails/) object and then save the document in the PDF format passing the [PdfSaveOptions](../../com.aspose.words/pdfsaveoptions/) as a parameter into the [Document.save(java.lang.String, com.aspose.words.SaveOptions)](../../com.aspose.words/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. **Examples:** Shows how to sign a generated PDF document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Contents of signed PDF."); CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Configure the "DigitalSignatureDetails" object of the "SaveOptions" object to // digitally sign the document as we render it with the "Save" method. Calendar calendar = Calendar.getInstance(); calendar.set(2015, Calendar.JULY, 20); Date signingTime = calendar.getTime(); options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "My Office", signingTime)); options.getDigitalSignatureDetails().setHashAlgorithm(PdfDigitalSignatureHashAlgorithm.RIPE_MD_160); Assert.assertEquals(options.getDigitalSignatureDetails().getReason(), "Test Signing"); Assert.assertEquals(options.getDigitalSignatureDetails().getLocation(), "My Office"); Assert.assertEquals(DocumentHelper.getLocalDate(options.getDigitalSignatureDetails().getSignatureDate()), DocumentHelper.getLocalDate(signingTime)); doc.save(getArtifactsDir() + "PdfSaveOptions.PdfDigitalSignature.pdf", options); ``` ## Constructors | Constructor | Description | | --- | --- | | [PdfDigitalSignatureDetails()](#PdfDigitalSignatureDetails) | Initializes an instance of this class. | | [PdfDigitalSignatureDetails(CertificateHolder certificateHolder, String reason, String location, Date signatureDate)](#PdfDigitalSignatureDetails-com.aspose.words.CertificateHolder-java.lang.String-java.lang.String-java.util.Date) | Initializes an instance of this class. | ## Methods | Method | Description | | --- | --- | | [getCertificateHolder()](#getCertificateHolder) | Returns the certificate holder object that contains the certificate was used to sign the document. | | [getHashAlgorithm()](#getHashAlgorithm) | Gets the hash algorithm. | | [getLocation()](#getLocation) | Gets the location of the signing. | | [getReason()](#getReason) | Gets the reason for the signing. | | [getSignatureDate()](#getSignatureDate) | Gets the date of the signing. | | [getTimestampSettings()](#getTimestampSettings) | Gets the digital signature timestamp settings. | | [setCertificateHolder(CertificateHolder value)](#setCertificateHolder-com.aspose.words.CertificateHolder) | Returns the certificate holder object that contains the certificate was used to sign the document. | | [setHashAlgorithm(int value)](#setHashAlgorithm-int) | Sets the hash algorithm. | | [setLocation(String value)](#setLocation-java.lang.String) | Sets the location of the signing. | | [setReason(String value)](#setReason-java.lang.String) | Sets the reason for the signing. | | [setSignatureDate(Date value)](#setSignatureDate-java.util.Date) | Sets the date of the signing. | | [setTimestampSettings(PdfDigitalSignatureTimestampSettings value)](#setTimestampSettings-com.aspose.words.PdfDigitalSignatureTimestampSettings) | Sets the digital signature timestamp settings. | ### PdfDigitalSignatureDetails() {#PdfDigitalSignatureDetails} ``` public PdfDigitalSignatureDetails() ``` Initializes an instance of this class. **Examples:** Shows how to sign a generated PDF document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Contents of signed PDF."); CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Configure the "DigitalSignatureDetails" object of the "SaveOptions" object to // digitally sign the document as we render it with the "Save" method. Calendar calendar = Calendar.getInstance(); calendar.set(2015, Calendar.JULY, 20); Date signingTime = calendar.getTime(); options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "My Office", signingTime)); options.getDigitalSignatureDetails().setHashAlgorithm(PdfDigitalSignatureHashAlgorithm.RIPE_MD_160); Assert.assertEquals(options.getDigitalSignatureDetails().getReason(), "Test Signing"); Assert.assertEquals(options.getDigitalSignatureDetails().getLocation(), "My Office"); Assert.assertEquals(DocumentHelper.getLocalDate(options.getDigitalSignatureDetails().getSignatureDate()), DocumentHelper.getLocalDate(signingTime)); doc.save(getArtifactsDir() + "PdfSaveOptions.PdfDigitalSignature.pdf", options); ``` ### PdfDigitalSignatureDetails(CertificateHolder certificateHolder, String reason, String location, Date signatureDate) {#PdfDigitalSignatureDetails-com.aspose.words.CertificateHolder-java.lang.String-java.lang.String-java.util.Date} ``` public PdfDigitalSignatureDetails(CertificateHolder certificateHolder, String reason, String location, Date signatureDate) ``` Initializes an instance of this class. **Examples:** Shows how to sign a generated PDF document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Contents of signed PDF."); CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Configure the "DigitalSignatureDetails" object of the "SaveOptions" object to // digitally sign the document as we render it with the "Save" method. Calendar calendar = Calendar.getInstance(); calendar.set(2015, Calendar.JULY, 20); Date signingTime = calendar.getTime(); options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "My Office", signingTime)); options.getDigitalSignatureDetails().setHashAlgorithm(PdfDigitalSignatureHashAlgorithm.RIPE_MD_160); Assert.assertEquals(options.getDigitalSignatureDetails().getReason(), "Test Signing"); Assert.assertEquals(options.getDigitalSignatureDetails().getLocation(), "My Office"); Assert.assertEquals(DocumentHelper.getLocalDate(options.getDigitalSignatureDetails().getSignatureDate()), DocumentHelper.getLocalDate(signingTime)); doc.save(getArtifactsDir() + "PdfSaveOptions.PdfDigitalSignature.pdf", options); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | certificateHolder | [CertificateHolder](../../com.aspose.words/certificateholder/) | A certificate holder which contains the certificate itself. | | reason | java.lang.String | The reason for signing. | | location | java.lang.String | The location of signing. | | signatureDate | java.util.Date | The date and time of signing. | ### getCertificateHolder() {#getCertificateHolder} ``` public CertificateHolder getCertificateHolder() ``` Returns the certificate holder object that contains the certificate was used to sign the document. **Examples:** Shows how to sign a generated PDF document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Contents of signed PDF."); CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Configure the "DigitalSignatureDetails" object of the "SaveOptions" object to // digitally sign the document as we render it with the "Save" method. Calendar calendar = Calendar.getInstance(); calendar.set(2015, Calendar.JULY, 20); Date signingTime = calendar.getTime(); options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "My Office", signingTime)); options.getDigitalSignatureDetails().setHashAlgorithm(PdfDigitalSignatureHashAlgorithm.RIPE_MD_160); Assert.assertEquals(options.getDigitalSignatureDetails().getReason(), "Test Signing"); Assert.assertEquals(options.getDigitalSignatureDetails().getLocation(), "My Office"); Assert.assertEquals(DocumentHelper.getLocalDate(options.getDigitalSignatureDetails().getSignatureDate()), DocumentHelper.getLocalDate(signingTime)); doc.save(getArtifactsDir() + "PdfSaveOptions.PdfDigitalSignature.pdf", options); ``` **Returns:** [CertificateHolder](../../com.aspose.words/certificateholder/) - The certificate holder object that contains the certificate was used to sign the document. ### getHashAlgorithm() {#getHashAlgorithm} ``` public int getHashAlgorithm() ``` Gets the hash algorithm. **Remarks:** The default value is the SHA-256 algorithm. **Examples:** Shows how to sign a generated PDF document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Contents of signed PDF."); CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Configure the "DigitalSignatureDetails" object of the "SaveOptions" object to // digitally sign the document as we render it with the "Save" method. Calendar calendar = Calendar.getInstance(); calendar.set(2015, Calendar.JULY, 20); Date signingTime = calendar.getTime(); options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "My Office", signingTime)); options.getDigitalSignatureDetails().setHashAlgorithm(PdfDigitalSignatureHashAlgorithm.RIPE_MD_160); Assert.assertEquals(options.getDigitalSignatureDetails().getReason(), "Test Signing"); Assert.assertEquals(options.getDigitalSignatureDetails().getLocation(), "My Office"); Assert.assertEquals(DocumentHelper.getLocalDate(options.getDigitalSignatureDetails().getSignatureDate()), DocumentHelper.getLocalDate(signingTime)); doc.save(getArtifactsDir() + "PdfSaveOptions.PdfDigitalSignature.pdf", options); ``` **Returns:** int - The hash algorithm. The returned value is one of [PdfDigitalSignatureHashAlgorithm](../../com.aspose.words/pdfdigitalsignaturehashalgorithm/) constants. ### getLocation() {#getLocation} ``` public String getLocation() ``` Gets the location of the signing. **Remarks:** The default value is null . **Examples:** Shows how to sign a generated PDF document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Contents of signed PDF."); CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Configure the "DigitalSignatureDetails" object of the "SaveOptions" object to // digitally sign the document as we render it with the "Save" method. Calendar calendar = Calendar.getInstance(); calendar.set(2015, Calendar.JULY, 20); Date signingTime = calendar.getTime(); options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "My Office", signingTime)); options.getDigitalSignatureDetails().setHashAlgorithm(PdfDigitalSignatureHashAlgorithm.RIPE_MD_160); Assert.assertEquals(options.getDigitalSignatureDetails().getReason(), "Test Signing"); Assert.assertEquals(options.getDigitalSignatureDetails().getLocation(), "My Office"); Assert.assertEquals(DocumentHelper.getLocalDate(options.getDigitalSignatureDetails().getSignatureDate()), DocumentHelper.getLocalDate(signingTime)); doc.save(getArtifactsDir() + "PdfSaveOptions.PdfDigitalSignature.pdf", options); ``` **Returns:** java.lang.String - The location of the signing. ### getReason() {#getReason} ``` public String getReason() ``` Gets the reason for the signing. **Remarks:** The default value is null . **Examples:** Shows how to sign a generated PDF document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Contents of signed PDF."); CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Configure the "DigitalSignatureDetails" object of the "SaveOptions" object to // digitally sign the document as we render it with the "Save" method. Calendar calendar = Calendar.getInstance(); calendar.set(2015, Calendar.JULY, 20); Date signingTime = calendar.getTime(); options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "My Office", signingTime)); options.getDigitalSignatureDetails().setHashAlgorithm(PdfDigitalSignatureHashAlgorithm.RIPE_MD_160); Assert.assertEquals(options.getDigitalSignatureDetails().getReason(), "Test Signing"); Assert.assertEquals(options.getDigitalSignatureDetails().getLocation(), "My Office"); Assert.assertEquals(DocumentHelper.getLocalDate(options.getDigitalSignatureDetails().getSignatureDate()), DocumentHelper.getLocalDate(signingTime)); doc.save(getArtifactsDir() + "PdfSaveOptions.PdfDigitalSignature.pdf", options); ``` **Returns:** java.lang.String - The reason for the signing. ### getSignatureDate() {#getSignatureDate} ``` public Date getSignatureDate() ``` Gets the date of the signing. **Remarks:** The default value is the current time. This value will appear in the digital signature as an unverified computer time. **Examples:** Shows how to sign a generated PDF document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Contents of signed PDF."); CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Configure the "DigitalSignatureDetails" object of the "SaveOptions" object to // digitally sign the document as we render it with the "Save" method. Calendar calendar = Calendar.getInstance(); calendar.set(2015, Calendar.JULY, 20); Date signingTime = calendar.getTime(); options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "My Office", signingTime)); options.getDigitalSignatureDetails().setHashAlgorithm(PdfDigitalSignatureHashAlgorithm.RIPE_MD_160); Assert.assertEquals(options.getDigitalSignatureDetails().getReason(), "Test Signing"); Assert.assertEquals(options.getDigitalSignatureDetails().getLocation(), "My Office"); Assert.assertEquals(DocumentHelper.getLocalDate(options.getDigitalSignatureDetails().getSignatureDate()), DocumentHelper.getLocalDate(signingTime)); doc.save(getArtifactsDir() + "PdfSaveOptions.PdfDigitalSignature.pdf", options); ``` **Returns:** java.util.Date - The date of the signing. ### getTimestampSettings() {#getTimestampSettings} ``` public PdfDigitalSignatureTimestampSettings getTimestampSettings() ``` Gets the digital signature timestamp settings. **Remarks:** The default value is null and the digital signature will not be time-stamped. When this property is set to a valid [PdfDigitalSignatureTimestampSettings](../../com.aspose.words/pdfdigitalsignaturetimestampsettings/) object, then the digital signature in the PDF document will be time-stamped. **Examples:** Shows how to sign a saved PDF document digitally and timestamp it. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Signed PDF contents."); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Create a digital signature and assign it to our SaveOptions object to sign the document when we save it to PDF. CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw"); options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "Aspose Office", new Date())); // Create a timestamp authority-verified timestamp. options.getDigitalSignatureDetails().setTimestampSettings(new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword")); // The default lifespan of the timestamp is 100 seconds. Assert.assertEquals(options.getDigitalSignatureDetails().getTimestampSettings().getTimeout(), 100000); // We can set our own timeout period via the constructor. options.getDigitalSignatureDetails().setTimestampSettings(new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword", (long) 1800.0)); Assert.assertEquals(options.getDigitalSignatureDetails().getTimestampSettings().getTimeout(), 1800); Assert.assertEquals(options.getDigitalSignatureDetails().getTimestampSettings().getServerUrl(), "https://freetsa.org/tsr"); Assert.assertEquals(options.getDigitalSignatureDetails().getTimestampSettings().getUserName(), "JohnDoe"); Assert.assertEquals(options.getDigitalSignatureDetails().getTimestampSettings().getPassword(), "MyPassword"); // The "Save" method will apply our signature to the output document at this time. doc.save(getArtifactsDir() + "PdfSaveOptions.PdfDigitalSignatureTimestamp.pdf", options); ``` **Returns:** [PdfDigitalSignatureTimestampSettings](../../com.aspose.words/pdfdigitalsignaturetimestampsettings/) - The digital signature timestamp settings. ### setCertificateHolder(CertificateHolder value) {#setCertificateHolder-com.aspose.words.CertificateHolder} ``` public void setCertificateHolder(CertificateHolder value) ``` Returns the certificate holder object that contains the certificate was used to sign the document. **Examples:** Shows how to sign a generated PDF document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Contents of signed PDF."); CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Configure the "DigitalSignatureDetails" object of the "SaveOptions" object to // digitally sign the document as we render it with the "Save" method. Calendar calendar = Calendar.getInstance(); calendar.set(2015, Calendar.JULY, 20); Date signingTime = calendar.getTime(); options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "My Office", signingTime)); options.getDigitalSignatureDetails().setHashAlgorithm(PdfDigitalSignatureHashAlgorithm.RIPE_MD_160); Assert.assertEquals(options.getDigitalSignatureDetails().getReason(), "Test Signing"); Assert.assertEquals(options.getDigitalSignatureDetails().getLocation(), "My Office"); Assert.assertEquals(DocumentHelper.getLocalDate(options.getDigitalSignatureDetails().getSignatureDate()), DocumentHelper.getLocalDate(signingTime)); doc.save(getArtifactsDir() + "PdfSaveOptions.PdfDigitalSignature.pdf", options); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | [CertificateHolder](../../com.aspose.words/certificateholder/) | The certificate holder object that contains the certificate was used to sign the document. | ### setHashAlgorithm(int value) {#setHashAlgorithm-int} ``` public void setHashAlgorithm(int value) ``` Sets the hash algorithm. **Remarks:** The default value is the SHA-256 algorithm. **Examples:** Shows how to sign a generated PDF document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Contents of signed PDF."); CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Configure the "DigitalSignatureDetails" object of the "SaveOptions" object to // digitally sign the document as we render it with the "Save" method. Calendar calendar = Calendar.getInstance(); calendar.set(2015, Calendar.JULY, 20); Date signingTime = calendar.getTime(); options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "My Office", signingTime)); options.getDigitalSignatureDetails().setHashAlgorithm(PdfDigitalSignatureHashAlgorithm.RIPE_MD_160); Assert.assertEquals(options.getDigitalSignatureDetails().getReason(), "Test Signing"); Assert.assertEquals(options.getDigitalSignatureDetails().getLocation(), "My Office"); Assert.assertEquals(DocumentHelper.getLocalDate(options.getDigitalSignatureDetails().getSignatureDate()), DocumentHelper.getLocalDate(signingTime)); doc.save(getArtifactsDir() + "PdfSaveOptions.PdfDigitalSignature.pdf", options); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | The hash algorithm. The value must be one of [PdfDigitalSignatureHashAlgorithm](../../com.aspose.words/pdfdigitalsignaturehashalgorithm/) constants. | ### setLocation(String value) {#setLocation-java.lang.String} ``` public void setLocation(String value) ``` Sets the location of the signing. **Remarks:** The default value is null . **Examples:** Shows how to sign a generated PDF document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Contents of signed PDF."); CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Configure the "DigitalSignatureDetails" object of the "SaveOptions" object to // digitally sign the document as we render it with the "Save" method. Calendar calendar = Calendar.getInstance(); calendar.set(2015, Calendar.JULY, 20); Date signingTime = calendar.getTime(); options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "My Office", signingTime)); options.getDigitalSignatureDetails().setHashAlgorithm(PdfDigitalSignatureHashAlgorithm.RIPE_MD_160); Assert.assertEquals(options.getDigitalSignatureDetails().getReason(), "Test Signing"); Assert.assertEquals(options.getDigitalSignatureDetails().getLocation(), "My Office"); Assert.assertEquals(DocumentHelper.getLocalDate(options.getDigitalSignatureDetails().getSignatureDate()), DocumentHelper.getLocalDate(signingTime)); doc.save(getArtifactsDir() + "PdfSaveOptions.PdfDigitalSignature.pdf", options); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.lang.String | The location of the signing. | ### setReason(String value) {#setReason-java.lang.String} ``` public void setReason(String value) ``` Sets the reason for the signing. **Remarks:** The default value is null . **Examples:** Shows how to sign a generated PDF document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Contents of signed PDF."); CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Configure the "DigitalSignatureDetails" object of the "SaveOptions" object to // digitally sign the document as we render it with the "Save" method. Calendar calendar = Calendar.getInstance(); calendar.set(2015, Calendar.JULY, 20); Date signingTime = calendar.getTime(); options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "My Office", signingTime)); options.getDigitalSignatureDetails().setHashAlgorithm(PdfDigitalSignatureHashAlgorithm.RIPE_MD_160); Assert.assertEquals(options.getDigitalSignatureDetails().getReason(), "Test Signing"); Assert.assertEquals(options.getDigitalSignatureDetails().getLocation(), "My Office"); Assert.assertEquals(DocumentHelper.getLocalDate(options.getDigitalSignatureDetails().getSignatureDate()), DocumentHelper.getLocalDate(signingTime)); doc.save(getArtifactsDir() + "PdfSaveOptions.PdfDigitalSignature.pdf", options); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.lang.String | The reason for the signing. | ### setSignatureDate(Date value) {#setSignatureDate-java.util.Date} ``` public void setSignatureDate(Date value) ``` Sets the date of the signing. **Remarks:** The default value is the current time. This value will appear in the digital signature as an unverified computer time. **Examples:** Shows how to sign a generated PDF document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Contents of signed PDF."); CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Configure the "DigitalSignatureDetails" object of the "SaveOptions" object to // digitally sign the document as we render it with the "Save" method. Calendar calendar = Calendar.getInstance(); calendar.set(2015, Calendar.JULY, 20); Date signingTime = calendar.getTime(); options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "My Office", signingTime)); options.getDigitalSignatureDetails().setHashAlgorithm(PdfDigitalSignatureHashAlgorithm.RIPE_MD_160); Assert.assertEquals(options.getDigitalSignatureDetails().getReason(), "Test Signing"); Assert.assertEquals(options.getDigitalSignatureDetails().getLocation(), "My Office"); Assert.assertEquals(DocumentHelper.getLocalDate(options.getDigitalSignatureDetails().getSignatureDate()), DocumentHelper.getLocalDate(signingTime)); doc.save(getArtifactsDir() + "PdfSaveOptions.PdfDigitalSignature.pdf", options); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.util.Date | The date of the signing. | ### setTimestampSettings(PdfDigitalSignatureTimestampSettings value) {#setTimestampSettings-com.aspose.words.PdfDigitalSignatureTimestampSettings} ``` public void setTimestampSettings(PdfDigitalSignatureTimestampSettings value) ``` Sets the digital signature timestamp settings. **Remarks:** The default value is null and the digital signature will not be time-stamped. When this property is set to a valid [PdfDigitalSignatureTimestampSettings](../../com.aspose.words/pdfdigitalsignaturetimestampsettings/) object, then the digital signature in the PDF document will be time-stamped. **Examples:** Shows how to sign a saved PDF document digitally and timestamp it. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Signed PDF contents."); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Create a digital signature and assign it to our SaveOptions object to sign the document when we save it to PDF. CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw"); options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "Aspose Office", new Date())); // Create a timestamp authority-verified timestamp. options.getDigitalSignatureDetails().setTimestampSettings(new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword")); // The default lifespan of the timestamp is 100 seconds. Assert.assertEquals(options.getDigitalSignatureDetails().getTimestampSettings().getTimeout(), 100000); // We can set our own timeout period via the constructor. options.getDigitalSignatureDetails().setTimestampSettings(new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword", (long) 1800.0)); Assert.assertEquals(options.getDigitalSignatureDetails().getTimestampSettings().getTimeout(), 1800); Assert.assertEquals(options.getDigitalSignatureDetails().getTimestampSettings().getServerUrl(), "https://freetsa.org/tsr"); Assert.assertEquals(options.getDigitalSignatureDetails().getTimestampSettings().getUserName(), "JohnDoe"); Assert.assertEquals(options.getDigitalSignatureDetails().getTimestampSettings().getPassword(), "MyPassword"); // The "Save" method will apply our signature to the output document at this time. doc.save(getArtifactsDir() + "PdfSaveOptions.PdfDigitalSignatureTimestamp.pdf", options); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | [PdfDigitalSignatureTimestampSettings](../../com.aspose.words/pdfdigitalsignaturetimestampsettings/) | The digital signature timestamp settings. |