com.adobe.platform.operation.pdfops

Class LinearizePDFOperation

java.lang.Object

com.adobe.platform.operation.pdfops.LinearizePDFOperation

All Implemented Interfaces:

Operation

public class LinearizePDFOperation
extends Object
implements Operation

An operation that converts a PDF file into a linearized (also known as "web optimized") PDF file. Such PDF files are optimized for incremental access in network environments.

Sample Usage:

   LinearizePDFOperation linearizePDFOperation = LinearizePDFOperation.createNew();
   linearizePDFOperation.setInput(FileRef.createFromLocalFile("~/Documents/linearizeOperationInput.pdf",
                                                               LinearizePDFOperation.SupportedSourceFormat.PDF.getMediaType()));
   Credentials credentials = Credentials.serviceAccountCredentialsBuilder().fromFile("pdftools-api-credentials.json").build();
   FileRef result = linearizePDFOperation.execute(ExecutionContext.create(credentials));
   result.saveAs("output/linearizeOperationOutput.pdf");
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static LinearizePDFOperation	createNew() Constructs a LinearizePDFOperation 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	setInput(FileRef sourceFileRef) Sets an 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 LinearizePDFOperation createNew()

Constructs a LinearizePDFOperation instance.

Returns:

a new LinearizePDFOperation instance

setInput

public void setInput(FileRef sourceFileRef)

Sets an input file.

Parameters:

sourceFileRef - an input 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