| Package | com.adobe.livecycle.assembler.client |
| Class | public class AssemblerServiceClient |
| Inheritance | AssemblerServiceClient  Object |
AssemblerServiceClient object, you can assemble and disassemble PDF documents. For information, see Assembling PDF Documents in Programming with LiveCycle ES.| Method | Defined By | ||
|---|---|---|---|
AssemblerServiceClient(ServiceClientFactory serviceClientFactory) A constructor used to create an AssemblerService object. | AssemblerServiceClient | ||
String getVersion() Retrieves the implementation version of the Assembler service. | AssemblerServiceClient | ||
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. | AssemblerServiceClient | ||
Executes the supplied DDX document on a given input document (inDoc), returning a single result document. | AssemblerServiceClient | ||
| AssemblerServiceClient | () |
public AssemblerServiceClient(ServiceClientFactory serviceClientFactory)A constructor used to create an AssemblerService object.
serviceClientFactory — The service client factory needed to create an instance of an AssemblerService object. |
| getVersion | () |
public String getVersion()Retrieves the implementation version of the Assembler service.
ReturnsA java.lang.String describing the implementation version of the Assembler service, including the build number. |
| invokeDDX | () |
public AssemblerResult invokeDDX(Document ddx, 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. 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 Programmatically Assembling PDF Documents quick start in Programming with LiveCycle ES.
Parameters
ddx — The DDX document, specified as a com.adobe.idp.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:
| |
environment — An com.adobe.livecycle.assembler.client.AssemblerOptionSpec containing log and failure mode key value pairs. |
| An com.adobe.livecycle.assembler.client.AssemblerResult containing the result documents. |
OperationException — Any throwable exception that occurs is converted to an |
| invokeOneDocument | () |
public Document invokeOneDocument(Document ddx, Document inDoc, AssemblerOptionSpec environment)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 may not 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 Encrypted PDF Documents quick start in the Programming with LiveCycle ES.
This method was added in LiveCycle ES 8.2.
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. |
OperationException — Any throwable exception that occurs is converted to an com.adobe.livecycle.assembler.client.OperationException or a subclass. |
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/javadoc/com/adobe/livecycle/assembler/client/AssemblerServiceClient.html