com.adobe.pdfservices.operation.pdfops

Class ExtractPDFOperation

java.lang.Object

com.adobe.pdfservices.operation.pdfops.ExtractPDFOperation

All Implemented Interfaces:

Operation

public class ExtractPDFOperation
extends Object
implements Operation

An Operation that extracts pdf elements such as text, images, tables in a structured format from a PDF. Sample Usage:

  ExtractPDFOperation extractPDFOperation = ExtractPDFOperation.createNew();
  extractPDFOperation.setInputFile(FileRef.createFromLocalFile("src/test/resources/extractPdfInput.pdf"));
  ExtractPDFOptions extractPDFOptions = ExtractPDFOptions.extractPdfOptionsBuilder().addElementsToExtract(Arrays.asList(ExtractElementType.TEXT)).build();
  extractPDFOperation.setOptions(extractPDFOptions);
  Credentials credentials = Credentials.serviceAccountCredentialsBuilder().fromFile("pdfservices-api-credentials.json").build();
  FileRef result = extractPDFOperation.execute(ExecutionContext.create(credentials));
  result.saveAs("output/extractPdf.zip");
 

Method Summary

Modifier and Type	Method and Description
static ExtractPDFOperation	createNew() Constructs a ExtractPDFOperation instance.
FileRef	execute(ExecutionContext context) Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting Zip file.
ExtractPDFOperation	setInputFile(FileRef sourceFileRef) Sets an input file.
ExtractPDFOperation	setOptions(ExtractPDFOptions extractPDFOptions) Sets the options for this operation.

Methods inherited from class java.lang.Object

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

Method Detail

createNew

public static ExtractPDFOperation createNew()

Constructs a ExtractPDFOperation instance.

Returns:

a new ExtractPDFOperation instance

setOptions

public ExtractPDFOperation setOptions(ExtractPDFOptions extractPDFOptions)

Sets the options for this operation. See ExtractPDFOptions for how to specify the options for the different elements and renditions.

Parameters:

extractPDFOptions - option

Returns:

current ExtractPDFOperation instance

setInputFile

public ExtractPDFOperation setInputFile(FileRef sourceFileRef)

Sets an input file.

Parameters:

sourceFileRef - an input file

Returns:

current ExtractPDFOperation 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 Zip 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 Zip file containing elements information and renditions

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

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