|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.livecycle.assembler.client.AssemblerServiceClient
public class AssemblerServiceClient
This class is used by clients of the LiveCycle ES2 Assembler service. Using an AssemblerServiceClient
object, you
can assemble and disassemble PDF documents. For information, see the Assembling PDF Documents section in Programming with LiveCycle ES3.
Constructor Summary | |
---|---|
AssemblerServiceClient(ServiceClientFactory serviceClientFactory)
A constructor used to create an AssemblerService object. |
Method Summary | |
---|---|
String |
getVersion()
Retrieves the implementation version of the Assembler service. |
String |
getVersion(boolean debug)
Retrieves the implementation version of the Assembler service. |
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. |
Document |
invokeOneDocument(Document ddx,
Document inDoc,
AssemblerOptionSpec environment)
Executes the supplied DDX document on a given input document (inDoc), returning a single result document. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AssemblerServiceClient(ServiceClientFactory serviceClientFactory)
AssemblerService
object.
serviceClientFactory
- The service client factory needed to create an instance of an
AssemblerService
object.Method Detail |
---|
public String getVersion()
java.lang.String
value that describes the implementation version of the Assembler service,
including the build number.public String getVersion(boolean debug)
debug
- if true the returned version string is a free-form collection of various version, font and
environment settings.
java.lang.String
value that describes the implementation version of the Assembler service,
including the build number.public AssemblerResult invokeDDX(Document ddx, Map inputs, AssemblerOptionSpec environment) throws OperationException
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 LiveCycle ES3.
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:
Document
objectDocument
objects, in the form of a serializable object
implementing the java.util.List
interfaceenvironment
- An AssemblerOptionSpec
object containing log and
failure mode key value pairs.
AssemblerResult
object containing the result documents.
OperationException
- Any throwable exception that occurs is converted to an
OperationException
or a subclass.public Document invokeOneDocument(Document ddx, Document inDoc, AssemblerOptionSpec environment) throws OperationException
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 LiveCycle ES3.
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.
com.adobe.idp.Document
object that contains a single document.
OperationException
- Any throwable exception that occurs is converted to an
OperationException
or a subclass.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |