com.adobe.platform.operation.pdfops

Class CreatePDFOperation

java.lang.Object

com.adobe.platform.operation.pdfops.CreatePDFOperation

All Implemented Interfaces:

Operation

public class CreatePDFOperation
extends Object
implements Operation

An operation that converts a non-PDF file to a PDF file. Some source formats may have associated conversion parameters which can be set in the setOptions(CreatePDFOptions) method.

The supported source media types are listed here. The CreatePDFOperation.SupportedSourceFormat enum can be used to map file extensions to their corresponding media types when creating FileRef instances for the source files.

• application/msword
• application/vnd.ms-excel
• application/vnd.ms-powerpoint
• application/vnd.openxmlformats-officedocument.presentationml.presentation
• application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
• application/vnd.openxmlformats-officedocument.wordprocessingml.document
• application/zip (see "Special handling for HTML inputs" below)
• image/bmp
• image/gif
• image/jpeg
• image/png
• image/tiff
• text/plain
• text/rtf

Sample Usage:

   CreatePDFOperation createPdfOperation = CreatePDFOperation.createNew();
   createPdfOperation.setInput(FileRef.createFromLocalFile("~/Documents/createPdfInput.docx",
                                                           CreatePDFOperation.SupportedSourceFormat.DOCX.getMediaType()));
   Credentials credentials = Credentials.serviceAccountCredentialsBuilder().fromFile("pdftools-api-credentials.json").build();
   FileRef result = createPdfOperation.execute(ExecutionContext.create(credentials));
   result.saveAs("output/CreatePDFOutput.pdf");
 

Special handling for HTML inputs:

An HTML input can only be provided as a local zip archive. When creating the corresponding FileRef instance, the media type must be "application/zip" for the local zip archive. Zip archive must have the following structure:

• The main HTML file must be named "index.html".
• "index.html" must exist at the top level of zip archive, not in a folder.

Sample layout:

 html_files.zip
 |__index.html
 |__referenced_file_1.css
 |__referenced_file_2.jpeg
 |__subfolder_1
 |_____referenced_file_3.jpeg
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CreatePDFOperation	createNew() Constructs a CreatePDFOperation 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.
void	setOptions(CreatePDFOptions createPdfOptions) Sets the conversion parameters for this operation.

Methods inherited from class java.lang.Object

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

Method Detail

createNew

public static CreatePDFOperation createNew()

Constructs a CreatePDFOperation instance.

Returns:

a new CreatePDFOperation instance

setInput

public void setInput(FileRef sourceFileRef)

Sets an input file.

Parameters:

sourceFileRef - an input file

setOptions

public void setOptions(CreatePDFOptions createPdfOptions)

Sets the conversion parameters for this operation. See CreatePDFOptions for how to specify the conversion parameters for the different source media types.

Parameters:

createPdfOptions - conversion parameters; use null for default values

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.