com.adobe.livecycle.centralmigrationbridge.client
Class CentralMigrationBridgeServiceClient

java.lang.Object
  extended by com.adobe.livecycle.centralmigrationbridge.client.CentralMigrationBridgeServiceClient

public class CentralMigrationBridgeServiceClient
extends java.lang.Object

The CentralMigrationBridgeServiceClient class lets you create a CentralMigrationBridgeServiceClient object that invokes operations supported by the CentralMigrationBridge service. This service lets your organization perform the following operations:

For information about programmatically interacting with the CentralMigrationBridge service, see Working with Central in Programming with Adobe Experience Manager forms.


Constructor Summary
CentralMigrationBridgeServiceClient(ServiceClientFactory serviceClientFactory)
          A constructor that creates a CentralMigrationBridgeServiceClient object.
 
Method Summary
 Document centralDataAccess(Document inData, int maxBytesToProcess)
           
 CentralResult centralMerge(Document inTemplateDoc, Document inDataDoc, Document inPreambleDoc, java.lang.String inDestination, java.lang.String inIniFilePath, java.lang.String inAllOtherOptions)
          Merges data in various formats with electronic templates for printing.
 CentralResult centralTransformation(Document inDataDoc, Document inDataModelDoc, java.lang.String inIniFilePath, java.lang.String inAllOtherOptions)
           
 CentralResult centralXMLImport(Document inDataDoc, java.lang.String inXCIFilePath, java.lang.String inAllOtherOptions)
           
 boolean isSynchronous()
          For internal use only.
 void setSynchronous(boolean synchronous)
          Sets the CentralMigrationBridge service to be invoked synchronously.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CentralMigrationBridgeServiceClient

public CentralMigrationBridgeServiceClient(ServiceClientFactory serviceClientFactory)
A constructor that creates a CentralMigrationBridgeServiceClient object.

Parameters:
serviceClientFactory - A ServiceClientFactory object that contains connection properties. For information about setting connection properties, see Invoking Adobe Experience Manager forms Services using APIs in Programming with Adobe Experience Manager forms.
Method Detail

isSynchronous

public boolean isSynchronous()
For internal use only.


setSynchronous

public void setSynchronous(boolean synchronous)
Sets the CentralMigrationBridge service to be invoked synchronously. A synchronous request is blocked until the service finishes processing the request and returns the result back to the caller.

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

centralMerge

public CentralResult centralMerge(Document inTemplateDoc,
                                  Document inDataDoc,
                                  Document inPreambleDoc,
                                  java.lang.String inDestination,
                                  java.lang.String inIniFilePath,
                                  java.lang.String inAllOtherOptions)
                           throws CentralMigrationBridgeException,
                                  com.adobe.idp.dsc.DSCException
Merges data in various formats with electronic templates for printing.

Parameters:
inTemplateDoc -
inDataDoc -
inPreambleDoc -
inDestination -
inIniFilePath -
inAllOtherOptions -
Returns:
Throws:
CentralMigrationBridgeException
com.adobe.idp.dsc.DSCException

centralTransformation

public CentralResult centralTransformation(Document inDataDoc,
                                           Document inDataModelDoc,
                                           java.lang.String inIniFilePath,
                                           java.lang.String inAllOtherOptions)
                                    throws CentralMigrationBridgeException,
                                           com.adobe.idp.dsc.DSCException
Parameters:
inDataDoc -
inDataModelDoc -
inIniFilePath -
inAllOtherOptions -
Returns:
Throws:
CentralMigrationBridgeException
com.adobe.idp.dsc.DSCException

centralXMLImport

public CentralResult centralXMLImport(Document inDataDoc,
                                      java.lang.String inXCIFilePath,
                                      java.lang.String inAllOtherOptions)
                               throws CentralMigrationBridgeException,
                                      com.adobe.idp.dsc.DSCException
Parameters:
inDataDoc -
inXCIFilePath -
inAllOtherOptions -
Returns:
Throws:
CentralMigrationBridgeException
com.adobe.idp.dsc.DSCException

centralDataAccess

public Document centralDataAccess(Document inData,
                                  int maxBytesToProcess)
                           throws CentralMigrationBridgeException,
                                  com.adobe.idp.dsc.DSCException
Parameters:
inData -
maxBytesToProcess -
Returns:
Throws:
CentralMigrationBridgeException
com.adobe.idp.dsc.DSCException