Working with PDF Utilities

About the PDF Utilities Service

The PDF Utilities service can convert between PDF and XDP file formats, set and retrieve PDF document properties, and manipulate XMP metadata. For example, before converting a PDF document to another format, it is useful to inspect its properties to determine which service operation to invoke for the conversion.

Summary of steps

To convert a PDF document into an XDP document, perform the following steps:

Include project files.

Create a PDFUtilityService client.

Invoke the PDF to XDP conversion operation.

Include project files

Include necessary files into your development project. If you are creating a client application using Java, include the necessary JAR files. If you are using web services, ensure that you include the proxy files.

Create a PDFUtilityService client

Before you can programmatically perform a PDF Utilities operation, you must create a PDFUtilityService client. With the Java API, this is accomplished by creating a
PDFUtilityServiceClient
object. With the web service API, this is accomplished by using a
PDFUtilityServiceService
object.

Invoke the PDF to XDP conversion operation

After you create the service client, you can invoke the PDF to XDP conversion operation.

Convert PDF documents into XDP documents using the Java API

Convert PDF documents into XDP documents by using the PDF Utilities API(Java):

Include project files

Include client JAR files, such as the adobe-pdfutility-client.jar, in your Java project’s class path..

Create a PDFUtilityService client

Create a
PDFUtilityServiceClient
object by using its constructor and passing a
ServiceClientFactory
object that contains connection properties.

Invoke the PDF to XDP conversion operation

To perform the conversion, invoke the
PDFUtilityServiceClient
object’s
convertPDFtoXDP
method and pass in a
com.adobe.idp.Document
object that represents the PDF file. The method returns a
com.adobe.idp.Document
object that represents the newly created XDP file.

Summary of steps

To convert an XDP document into a PDF document, perform the following steps:

Include project files.

Create a PDFUtilityService client.

Invoke the XDP to PDF conversion operation.

Include project files

Include necessary files into your development project. If you are creating a client application using Java, include the necessary JAR files. If you are using web services, ensure that you include the proxy files.

Create a PDFUtilityService client

Before you can programmatically perform a PDF Utilities operation, you must create a PDFUtilityService client. With the Java API, this is accomplished by creating a
PDFUtilityServiceClient
object. With the web service API, this is accomplished by using a
PDFUtilityServiceService
object.

Invoke the XDP to PDF conversion operation

After you create the service client, you can invoke the XDP to PDF conversion operation.

Convert XDP documents into PDF documents using the Java API

Convert XDP documents into PDF documents by using the PDF Utilities API (Java):

Include project files

Include client JAR files, such as adobe-pdfutility-client.jar, in your Java project’s class path.

Create a PDFUtilityService client

Create a
PDFUtilityServiceClient
object by using its constructor and passing a
ServiceClientFactory
object that contains connection properties.

Invoke the XDP to PDF conversion operation

To perform the conversion, invoke the
PDFUtilityServiceClient
object’s
convertXDPtoPDF
method and pass in a
com.adobe.idp.Document
object that represents the XDP file. The method returns a
com.adobe.idp.Document
object that represents the newly created PDF file.

Create a
PDFUtilityServiceService
object by using your proxy class constructor.

Invoke the XDP to PDF conversion operation

To perform the conversion, invoke the
PDFUtilityServiceService
object’s
convertXDPtoPDF
method and pass in a
BLOB
object that represents the XDP file. The method returns a
BLOB
object that represents the newly created PDF file.

Retrieving PDF Document Properties

You can use the PDF Utilities Java and web service APIs to programmatically retrieve PDF document properties, such as whether the document is a fillable form or the minimum Acrobat version required to read the document.

Summary of steps

To retrieve PDF document properties, perform the following steps:

Include project files.

Create a PDFUtilityService client.

Invoke the properties retrieval operation.

Include project files

Include necessary files into your development project. If you are creating a client application using Java, include the necessary JAR files. If you are using web services, ensure that you include the proxy files.

Create a PDFUtilityService client

Before you can programmatically perform a PDF Utilities operation, you must create a PDFUtilityService client. With the Java API, this is accomplished by creating a
PDFUtilityServiceClient
object. With the web service API, this is accomplished using a
PDFUtilityServiceService
object.

Invoke the properties retrieval operation

After you create the service client, you can invoke the properties retrieval operation.

Setting PDF Document Save Modes

You can use the PDF Utilities service Java and web service APIs to programmatically set a save mode for a PDF document. When using the PDF Utilities service to set a save mode, the PDF Utilities service only sets the save mode and does not actually save the PDF document. The PDF document is saved when it is passed to another service operation. For example, you can use the PDF Utilities service to set a specific save mode and pass it to the Encryption service, where the PDF document is actually saved and encrypted.

Summary of steps

To set the save option for PDF documents, perform the following steps:

Include project files.

Create a PDFUtilityService client.

Set the save mode.

Invoke the save operation.

Pass the PDF document to another operation.

Include project files

Include necessary files into your development project. If you are creating a client application using Java, include the necessary JAR files. If you are using web services, ensure that you include the proxy files.

Create a PDFUtilityService client

Before you can programmatically perform a PDF Utilities operation, you must create a PDFUtilityService client. With the Java API, this is accomplished by creating a
PDFUtilityServiceClient
object. With the web service API, this is accomplished using a
PDFUtilityServiceService
object.

Set the Save mode

You can choose one of the following save options:

INCREMENTAL
: To save incrementally to reduce the time required to save

FAST_WEB_VIEW
: save for fast web viewing

FULL
: To save using a full save (without optimizations)

Invoke the save style operation

After you create the service client, you can invoke the properties retrieval operation.

Pass the PDF document to another AEM Forms operation

Once the PDF Utilities service sets the specified Save mode, pass the PDF document to another AEM Forms operation. Once returned from that operation, the PDF document is saved in the specified mode. For example, if you use the PDF Utilities service to set the
FAST_WEB_VIEW
mode and then pass the PDF document to the Encryption service’s
encryptUsingPassword
operation, the returned PDF document is encrypted with a password and save in the
FAST_WEB_VIEW
mode.

The Quick Start that is associated with this section sets the
FAST_WEB_VIEW
mode and then passes the PDF document to the Encryption service’s
encryptUsingPassword
operation.

Set PDF document save options using the Java API

Set the PDF document save options by using the PDF Utilities API (Java):

Include project files

Include client JAR files, such as adobe-pdfutility-client.jar, in your Java project’s class path.

Create a PDFUtilityService client

Create a
PDFUtilityServiceClient
object by using its constructor and passing a
ServiceClientFactory
object that contains connection properties.

Set the Save mode

Create a
PDFUtilitySaveMode
object by using its constructor.

Set the save mode by invoking the
PDFUtilitySaveMode
object’s
setSaveStyle
method and passing a string value that specifies the save mode. For example, to save for fast web viewing, pass
FAST_WEB_VIEW
.

Invoke the save style operation

Invoke the
PDFUtilityServiceClient
object’s
setSaveMode
method and pass the following values:

A
com.adobe.idp.Document
object that represents the PDF document.

A
PDFUtilitySaveMode
object that contains the save style to be used.

A Boolean value used to determine whether to override any previous settings.

The method returns a
com.adobe.idp.Document
object formatted using the specified save style.

Pass the PDF document to another AEM Forms operation

Pass the returned
com.adobe.idp.Document
object to another AEM Forms operation.

Sanitize PDF documents using the Java API

Include client JAR files, such as the adobe-pdfutility-client.jar, in your Java project’s class path.

Create a PDFUtilityService client

Create a
PDFUtilityServiceClient
object by using its constructor and passing a
ServiceClientFactory
object that contains connection properties.

Invoke the PDF to XDP conversion operation

To perform the conversion, invoke the
PDFUtilityServiceClient
object’s
convertPDFtoXDP
method and pass in a
com.adobe.idp.Document
object that represents the PDF file. The method returns a
com.adobe.idp.Document
object that represents the newly created XDP file.