com.adobe.livecycle.assembler.client
Class AssemblerServiceClient

java.lang.Object
  com.adobe.livecycle.assembler.client.AssemblerServiceClient

public class AssemblerServiceClient
extends java.lang.Object

This class is used by clients of the Adobe Experience Manager forms Assembler service. Using an AssemblerServiceClient object, you can assemble and disassemble PDF documents. For information, see the Assembling PDF Documents section in Programming with Adobe Experience Manager forms.

Constructor Summary

AssemblerServiceClient(ServiceClientFactory serviceClientFactory)
A constructor used to create an AssemblerService object.

Method Summary

java.lang.String	getVersion() Retrieves the implementation version of the Assembler service.
java.lang.String	getVersionDebug(java.lang.String options) Retrieves the implementation version of the Assembler service.
AssemblerResult	invokeDDX(Document ddx, java.util.Map inputs, AssemblerOptionSpec environment) Executes instructions specified in the given DDX document contained in a com.adobe.idp.Document object using the given input documents located in a java.util.HashMap object.
Document	invokeOneDocument(Document ddx, Document inDoc, AssemblerOptionSpec environment) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

AssemblerServiceClient

public AssemblerServiceClient(ServiceClientFactory serviceClientFactory)

A constructor used to create an AssemblerService object.

Parameters:

serviceClientFactory - The service client factory needed to create an instance of an AssemblerService object.

Method Detail

getVersion

public java.lang.String getVersion()

Retrieves the implementation version of the Assembler service.

Returns:

A java.lang.String describing the implementation version of the Assembler service, including the build number.

getVersionDebug

public java.lang.String getVersionDebug(java.lang.String options)

Retrieves the implementation version of the Assembler service.

Parameters:

options - The debug options desired. This string is reserved for future compatibility and is currently ignored.

Returns:

A java.lang.String value that describes the implementation version of the Assembler service, including the build number.

invokeDDX

public AssemblerResult invokeDDX(Document ddx,
                                 java.util.Map inputs,
                                 AssemblerOptionSpec environment)
                          throws OperationException

Executes instructions specified in the given DDX document contained in a com.adobe.idp.Document object using the given input documents located in a java.util.HashMap object. All input and output com.adobe.idp.Document objects are owned by the caller and should be disposed of properly.

To see this method used in a code example, see the Assembling a PDF document using the Java API quick start in Programming with Adobe Experience Manager forms.

Parameters:

ddx - The DDX document, specified as a Document object.

inputs - A java.util.Map of input documents. The keys are logical names are specified in the DDX document. A name may reference:

• One Document object
• A list of Document objects, in the form of a serializable object implementing the java.util.List interface

environment - An AssemblerOptionSpec object containing log and failure mode key value pairs.

Returns:

An AssemblerResult object containing the result documents.

Throws:

OperationException - Any throwable exception that occurs is converted to an OperationException or a subclass.

invokeOneDocument

public Document invokeOneDocument(Document ddx,
                                  Document inDoc,
                                  AssemblerOptionSpec environment)
                           throws OperationException

Deprecated.

Executes the supplied DDX document on a given input document (inDoc), returning a single result document. The input and output com.adobe.idp.Document objects are owned by the caller and should be disposed of properly. Because only a single com.adobe.idp.Document object is returned, this operation cannot be used to dissassemble PDF documents, nor extract multiple package files or file attachments.

To see this method used in a code example, see the Assembling an encrypted PDF document using the Java API quick start in Programming with Adobe Experience Manager forms.

Parameters:

ddx - The DDX document as a com.adobe.idp.Document object.

inDoc - The input IDP Document - the DDX must specify <PDF source="inDoc"/>

environment - A map of log and failure mode key value pairs. see EnvironmentConstants for key names and descriptions. No log is returned if the log entry is absent.

Returns:

A com.adobe.idp.Document object that contains a single document.

Throws:

OperationException - Any throwable exception that occurs is converted to an OperationException or a subclass.