com.adobe.livecycle.convertpdfservice.client
Class ConvertPdfServiceClient

java.lang.Object
  com.adobe.livecycle.convertpdfservice.client.ConvertPdfServiceClient

public class ConvertPdfServiceClient
extends java.lang.Object

This class enables you to convert PDF documents to PostScript and image files. For information, see the Converting PDF to Postscript and Image Files section in Programming with LiveCycle ES4.

Constructor Summary

ConvertPdfServiceClient(ServiceClientFactory serviceClientFactory)
A constructor for creating a ConvertPdfServiceClient object.

Method Summary

boolean	isSynchronous() For internal use only.
void	setSynchronous(boolean synchronous) Sets the ConvertPDF service to be invoked synchronously.
Document	toImage(Document inPdfDoc, ToImageOptionsSpec toImageOptionsSpec) Deprecated. Please use the toImage2 method instead of this method.
java.util.List	toImage2(Document inPdfDoc, ToImageOptionsSpec toImageOptionsSpec) Converts a PDF document to image files.
Document	toPS(Document inPdfDoc, PSLevel psLevel) Deprecated. Please use the toPS2 method instead of this method.
Document	toPS2(Document inPdfDoc, ToPSOptionsSpec toPSOptionsSpec) Converts a PDF document to a PostScript file.
void	unzipArchive(Document inZipDoc, java.lang.String destDir) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConvertPdfServiceClient

public ConvertPdfServiceClient(ServiceClientFactory serviceClientFactory)

A constructor for creating a ConvertPdfServiceClient object.

Parameters:

serviceClientFactory - A ServiceClientFactory instance with valid LiveCycle credentials * where the service is deployed.

Method Detail

isSynchronous

public boolean isSynchronous()

For internal use only.

setSynchronous

public void setSynchronous(boolean synchronous)

Sets the ConvertPDF service to be invoked synchronously. A synchronous request is blocked until the ConvertPDF service finishes processing the request and returns the result back to the caller.

Parameters:

synchronous - A Boolean value that specifies whether the ConvertPDF service is invoked synchronously.

toPS

@Deprecated
public Document toPS(Document inPdfDoc,
                                PSLevel psLevel)
              throws com.adobe.idp.dsc.DSCException,
                     ConvertPdfException

Deprecated. Please use the toPS2 method instead of this method.

Converts a PDF document to a PostScript file.

Parameters:

inPdfDoc - The Document object representing the PDF document to be converted.

psLevel - The PostScript level (2 or 3) to be produced.

Returns:

A Document object representing the converted PostScript.

Throws:

com.adobe.idp.dsc.DSCException

ConvertPdfException

toPS2

public Document toPS2(Document inPdfDoc,
                      ToPSOptionsSpec toPSOptionsSpec)
               throws com.adobe.idp.dsc.DSCException,
                      ConvertPdfException

Converts a PDF document to a PostScript file. When invoking this method, you cannot change the resolution of the postscript file by calling the toPSOptionsSpec object's setResolution method.

To see this method used in a code example, see the Converting a PDF document to PostScript using the Java API quick start in Programming with LiveCycle ES4.

Parameters:

inPdfDoc - The Document object representing the PDF document to convert.

toPSOptionsSpec - A ToPSOptionsSpec object that contains conversion run-time options.

Returns:

A Document object representing the converted PostScript.

Throws:

com.adobe.idp.dsc.DSCException

ConvertPdfException

toImage

@Deprecated
public Document toImage(Document inPdfDoc,
                                   ToImageOptionsSpec toImageOptionsSpec)
                 throws com.adobe.idp.dsc.DSCException,
                        ConvertPdfException

Deprecated. Please use the toImage2 method instead of this method.

Converts a PDF document to an image file. The resulting image files are zipped and returned as a Document, except in the case of TIFF files, in which case .tiff files are returned. Supported image formats are JPEG, JPEG2K, PNG and TIFF.

Parameters:

inPdfDoc - The Document object representing the PDF document to convert.

toImageOptionsSpec - Contains various preferences used to convert the PDF document to an image file.

Returns:

The Document object for the output image files archived in Zip format.

Throws:

ConvertPdfException

com.adobe.idp.dsc.DSCException

See Also:

ToImageOptionsSpec

toImage2

public java.util.List toImage2(Document inPdfDoc,
                               ToImageOptionsSpec toImageOptionsSpec)
                        throws com.adobe.idp.dsc.DSCException,
                               ConvertPdfException

Converts a PDF document to image files. The resulting image files are returned within a java.util.List object.

To see this method used in a code example, see the Converting a PDF document to JPEG files using the Java API quick start in Programming with LiveCycle ES4.

Parameters:

inPdfDoc - A Document object representing the PDF document to convert.

toImageOptionsSpec - Contains conversion run-time options used to convert a PDF document to image files.

Returns:

A java.util.List object that contains image files.

Throws:

ConvertPdfException

com.adobe.idp.dsc.DSCException

See Also:

ToImageOptionsSpec

unzipArchive

@Deprecated
public void unzipArchive(Document inZipDoc,
                                    java.lang.String destDir)
                  throws com.adobe.idp.dsc.DSCException,
                         ConvertPdfException

Deprecated.

This method unzips the archive to the destination directory.

Parameters:

inZipDoc - The Document object constructed from the Zip file.

destDir - The output directory.

Throws:

ConvertPdfException

com.adobe.idp.dsc.DSCException