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 creates PDF documents with enhanced readability from existing PDF documents. An optional tagging report can also be generated which contains the information about the tags that the tagged output PDF document contains.
Accessibility tags, used by assistive technology such as screen reader are required to make PDF files compliant. However, the generated PDF is not guaranteed to comply with accessibility standards such as WCAG and PDF/UA as there could be a need to perform further downstream remediation to meet those standards.

Sample usage:

 AutotagPDFOperation autotagPDFOperation = AutotagPDFOperation.createNew();
 autotagPDFOperation.setInput(FileRef.createFromLocalFile("autotagPdfInput.pdf"));
 Credentials credentials = Credentials.servicePrincipalCredentialsBuilder()
                                      .withClientId("PDF_SERVICES_CLIENT_ID")
                                      .withClientSecret("PDF_SERVICES_CLIENT_SECRET")
                                      .build();
 AutotagPDFOutput autotagPDFOutput = autotagPDFOperation.execute(ExecutionContext.create(credentials));
 autotagPDFOutput.getTaggedPDF().saveAs("autotagPdfOutput.pdf");
  

Method Summary

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

Parameters:

autotagPDFOptions - optional parameters

createNew

public static AutotagPDFOperation createNew()

Constructs an AutotagPDFOperation instance.

Returns:

a new AutotagPDFOperation instance

setInput

public void setInput(FileRef sourceFileRef)

Sets an input file.

Parameters:

sourceFileRef - an input file

execute

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

Executes this operation synchronously using the supplied context and returns AutotagPDFOutput instance for the tagged PDF and report file.

The resulting file(s) 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 AutotagPDFOutput.

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.