com.adobe.livecycle.distiller.client
Class DistillerServiceClient

java.lang.Object
  com.adobe.livecycle.distiller.client.DistillerServiceClient

public class DistillerServiceClient
extends java.lang.Object

This class converts PostScript, Encapsulated PostScript, and PRN files to compact, reliable, and more secure PDF files over a network. The Distiller service converts large volumes of print documents to electronic documents, such as invoices and statements. Converting documents to PDF also allows enterprises to send their customers a paper version and an electronic version of a document. To see an object of this type used in a code example, see the Converting a PostScript file to a PDF document using the Java API quick start in Programming with LiveCycle ES4.

Constructor Summary

DistillerServiceClient(ServiceClientFactory factory)
This is the constructor for creating a Distiller client instance.

Method Summary

CreatePDFResult	createPDF(Document inDoc, java.lang.String inputFileName, java.lang.String pdfSettings, java.lang.String securitySettings, Document inSettingsDoc, Document inXMPDoc) Converts PostScript, Encapsulated PostScript (EPS), and PRN files into PDF documents.
CreatePDFResult	createPDF2(Document inDoc, java.lang.String inputFileExtension, java.lang.String pdfSettings, java.lang.String securitySettings, Document inSettingsDoc, Document inXMPDoc) Converts PostScript, Encapsulated PostScript (EPS), and PRN files into PDF documents.

Methods inherited from class java.lang.Object

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

Constructor Detail

DistillerServiceClient

public DistillerServiceClient(ServiceClientFactory factory)

This is the constructor for creating a Distiller client instance.

Parameters:

factory - A ServiceClientFactory instance with valid credentials of the server where the service is deployed.

Method Detail

createPDF

public CreatePDFResult createPDF(Document inDoc,
                                 java.lang.String inputFileName,
                                 java.lang.String pdfSettings,
                                 java.lang.String securitySettings,
                                 Document inSettingsDoc,
                                 Document inXMPDoc)
                          throws InvalidParameterException,
                                 ConversionException,
                                 FileFormatNotSupportedException

Converts PostScript, Encapsulated PostScript (EPS), and PRN files into PDF documents.

Some of the parameters are optional, which means that null values may be provided if they are not needed. Security permissions, PDF output settings, and metadata information can optionally be applied to the resultant PDF document.

Parameters:

inDoc - This mandatory parameter contains an instance of the Document whose content is to be converted. It must be a valid PostScript or Encapsulated PostScript document. For this object, it is recommended that you either use the appropriate Document constructor if you have access to the file, or that you use the com.adobe.idp.Document.setAttribute() method if you only have access to the stream.

inputFileName - This mandatory parameter contains the file name, with the appropriate extension, of the PostScript or EPS document to be converted.

pdfSettings - This optional parameter contains the PDF output settings to be applied.

The following options are available:

• "High Quality Print"
• "Oversized Pages"
• "PDFA1b 2005 CMYK"
• "PDFA1b 2005 RGB"
• "PDFX1a 2001"
• "PDFX3 2002"
• "Press Quality"
• "Smallest File Size"
• "Standard"

You can also create custom settings via the Administration user interface. In case this parameter is not provided, the service will use the default PDF settings as configured via the Administration console.

securitySettings - This optional parameter is used for applying security settings. The current available option is "No Security". You can also create custom settings via the Administration user interface.

inSettingsDoc - This optional parameter contains the file containing settings to be applied while generating the PDF document (for example, optimization for web view) as well as the settings that are applied once the PDF document is created (for example, initial view and security).

inXMPDoc - This optional parameter contains the file containing metadata information to be applied to the generated PDF document. Only UTF-8 encoded XMP metadata is supported. The metadata should conform to the Adobe Extensible Metadata Platform format. For details of the format and for the specifications, please visit http://www.adobe.com/products/xmp/.

Returns:

The result of the operation. It contains the created PDF document and the log document, if any.

Throws:

InvalidParameterException

ConversionException

FileFormatNotSupportedException

createPDF2

public CreatePDFResult createPDF2(Document inDoc,
                                  java.lang.String inputFileExtension,
                                  java.lang.String pdfSettings,
                                  java.lang.String securitySettings,
                                  Document inSettingsDoc,
                                  Document inXMPDoc)
                           throws InvalidParameterException,
                                  ConversionException,
                                  FileFormatNotSupportedException

Converts PostScript, Encapsulated PostScript (EPS), and PRN files into PDF documents.

Some of the parameters are optional, which means that null values may be provided if they are not needed. Security permissions, PDF output settings, and metadata information can optionally be applied to the resultant PDF document.

Parameters:

inDoc - This mandatory parameter contains an instance of the Document whose content is to be converted. It must be a valid PostScript or Encapsulated PostScript document. For this object, it is recommended that you either use the appropriate Document constructor if you have access to the file, or that you use the com.adobe.idp.Document.setAttribute() method if you only have access to the stream.

inputFileExtension - This mandatory parameter contains the file extension of the PostScript or EPS document to be converted.

pdfSettings - This optional parameter contains the PDF output settings to be applied.

The following options are available:

• "High Quality Print"
• "Oversized Pages"
• "PDFA1b 2005 CMYK"
• "PDFA1b 2005 RGB"
• "PDFX1a 2001"
• "PDFX3 2002"
• "Press Quality"
• "Smallest File Size"
• "Standard"

You can also create custom settings via the Administration user interface. In case this parameter is not provided, the service will use the default PDF settings as configured via the Administration console.

securitySettings - This optional parameter is used for applying security settings. The current available option is "No Security". You can also create custom settings via the Administration user interface.

inSettingsDoc - This optional parameter contains the file containing settings to be applied while generating the PDF document (for example, optimization for web view) as well as the settings that are applied once the PDF document is created (for example, initial view and security).

inXMPDoc - This optional parameter contains the file containing metadata information to be applied to the generated PDF document. Only UTF-8 encoded XMP metadata is supported. The metadata should conform to the Adobe Extensible Metadata Platform format. For details of the format and for the specifications, please visit http://www.adobe.com/products/xmp/.

Returns:

The result of the operation. It contains the created PDF document and the log document, if any.

Throws:

InvalidParameterException

ConversionException

FileFormatNotSupportedException