Quick Start: Retrieving PDF document properties using the Java API

The following code example determines whether the document is a PDF document and, if so, the earliest Acrobat version able to read it.

/*

 * This Java Quick Start uses the following JAR files

 * 1. adobe-pdfutility-client.jar

 * 2. adobe-livecycle-client.jar

 * 3. adobe-usermanager-client.jar

 * 4. adobe-utilities.jar

 * 5. jbossall-client.jar (use a different JAR file if LiveCycle ES is not deployed

 * on JBoss)

 * 

 *  These JAR files are located in the following path:

 * <install directory>/Adobe/LiveCycle8/LiveCycle_ES_SDK/client-libs

 * 

 * For complete details about the location of these JAR files, 

 * see "Including LiveCycle ES library files" in Programming with

 * LiveCycle ES

 */

import com.adobe.livecycle.pdfutility.client.*;

import java.util.*;

import java.io.*;

import com.adobe.idp.Document;

import com.adobe.idp.dsc.clientsdk.ServiceClientFactory;

import com.adobe.idp.dsc.clientsdk.ServiceClientFactoryProperties;

public class RetrievePDFProperties

{

	public static void main(String[] args)

	{

		try

		{

			//Set connection properties required to invoke LiveCycle ES								

			Properties connectionProps = new Properties();

			connectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_EJB_ENDPOINT, "jnp://localhost:1099");

			connectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_EJB_PROTOCOL);          

			connectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "JBoss");

			connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator");

			connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password");

			// Create a ServiceClientFactory object

			ServiceClientFactory myFactory = ServiceClientFactory.createInstance(connectionProps);

			// Create a PDF Utility client

			PDFUtilityServiceClient pdfUt = new PDFUtilityServiceClient(myFactory);

			// Specify a document whose properties are retrieved

			FileInputStream fileInputStream = new FileInputStream("C:\\Adobe\\Loan.pdf");

			Document inDoc = new Document(fileInputStream);

			// Create a properties options specification

			PDFPropertiesOptionSpec optionsSpec = new PDFPropertiesOptionSpec();

			// Set the properties to be evaluated in the options specification.

			// In this example, the options specification will be used to determine

			// if the document is a PDF document, and if so, 

			// which Acrobat version is required to read it.

			optionsSpec.setIsPDFDocument(true);

			optionsSpec.setQueryRequiredAcrobatVersion(true);

			// Perform the query and retrieve the document properties

			PDFPropertiesResult propertiesResult = pdfUt.getPDFProperties(inDoc, optionsSpec);

			// Inspect the result and determine whether the file is a PDF document

			if (propertiesResult.getIsPDFDocument().booleanValue())

			{

				System.out.println("Loan.pdf has been verified to be a PDF document.");

				// Determine the required Acrobat version for reading the document

				String acrobatVersion = propertiesResult.getRequiredAcrobatVersion();

				System.out.println("The required Acrobat version is: " + acrobatVersion);

			}

		}

		catch (Exception e)

		{

			System.out.println("Error occurred: " + e.getMessage());

		}

	}

}

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/help/000121.html

Add Comment