com.adobe.pdfservices.operation.pdfops

Class PDFElectronicSealOperation

java.lang.Object

com.adobe.pdfservices.operation.pdfops.PDFElectronicSealOperation

All Implemented Interfaces:

Operation

public class PDFElectronicSealOperation
extends Object
implements Operation

An operation that enables the clients to perform electronic seal over PDF documents like agreements, invoices and more.

To know more about PDF Electronic Seal, please see the documentation.

Sample Usage:

 

 SealFieldOptions sealFieldOptions = new SealFieldOptions.Builder("sealField")
                     .setVisible(true)
                     .setSealFieldLocationOptions(new SealFieldLocationOptions(150, 250, 350, 200))
                     .setPageNumber(1)
                     .build();

 SealCredentialOptions sealCredentialOptions = new  CSCCredentialOptions.Builder("PROVIDER_NAME", "CREDENTIAL_ID",
                     "CREDENTIAL_PIN", "ACCESS_TOKEN").setTokenType("Bearer").build();
 SealOptions sealOptions = new SealOptions.Builder(SignatureFormat.PKCS7, sealCredentialOptions,
                     sealFieldOptions).build();

 PDFElectronicSealOptions electronicSealOptions = new PDFElectronicSealOptions(sealOptions);
 PDFElectronicSealOperation electronicSealOperation = PDFElectronicSealOperation.createNew(electronicSealOptions);
 electronicSealOperation.setInputDocument(FileRef.createFromLocalFile("~/Documents/SampleInvoice.pdf"));
 FileRef result = electronicSealOperation.execute(executionContext);
 result.saveAs("output/sealedOutput.pdf");
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PDFElectronicSealOperation.SupportedSourceFormat Supported source file formats for PDFElectronicSealOperation.

Method Summary

Modifier and Type	Method and Description
static PDFElectronicSealOperation	createNew(PDFElectronicSealOptions electronicSealOptions) Constructs a PDFElectronicSealOperation instance.
FileRef	execute(ExecutionContext context) Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting sealed file.
void	setInputDocument(FileRef inputDoc) Sets the input PDF document.
void	setSealImage(FileRef sealImage) Sets the seal image file.

Methods inherited from class java.lang.Object

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

Method Detail

setInputDocument

public void setInputDocument(FileRef inputDoc)

Sets the input PDF document.

Parameters:

inputDoc - an input file; Cannot be null

setSealImage

public void setSealImage(FileRef sealImage)

Sets the seal image file.

Parameters:

sealImage - a seal image file

createNew

public static PDFElectronicSealOperation createNew(PDFElectronicSealOptions electronicSealOptions)

Constructs a PDFElectronicSealOperation instance.

Parameters:

electronicSealOptions - options for applying electronic seal on the input PDF document; Cannot be null

Returns:

a new PDFElectronicSealOperation instance

execute

public FileRef execute(ExecutionContext context)
                throws ServiceApiException,
                       IOException,
                       ServiceUsageException

Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting sealed file.

The resulting file may be stored in the system temporary directory (per java.io.tmpdir System property). See FileRef for how temporary resources are cleaned up.

Specified by:

execute in interface Operation

Parameters:

context - the context in which to execute the operation

Returns:

the resulting sealed document

Throws:

ServiceApiException - if an API call results in an error response

IOException - if there is an error in reading either the input source or the resulting PDF file

ServiceUsageException - if service usage limits have been reached or credentials quota has been exhausted