com.adobe.pdfservices.operation.pdfops

Class CombineFilesOperation

java.lang.Object

com.adobe.pdfservices.operation.pdfops.CombineFilesOperation

All Implemented Interfaces:

Operation

public class CombineFilesOperation
extends Object
implements Operation

Combines multiple PDF files into a single PDF file. Allows specifying which pages of the source files to combine.

Sample Usage:

   CombineFilesOperation combineFilesOperation = CombineFilesOperation.createNew();
   combineFilesOperation.addInput(FileRef.createFromLocalFile("~/Documents/combinePdfInput1.pdf",
                                                              CombineFilesOperation.SupportedSourceFormat.PDF.getMediaType()));
   combineFilesOperation.addInput(FileRef.createFromLocalFile("~/Documents/combinePdfInput2.pdf",
                                                              CombineFilesOperation.SupportedSourceFormat.PDF.getMediaType()));
   Credentials credentials = Credentials.serviceAccountCredentialsBuilder().fromFile("pdfservices-api-credentials.json").build();
   FileRef result = combineFilesOperation.execute(ExecutionContext.create(credentials));
   result.saveAs("output/CombineFilesOutput.pdf");
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
void	addInput(FileRef sourceFileRef) Specifies a PDF file (media type "application/pdf") to be combined with other files.
void	addInput(FileRef sourceFileRef, PageRanges pageRanges) Specifies particular pages of a PDF file (media type "application/pdf") to be combined with other files.
static CombineFilesOperation	createNew() Constructs a CombineFilesOperation instance.
FileRef	execute(ExecutionContext context) Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting file.

Methods inherited from class java.lang.Object

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

Method Detail

createNew

public static CombineFilesOperation createNew()

Constructs a CombineFilesOperation instance.

Returns:

a new CombineFilesOperation instance

addInput

public void addInput(FileRef sourceFileRef)

Specifies a PDF file (media type "application/pdf") to be combined with other files. All pages of this file will be added after the pages of any previously specified files.

For adding particular pages of a PDF file, use addInput(FileRef, PageRanges).

Parameters:

sourceFileRef - a PDF file to be combined

addInput

public void addInput(FileRef sourceFileRef,
                     PageRanges pageRanges)

Specifies particular pages of a PDF file (media type "application/pdf") to be combined with other files. The pages will be added after the pages of any previously specified files.

For adding all the pages of the file, consider addInput(FileRef).

Parameters:

sourceFileRef - a PDF file

pageRanges - page ranges of the PDF file to be combined

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

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