Quick Start (SOAP mode): Creating a PDF document based on fragments using the Java API

The following Java code example creates a PDF document that is based on a form design assembled by the Assembler service. The Assembler service assembles fragments located in multiple XDP files into a single form design. Application logic that invokes the Assembler service is located in a user-defined method named GetFormDesign . The non-interactive form is saved as a PDF file named Loan.pdf on the client computer. (See Creating PDF Documents Using Fragments.)

/* 
    * This Java Quick Start uses the SOAP mode and contains the following JAR files 
    * in the class path: 
    * 1. adobe-output-client.jar 
    * 2. adobe-livecycle-client.jar 
    * 3. adobe-usermanager-client.jar 
    * 4. activation.jar (required for SOAP mode) 
    * 5. axis.jar (required for SOAP mode) 
    * 6. axis.jar (required for SOAP mode) 
    * 7. commons-codec-1.3.jar (required for SOAP mode) 
    * 8. commons-collections-3.2.jar  (required for SOAP mode) 
    * 9. commons-discovery.jar (required for SOAP mode) 
    * 10. commons-logging.jar (required for SOAP mode) 
    * 11. dom3-xml-apis-2.5.0.jar (required for SOAP mode) 
    * 12. jaxen-1.1-beta-9.jar (required for SOAP mode) 
    * 13. jaxrpc.jar (required for SOAP mode) 
    * 14. log4j.jar (required for SOAP mode) 
    * 15. mail.jar (required for SOAP mode) 
    * 16. saaj.jar (required for SOAP mode) 
    * 17. wsdl4j.jar (required for SOAP mode) 
    * 18. xalan.jar (required for SOAP mode) 
    * 19. xbean.jar (required for SOAP mode) 
    * 20. xercesImpl.jar (required for SOAP mode) 
    * 21. adobe-assembler-client.jar  
    *  
    *  The JBoss files must be kept in the jboss\client folder. You can copy the client folder to  
    *  your local development environment and then include the 3 JBoss JAR files in your class path 
    *   
    *  These JAR files are located in the following path: 
    * <install directory>/sdk/client-libs/common 
    *  
    *  
    * <install directory>/jboss/bin/client 
    *  
    * If you want to invoke a remote forms server instance and there is a 
    * firewall between the client application and the server, then it is  
    * recommended that you use the SOAP mode. When using the SOAP mode,  
    * you have to include additional JAR files located in the following  
    * path 
    * <install directory>/sdk/client-libs/thirdparty 
    *  
    * For information about the SOAP  
    * mode and the additional JAR files that need to be included,  
    * see "Setting connection properties" in Programming  
    * with AEM Forms 
    *  
    * For complete details about the location of the AEM Forms JAR files,  
    * see "Including LiveCycle Java library files" in Programming  
    * with AEM Forms 
    *  
    *  This is the DDX file is used to assemble multiple XDP documents: 
    * <?xml version="1.0" encoding="UTF-8"?> 
    * <DDX xmlns="http://ns.adobe.com/DDX/1.0/"> 
    *    <XDP result="tuc018result.xdp"> 
    *       <XDP source="tuc018_template_flowed.xdp"> 
    *          <XDPContent insertionPoint="ddx_fragment" source="tuc018_contact.xdp" fragment="subPatientContact" required="false"/> 
    *          <XDPContent insertionPoint="ddx_fragment" source="tuc018_patient.xdp" fragment="subPatientPhysical" required="false"/> 
    *          <XDPContent insertionPoint="ddx_fragment" source="tuc018_patient.xdp" fragment="subPatientHealth" required="false"/> 
    *       </XDP> 
    *    </XDP>         
    * </DDX> 
    */ 
import com.adobe.livecycle.assembler.client.AssemblerOptionSpec; 
import com.adobe.livecycle.assembler.client.AssemblerResult; 
import com.adobe.livecycle.assembler.client.AssemblerServiceClient; 
import com.adobe.livecycle.output.client.*; 
 
import java.util.*; 
import java.io.File; 
import java.io.FileInputStream; 
import com.adobe.idp.Document; 
import com.adobe.idp.dsc.clientsdk.ServiceClientFactory; 
import com.adobe.idp.dsc.clientsdk.ServiceClientFactoryProperties; 
 
 
public class CreatePDFFromFragments { 
 
    public static void main(String[] args) { 
         
        try{ 
            //Set connection properties required to invoke AEM Forms                                 
            Properties connectionProps = new Properties(); 
            connectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_SOAP_ENDPOINT, "jnp://[server]:[port]"); 
            connectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_SOAP_PROTOCOL);           
            connectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "JBoss"); 
            connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator"); 
            connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password"); 
                         
            //Create a ServiceClientFactory object 
            ServiceClientFactory myFactory = ServiceClientFactory.createInstance(connectionProps); 
                     
            //Create an OutputClient object 
            OutputClient outClient = new OutputClient(myFactory);  
                             
            //Reference form data                         
            FileInputStream fileInputStream = new FileInputStream("C:\\Adobe\Loan.xml");     
            Document inXMData = new Document (fileInputStream); 
                     
            //Set PDF run-time options     
            PDFOutputOptionsSpec outputOptions = new PDFOutputOptionsSpec(); 
            outputOptions.setFileURI("C:\\Adobe\Loan.pdf"); // this PDF form is saved on the server 
             
            //Get the form design from Assembler service 
            Document formDesign =  GetFormDesign(myFactory); 
                 
            //Set rendering run-time options 
            RenderOptionsSpec pdfOptions = new RenderOptionsSpec();  
            pdfOptions.setLinearizedPDF(true); 
            pdfOptions.setAcrobatVersion(AcrobatVersion.Acrobat_9); 
                             
            //Create a non-interactive PDF document             
            OutputResult outputDocument = outClient.generatePDFOutput2( 
                TransformationFormat.PDF, 
                "C:\\Adobe", 
                formDesign, 
                outputOptions, 
                pdfOptions, 
                inXMData 
            ); 
                     
            //Save the non-interactive PDF form as a PDF file on the client computer 
            Document pdfForm = outputDocument.getGeneratedDoc(); 
            File myFile = new File("C:\\Adobe\Loan.pdf"); 
            pdfForm.copyToFile(myFile); 
            } 
            catch (Exception ee) 
            { 
                ee.printStackTrace(); 
            } 
        } 
         
        //Retrieve the form design from Assembler service 
        private static Document GetFormDesign(ServiceClientFactory myFactory) 
        { 
            try{ 
                                 
                //Create an AssemblerServiceClient object 
                AssemblerServiceClient assemblerClient = new AssemblerServiceClient(myFactory); 
 
                //Create a FileInputStream object based on an existing DDX file  
                FileInputStream myDDXFile = new FileInputStream("C:\\Adobe\fragmentDDX.xml");  
                 
                //Create a Document object based on the DDX file 
                Document myDDX = new Document(myDDXFile);  
 
                //Create a Map object to store the input XDP files 
                Map inputs = new HashMap(); 
                FileInputStream inSource = new FileInputStream("C:\\Adobe\tuc018_template_flowed.xdp"); 
                FileInputStream inFragment1 = new FileInputStream("C:\\Adobe\tuc018_contact.xdp"); 
                FileInputStream inFragment2 = new FileInputStream("C:\\Adobe\tuc018_patient.xdp"); 
             
                //Create a Document object  
                Document myMapSource = new Document(inSource);  
 
                //Create a Document object 
                Document inFragment1Doc = new Document(inFragment1);  
                 
                //Create a Document object  
                Document inFragment2Doc = new Document(inFragment2);  
 
                //Place all of the XDP files into the MAP 
                inputs.put("tuc018_template_flowed.xdp",myMapSource);  
                inputs.put("tuc018_contact.xdp",inFragment1Doc);  
                inputs.put("tuc018_patient.xdp",inFragment2Doc);  
                 
 
                //Create an AssemblerOptionsSpec object 
                AssemblerOptionSpec assemblerSpec = new AssemblerOptionSpec(); 
                assemblerSpec.setFailOnError(false);  
 
                //Submit the job to Assembler service 
                AssemblerResult jobResult = assemblerClient.invokeDDX(myDDX,inputs,assemblerSpec);    
                java.util.Map allDocs = jobResult.getDocuments(); 
 
                //Retrieve the result PDF document from the Map object 
                Document outDoc = null; 
 
                //Iterate through the map object to retrieve the result XDP document 
                for (Iterator i = allDocs.entrySet().iterator(); i.hasNext();) { 
                    // Retrieve the Map object?s value 
                    Map.Entry e = (Map.Entry)i.next(); 
                     
                    //Get the key name as specified in the  
                    //DDX document  
                    String keyName = (String)e.getKey(); 
                    if (keyName.equalsIgnoreCase("tuc018result.xdp")) 
                    {  
                        Object o = e.getValue(); 
                        outDoc = (Document)o; 
     
                    } 
                } 
                 
            return outDoc;      
            }catch (Exception e) { 
                e.printStackTrace(); 
            } 
            return null;  
        } 
    } 
 

// Ethnio survey code removed