com.adobe.platform.operation.pdfops

Class ReplacePagesOperation

java.lang.Object

com.adobe.platform.operation.pdfops.ReplacePagesOperation

All Implemented Interfaces:

Operation

public class ReplacePagesOperation
extends Object
implements Operation

An operation that allows specific pages in a PDF file to be replaced with pages from multiple PDF files.

For more complex use cases, refer the CombineFilesOperation.

Sample Usage:

   ReplacePagesOperation replacePagesOperation = ReplacePagesOperation.createNew();
   replacePagesOperation.setBaseInput(FileRef.createFromLocalFile("~/Documents/replacePagesOperationBaseInput.pdf",
                                                             ReplacePagesOperation.SupportedSourceFormat.PDF.getMediaType()));
   replacePagesOperation.addPagesForReplace(FileRef.createFromLocalFile("~/Documents/replacePagesOperationFileToBeReplacedWithInput.pdf",
                                                             ReplacePagesOperation.SupportedSourceFormat.PDF.getMediaType()), 1);
   Credentials credentials = Credentials.serviceAccountCredentialsBuilder().fromFile("pdftools-api-credentials.json").build();
   FileRef result = replacePagesOperation.execute(ExecutionContext.create(credentials));
   result.saveAs("output/replacePagesOperationOutput.pdf");
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
void	addPagesForReplace(FileRef inputFile, int basePageToReplace) Adds all the pages of the input PDF file for replacing the page of the base PDF file.
void	addPagesForReplace(FileRef inputFile, PageRanges pageRanges, int basePageToReplace) Adds the specified pages of the input PDF file for replacing the page of the base PDF file.
static ReplacePagesOperation	createNew() Constructs a ReplacePagesOperation instance.
FileRef	execute(ExecutionContext context) Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
void	setBaseInput(FileRef sourceFileRef) Sets the base input file.

Methods inherited from class java.lang.Object

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

Method Detail

createNew

public static ReplacePagesOperation createNew()

Constructs a ReplacePagesOperation instance.

Returns:

a new ReplacePagesOperation instance

setBaseInput

public void setBaseInput(FileRef sourceFileRef)

Sets the base input file.

Parameters:

sourceFileRef - the base input file; can not be null

addPagesForReplace

public void addPagesForReplace(FileRef inputFile,
                               int basePageToReplace)

Adds all the pages of the input PDF file for replacing the page of the base PDF file.

This method can be invoked multiple times with the same or different input PDF files.

Parameters:

inputFile - a PDF file to be replaced with; can not be null

basePageToReplace - page of base PDF file

addPagesForReplace

public void addPagesForReplace(FileRef inputFile,
                               PageRanges pageRanges,
                               int basePageToReplace)

Adds the specified pages of the input PDF file for replacing the page of the base PDF file.

This method can be invoked multiple times with the same or different input PDF files.

Parameters:

inputFile - a PDF file to be replaced with; can not be null

pageRanges - page ranges of the input PDF file

basePageToReplace - page of base PDF file

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 PDF 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 PDF file

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