com.adobe.fd.docassurance.client.api

Interface DocAssuranceService

public interface DocAssuranceService

DocAssurance Service enables you to secure your document. It offers: 1) Digital Signature service - for Signing, Certifying, Verifying a PDF Document. In addition to that signature fields can be added, removed, modified and cleared in a PDF Document. 2) Encryption service - for encrypting a PDF Document with password or digital certificate and removing the same when required. 3) Reader Extension service - which digitally signs a PDF form or document to enable certain features in the free Reader product on a per-file basis. These are features otherwise found in the full Acrobat product.Extending features in a PDF document allows the content creator to offer more advanced capabilities to end users with free Reader without requiring them to purchase the full Acrobat product.

Method Summary

Modifier and Type	Method and Description
Document	addInvisibleSignatureField(Document inDoc, String signatureFieldName, FieldMDPOptionSpec fieldMDPOptionsSpec, PDFSeedValueOptionSpec seedValueOptionsSpec, UnlockOptions unlockOptions) Creates an invisible signature field in the PDF document.
Document	addSignatureField(Document inDoc, String signatureFieldName, Integer pageNo, PositionRectangle positionRectangle, FieldMDPOptionSpec fieldMDPOptionsSpec, PDFSeedValueOptionSpec seedValueOptionsSpec, UnlockOptions unlockOptions) Creates a visible signature field within the PDF document.
Document	clearSignatureField(Document inDoc, String signatureFieldName, UnlockOptions unlockOptions) Clears the specified signature field.
PDFSignatureField	getCertifyingSignatureField(Document inDoc, UnlockOptions unlockOptions) Returns the signature field that was used to certify the document.
GetUsageRightsResult	getCredentialUsageRights(String credentialAlias, org.apache.sling.api.resource.ResourceResolver resourceResolver) Returns the usage rights information of the credential specified by given credentialAlias.
GetUsageRightsResult	getDocumentUsageRights(Document inDocument, UnlockOptions unlockOptions) Returns the usage rights information of the given Document.
EncryptionTypeResult	getPDFEncryption(Document inDoc) Returns the type of security used for a document
PDFSignature	getSignature(Document doc, String signatureFieldName, UnlockOptions unlockOptions) Returns signature data for a given signature field.
List<PDFSignatureField>	getSignatureFieldList(Document inDoc, UnlockOptions unlockOptions) Returns a list of all the signature fields located within a PDF document.
Document	modifySignatureField(Document inDoc, String signatureFieldName, PDFSignatureFieldProperties pdfSignatureFieldProperties, UnlockOptions unlockOptions) Modifies a signature field's signature field lock dictionary and seed value dictionary values.
Document	removePDFCertificateSecurity(Document inDoc, String alias, org.apache.sling.api.resource.ResourceResolver resourceResolver) Returns an unsecured Document given a certificate-encrypted Document.
Document	removePDFPasswordSecurity(Document inDoc, String password) Returns a new Document that has security removed given a password protected document as input.
Document	removeSignatureField(Document inDoc, String signatureFieldName, UnlockOptions unlockOptions) Removes the specified signature field.
Document	removeUsageRights(Document inDocument, UnlockOptions unlockOptions) Removes the usage rights for the given Document.
Document	secureDocument(Document inDoc, EncryptionOptions encryptionOptions, SignatureOptions signatureOptions, ReaderExtensionOptions readerExtensionOptions, UnlockOptions unlockOptions) secureDocument enables you to encrypt, sign/certify, reader extend a PDF Document either individually or in any combination in the given order.
PDFSignatureVerificationInfo	verify(Document inDoc, String signatureFieldName, RevocationCheckStyle revocationCheckStyle, VerificationTime verificationTime, ValidationPreferences dssPrefs, org.apache.sling.api.resource.ResourceResolver resourceResolver) Operation to validate a signed signature field.
PDFDocumentVerificationInfo	verifyDocument(Document doc, RevocationCheckStyle revocationCheckStyle, VerificationTime verificationTime, ValidationPreferences prefStore, org.apache.sling.api.resource.ResourceResolver resourceResolver)

Method Detail

secureDocument

Document secureDocument(Document inDoc,
                        EncryptionOptions encryptionOptions,
                        SignatureOptions signatureOptions,
                        ReaderExtensionOptions readerExtensionOptions,
                        UnlockOptions unlockOptions)
                 throws Exception

secureDocument enables you to encrypt, sign/certify, reader extend a PDF Document either individually or in any combination in the given order. To access any of the above functionality you have to pass the corresponding argument. If null, it would be assumed that the particular processing is not required.

Parameters:

inDoc - Document input PDF Document

encryptionOptions - EncryptionOptions Includes the arguments required for Encrypting a PDF Doc

signatureOptions - SignatureOptions Includes the options required for Signing/Certifying a PDF Doc

readerExtensionOptions - ReaderExtensionOptions Includes the options required for Reader Extending a PDF Doc

unlockOptions - UnlockOptions includes the parameters require to unlock an encrypted file, This is required only if the file is encrypted.

Returns:

A Document object that represents a secure PDF document

Throws:

Exception

addSignatureField

Document addSignatureField(Document inDoc,
                           String signatureFieldName,
                           Integer pageNo,
                           PositionRectangle positionRectangle,
                           FieldMDPOptionSpec fieldMDPOptionsSpec,
                           PDFSeedValueOptionSpec seedValueOptionsSpec,
                           UnlockOptions unlockOptions)
                    throws Exception

Creates a visible signature field within the PDF document. This method is not supported when working with dynamic PDF documents.

Parameters:

inDoc - - Document object containing PDF.

signatureFieldName - The name of the signature field. This is a required parameter and cannot be null.

pageNumber - The page number on which the signature field is added. Valid values are 1 to the number of pages contained within the document. This is a required parameter and cannot be null.

positionRectangle - A PositionRectangle object that specifies the position for the signature field. This is a required parameter and cannot be null. If the specified rectangle does not lie at least partially on the crop box of the specified page, an InvalidArgumentException is thrown. Also, neither the height or width value of the specified rectangle can be 0 or negative. Lower left X or lower left Y coordinates can be 0 or greater but not negative, and are relative to the crop box of the page.

fieldMDPOptionsSpec - A FieldMDPOptionSpec object that specifies the PDF document fields that are locked after the signature field is signed. This is an optional parameter and can be null.

seedValueOptionsSpec - A SeedValueOptions object that specifies the various seed values for the field. This is an optional parameter and can be null.

unlockOptions - UnlockOptions includes the parameters require to unlock an encrypted file, This is required only if the file is encrypted.

Returns:

A Document object that represents a PDF document with a newly added signature field.

Throws:

Exception

addInvisibleSignatureField

Document addInvisibleSignatureField(Document inDoc,
                                    String signatureFieldName,
                                    FieldMDPOptionSpec fieldMDPOptionsSpec,
                                    PDFSeedValueOptionSpec seedValueOptionsSpec,
                                    UnlockOptions unlockOptions)
                             throws Exception

Creates an invisible signature field in the PDF document. This method is not supported when working with dynamic PDF documents.

Parameters:

inDoc - - Document object containing PDF..

signatureFieldName - The name of the signature field. This is a required parameter and cannot be null.

fieldMDPOptionsSpec - A FieldMDPOptionSpec object that specifies the PDF document fields that are locked after the signature field is signed. This is an optional parameter and can be null.

seedValueOptionsSpec - A SeedValueOptions object that specifies the various seed values for the field. This is an optional parameter and can be null.

unlockOptions - UnlockOptions includes the parameters require to unlock an encrypted file, This is required only if the file is encrypted.

Returns:

A Document object that represents a PDF document with a newly added invisible signature field.

Throws:

Exception

clearSignatureField

Document clearSignatureField(Document inDoc,
                             String signatureFieldName,
                             UnlockOptions unlockOptions)
                      throws Exception

Clears the specified signature field. After a signature field is cleared, it can be signed or certified again.

Parameters:

inDoc - - Document object containing PDF.

signatureFieldName - The name of the signature field.

unlockOptions - UnlockOptions includes the parameters require to unlock an encrypted file, This is required only if the file is encrypted.

Returns:

A Document object that represents a PDF document that contains an empty signature field.

Throws:

Exception

getCertifyingSignatureField

PDFSignatureField getCertifyingSignatureField(Document inDoc,
                                              UnlockOptions unlockOptions)
                                       throws Exception

Returns the signature field that was used to certify the document.

Parameters:

inDoc - - Document object containing PDF.

unlockOptions - UnlockOptions includes the parameters require to unlock an encrypted file, This is required only if the file is encrypted.

Returns:

A PDFSignatureField object that holds information about the certified signature.

Throws:

Exception

getSignature

PDFSignature getSignature(Document doc,
                          String signatureFieldName,
                          UnlockOptions unlockOptions)
                   throws Exception

Returns signature data for a given signature field.

Parameters:

inDoc - - Document object containing PDF.

signatureFieldName - The name of the signature field that contains a signature. The fully qualified name of the signature field should be specified. When using a PDF document that is based on an XFA form, then the partial name of the signature field can be used. For example, form1[0].#subform[1].SignatureField3[3] can be specified as SignatureField3[3].

unlockOptions - UnlockOptions includes the parameters require to unlock an encrypted file, This is required only if the file is encrypted.

Returns:

A PDFSignature object which contains a signature and information about the filter and subfilters which is used for validating the signature and also the certificates embedded in the PDF document.

Throws:

Exception

removeSignatureField

Document removeSignatureField(Document inDoc,
                              String signatureFieldName,
                              UnlockOptions unlockOptions)
                       throws Exception

Removes the specified signature field. You cannot remove a signature field if it is signed or certified. First, you must clear the signature.

Parameters:

inDoc - - Document object containing PDF.

signatureFieldName - The name of the signature field to remove. The fully qualified name of the signature field should be specified. When using a PDF document that is based on an XFA form, then the partial name of the signature field can be used. For example, form1[0].#subform[1].SignatureField3[3] can be specified as SignatureField3[3].

unlockOptions - UnlockOptions includes the parameters require to unlock an encrypted file, This is required only if the file is encrypted.

Throws:

Exception

See Also:

clearSignatureField

getSignatureFieldList

List<PDFSignatureField> getSignatureFieldList(Document inDoc,
                                              UnlockOptions unlockOptions)
                                       throws Exception

Returns a list of all the signature fields located within a PDF document.

Parameters:

inDoc - - Document object containing PDF.

unlockOptions - UnlockOptions includes the parameters require to unlock an encrypted file, This is required only if the file is encrypted.

Returns:

A List of PDFSignatureField objects.

Throws:

Exception

modifySignatureField

Document modifySignatureField(Document inDoc,
                              String signatureFieldName,
                              PDFSignatureFieldProperties pdfSignatureFieldProperties,
                              UnlockOptions unlockOptions)
                       throws Exception

Modifies a signature field's signature field lock dictionary and seed value dictionary values. A field lock dictionary specifies a list of fields which are locked once the signature field is signed. Any changes to the locked fields subsequent to the signing of this signature field invalidates the signature. A seed value dictionary contains entries that constrain information that is used at the time the signature is applied. For example, you can specify form fields that are locked when the PDF document is signed. Once a field is locked, its value cannot be modified.

Parameters:

inDoc - - Document object containing PDF.

signatureFieldName - The name of the signature field. This is a required parameter and cannot be null.

pdfSignatureFieldProperties - A PDFSignatureFieldProperties object that specifies information about the PDFSeedValueOptionSpec and FieldMDPOptionSpec values of the signature field.

unlockOptions - UnlockOptions includes the parameters require to unlock an encrypted file, This is required only if the file is encrypted.

Returns:

A Document object that represents a PDF document with the modified signature field.

Throws:

Exception

verify

PDFSignatureVerificationInfo verify(Document inDoc,
                                    String signatureFieldName,
                                    RevocationCheckStyle revocationCheckStyle,
                                    VerificationTime verificationTime,
                                    ValidationPreferences dssPrefs,
                                    org.apache.sling.api.resource.ResourceResolver resourceResolver)
                             throws Exception

Operation to validate a signed signature field.

Parameters:

inDoc - - Document object containing PDF.

signatureFieldName - The name of the signature field to be validated. either fully qualified name or partial name can be given

revocationCheckStyle - The option to govern the revocation checking of the certificates encountered during validation

verificationTime - The time at which the signature should be validated

dssPrefs - Preferences to control various validation configurations For an encrypted document, set unlock options by using setUnlockOptions()

resourceResolver - - resource resolver to the granite trust store

Returns:

PDFSignatureVerificationInfo object containing verification info of the signature field.

Throws:

SignaturesBaseException

DocAssuranceException

Exception

removePDFPasswordSecurity

Document removePDFPasswordSecurity(Document inDoc,
                                   String password)
                            throws Exception

Returns a new Document that has security removed given a password protected document as input.

Parameters:

inDoc - an Document supplied as input. It must be password protected

password - either a document open or permission password to use for removing security from the document

Returns:

Document representing unprotected PDF Document.

Throws:

Exception

getPDFEncryption

EncryptionTypeResult getPDFEncryption(Document inDoc)
                               throws Exception

Returns the type of security used for a document

Parameters:

inDoc - a Document supplied as input. It may or may not be encrypted.

Returns:

EncryptionTypeResult containing an enum for type of encryption if any on the supplied document

Throws:

Exception

removePDFCertificateSecurity

Document removePDFCertificateSecurity(Document inDoc,
                                      String alias,
                                      org.apache.sling.api.resource.ResourceResolver resourceResolver)
                               throws Exception

Returns an unsecured Document given a certificate-encrypted Document. After certificate-based encryption is removed from a PDF document, it is no longer secure.

Parameters:

inDoc - - A Document object that represents the certificate-encrypted PDF document.

alias - - The alias that corresponds to the key in Granite Trust Store that is used to remove certificate-based encryption from the PDF document.

resourceResolver - ResourceResolver to access the key store of the particular user to fetch the Credential

Returns:

Document representing unprotected PDF Document. Throws: Exception - If the PDF document is not encrypted or if the alias value is invalid.

Throws:

Exception

verifyDocument

PDFDocumentVerificationInfo verifyDocument(Document doc,
                                           RevocationCheckStyle revocationCheckStyle,
                                           VerificationTime verificationTime,
                                           ValidationPreferences prefStore,
                                           org.apache.sling.api.resource.ResourceResolver resourceResolver)
                                    throws DocAssuranceException,
                                           Exception

Parameters:

doc - The signed pdf document

revocationCheckStyle - The option to govern the revocation checking of the certificates encountered during validation

verificationTime - The time at which the signature should be validated

dssPrefs - Preferences to control various validation configurations For an encrypted document, set unlock options by using setUnlockOptions()

isFIPSmode - Governs whether processing happens using US Federal FIPS mode

certProvs - Providers providing access to certificate store

crlProvs - Providers providing access to stored crls store

pdfDocVer - Provides mechanism to access previous revisions of a pdf document. If null, default implementation is used.

Returns:

PDFDocumentVerificationInfo that represents the verification info of the input PDF Document.

Throws:

SignaturesBaseException

DocAssuranceException

Exception

removeUsageRights

Document removeUsageRights(Document inDocument,
                           UnlockOptions unlockOptions)
                    throws DocAssuranceException,
                           Exception

Removes the usage rights for the given Document.

Parameters:

inDocument - The document to remove usage rights from.

Returns:

The saved Document with the new usage rights.

Throws:

DocAssuranceException

Exception

getDocumentUsageRights

GetUsageRightsResult getDocumentUsageRights(Document inDocument,
                                            UnlockOptions unlockOptions)
                                     throws DocAssuranceException,
                                            Exception

Returns the usage rights information of the given Document.

Parameters:

inDocument - The document to get usage rights information from.

Returns:

A UsageRightsInfo containing the usage rights of the given Document.

Throws:

DocAssuranceException

Exception

getCredentialUsageRights

GetUsageRightsResult getCredentialUsageRights(String credentialAlias,
                                              org.apache.sling.api.resource.ResourceResolver resourceResolver)
                                       throws ReaderExtensionsException

Returns the usage rights information of the credential specified by given credentialAlias.

Parameters:

credentialAlias - The credentialAlias that specifies the credential.

credentialPassword - The password of the credential if the credential is encrypted, null needs to be used if the credential is not encrypted.

Returns:

A UsageRightsInfo containing the usage rights of the specified credential.

Throws:

ReaderExtensionsException - if there is an exception accessing the specified credential or getting the usage rights information.