com.adobe.platform.operation.pdfops

Class InsertPagesOperation

java.lang.Object

com.adobe.platform.operation.pdfops.InsertPagesOperation

All Implemented Interfaces:

Operation

public class InsertPagesOperation
extends Object
implements Operation

An operation that can be used to insert pages of multiple PDF files into a base PDF file.

For more complex use cases, refer the CombineFilesOperation.

Sample Usage:

   InsertPagesOperation insertPagesOperation = InsertPagesOperation.createNew();
   insertPagesOperation.setBaseInput(FileRef.createFromLocalFile("~/Documents/insertPagesOperationBaseInput.pdf",
                                                             InsertPagesOperation.SupportedSourceFormat.PDF.getMediaType()));
   insertPagesOperation.addPagesToInsertAt(FileRef.createFromLocalFile("~/Documents/insertPagesOperationFileToInsertInput.pdf",
                                                             InsertPagesOperation.SupportedSourceFormat.PDF.getMediaType()), 1);
   Credentials credentials = Credentials.serviceAccountCredentialsBuilder().fromFile("pdftools-api-credentials.json").build();
   FileRef result = insertPagesOperation.execute(ExecutionContext.create(credentials));
   result.saveAs("output/insertPagesOperationOutput.pdf");
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
void	addPagesToInsertAt(FileRef inputFile, int basePage) Adds all the pages of the input PDF file to be inserted at the specified page of the base PDF file.
void	addPagesToInsertAt(FileRef inputFile, PageRanges pageRanges, int basePage) Adds the specified pages of the input PDF file to be inserted at the specified page of the base PDF file
static InsertPagesOperation	createNew() Constructs a InsertPagesOperation 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 InsertPagesOperation createNew()

Constructs a InsertPagesOperation instance.

Returns:

a new InsertPagesOperation instance

setBaseInput

public void setBaseInput(FileRef sourceFileRef)

Sets the base input file.

Parameters:

sourceFileRef - the base input file; can not be null

addPagesToInsertAt

public void addPagesToInsertAt(FileRef inputFile,
                               int basePage)

Adds all the pages of the input PDF file to be inserted at the specified 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 for insertion; can not be null

basePage - page of the base PDF file

addPagesToInsertAt

public void addPagesToInsertAt(FileRef inputFile,
                               PageRanges pageRanges,
                               int basePage)

Adds the specified pages of the input PDF file to be inserted at the specified 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 for insertion; can not be null

pageRanges - page ranges of the input PDF file; can not be null or empty

basePage - page of the 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