com.adobe.pdfservices.operation.pdfops

Class PDFPropertiesOperation

java.lang.Object

com.adobe.pdfservices.operation.pdfops.PDFPropertiesOperation

All Implemented Interfaces:

Operation

public class PDFPropertiesOperation
extends Object
implements Operation

An Operation that is used to fetch properties from an input PDF file. The properties are returned in a JSON file or JSON Object.

Sample Usage:

 PDFPropertiesOperation pdfPropertiesOperation = PDFPropertiesOperation.createNew();

 FileRef source = FileRef.createFromLocalFile("src/test/resources/pdfPropertiesOperationInput.pdf");
 pdfPropertiesOperation.setInputFile(source);

 JSONObject result = pdfPropertiesOperation.execute(executionContext);
 

Method Summary

Modifier and Type	Method and Description
static PDFPropertiesOperation	createNew() Constructs a PDFPropertiesOperation instance.
org.json.JSONObject	execute(ExecutionContext context) Executes this operation synchronously using the supplied context and returns a new JSONObject instance for the resulting JSON object.
FileRef	executeAndReturnFileRef(ExecutionContext context) Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting JSON file.
void	setInputFile(FileRef sourceFileRef) Sets an input file.
void	setOptions(PDFPropertiesOptions pdfPropertiesOptions) Sets the options for this operation.

Methods inherited from class java.lang.Object

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

Method Detail

setOptions

public void setOptions(PDFPropertiesOptions pdfPropertiesOptions)

Sets the options for this operation. See PDFPropertiesOptions for how to specify the options for PDF Properties Operation.

Parameters:

pdfPropertiesOptions - optional parameters; use null for default values

createNew

public static PDFPropertiesOperation createNew()

Constructs a PDFPropertiesOperation instance.

Returns:

a new PDFPropertiesOperation instance

setInputFile

public void setInputFile(FileRef sourceFileRef)

Sets an input file.

Parameters:

sourceFileRef - an input file

executeAndReturnFileRef

public FileRef executeAndReturnFileRef(ExecutionContext context)
                                throws ServiceApiException,
                                       IOException,
                                       ServiceUsageException

Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting JSON 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.

Parameters:

context - the context in which to execute the operation

Returns:

the resulting JSON file containing properties of 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 JSON File Reference.

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

execute

public org.json.JSONObject execute(ExecutionContext context)
                            throws ServiceApiException,
                                   IOException,
                                   ServiceUsageException

Executes this operation synchronously using the supplied context and returns a new JSONObject instance for the resulting JSON object.

Specified by:

execute in interface Operation

Parameters:

context - the context in which to execute the operation

Returns:

the resulting JSON object containing properties of 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 JSON Object

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