com.adobe.pdfservices.operation.pdfops

Class AutotagPDFOperation

java.lang.Object

com.adobe.pdfservices.operation.pdfops.AutotagPDFOperation

All Implemented Interfaces:

Operation

public class AutotagPDFOperation
extends Object
implements Operation

An operation that enables clients to improve accessibility of the PDF document. It generates the tagged PDF, along with an optional XLSX report providing detailed information about the added tags. The operation replaces any existing tags within the input document, so it provides the most benefit for PDFs that have no tags or low-quality tags.

Sample usage:

 AutotagPDFOperation autotagPDFOperation = AutotagPDFOperation.createNew();
             autotagPDFOperation.setInput(FileRef.createFromLocalFile("autotagPdfInput.pdf"));
             Credentials credentials = Credentials.serviceAccountCredentialsBuilder().fromFile("pdfservices-api-credentials.json").build();
             AutotagOutputFiles autotagOutputFiles = autotagPDFOperation.execute(ExecutionContext.create(credentials));
             autotagOutputFiles.saveTaggedPDF("autotagPdfOutput.pdf");
  

Method Summary

Modifier and Type	Method and Description
static AutotagPDFOperation	createNew() Constructs a AutotagPDFOperation instance.
AutotagOutputFiles	execute(ExecutionContext context) Executes this operation synchronously using the supplied context and returns AutotagOutputFiles instance for the tagged PDF and report file.
void	setInput(FileRef sourceFileRef) Sets an input file.
void	setOptions(AutotagPDFOptions autotagPDFOptions) 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(AutotagPDFOptions autotagPDFOptions)

Sets the options for this operation. See AutotagPDFOptions for how to specify the options.

Parameters:

autotagPDFOptions - autotag PDF options; use null for default values

createNew

public static AutotagPDFOperation createNew()

Constructs a AutotagPDFOperation instance.

Returns:

a new AutotagPDFOperation instance

setInput

public void setInput(FileRef sourceFileRef)

Sets an input file.

Parameters:

sourceFileRef - an input file

execute

public AutotagOutputFiles execute(ExecutionContext context)
                           throws ServiceApiException,
                                  IOException,
                                  ServiceUsageException

Executes this operation synchronously using the supplied context and returns AutotagOutputFiles instance for the tagged PDF and report 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 instance of AutotagOutputFiles.

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

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