Quick Start (SOAP mode): Prepopulating Forms with Flowable Layouts using the Java API

The following code example prepopulates a form with a dynamic data source. That is, the data source is created at run-time and is not contained within an XML file or created during design time. This code example contains three user-defined methods:

  • createDataSource : Creates an org.w3c.dom.Document object that represents the data source that is used to prepopulate the form. This user-defined method returns the org.w3c.dom.Document object.

  • convertDataSource : Converts an org.w3c.dom.Document object to a com.adobe.idp.Document object. This method accepts an org.w3c.dom.Document object as an input parameter and returns a com.adobe.idp.Document object.

  • renderPOForm : Uses the Forms service Java API to render a dynamic purchase order form. The com.adobe.idp.Document object that was returned by the convertDataSource method is used to prepopulate the form.

    All of these methods are invoked from within the Java servlet’s doPost method. (See Prepopulating Forms with Flowable Layouts.)

        * This Java Quick Start uses the following JAR files 
        * 1. adobe-forms-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. commons-codec-1.3.jar (required for SOAP mode) 
        * 7. commons-collections-3.2.jar  (required for SOAP mode) 
        * 8. commons-discovery.jar (required for SOAP mode) 
        * 9. commons-logging.jar (required for SOAP mode) 
        * 10. dom3-xml-apis-2.5.0.jar (required for SOAP mode) 
        * 11. jaxen-1.1-beta-9.jar (required for SOAP mode) 
        * 12. jaxrpc.jar (required for SOAP mode) 
        * 13. log4j.jar (required for SOAP mode) 
        * 14. mail.jar (required for SOAP mode) 
        * 15. saaj.jar (required for SOAP mode) 
        * 16. wsdl4j.jar (required for SOAP mode) 
        * 17. xalan.jar (required for SOAP mode) 
        * 18. xbean.jar (required for SOAP mode) 
        * 19. xercesImpl.jar (required for SOAP mode) 
        *  (Because Forms quick starts are implemented as Java servlets, it is  
        *  not necessary to include J2EE specific JAR files - the Java project 
        *  that contains this quick start is exported as a WAR file which 
        *  is deployed to the J2EE application server) 
        *  These JAR files are located in the following path: 
        * <install directory>/sdk/client-libs/common 
        * For complete details about the location of these JAR files,  
        * see "Including AEM Forms library files" in Programming with AEM forms 
    import java.io.IOException; 
    import javax.servlet.Servlet; 
    import javax.servlet.ServletException; 
    import javax.servlet.ServletOutputStream; 
    import javax.servlet.http.HttpServlet; 
    import javax.servlet.http.HttpServletRequest; 
    import javax.servlet.http.HttpServletResponse; 
    import com.adobe.livecycle.formsservice.client.*; 
    import java.util.*; 
    import java.io.ByteArrayOutputStream; 
    import java.io.InputStream; 
    import com.adobe.idp.Document; 
    import com.adobe.idp.dsc.clientsdk.ServiceClientFactory; 
    import com.adobe.idp.dsc.clientsdk.ServiceClientFactoryProperties; 
    import org.w3c.dom.Element; 
    import javax.xml.parsers.*; 
    import javax.xml.transform.*; 
    import javax.xml.transform.dom.DOMSource; 
    import javax.xml.transform.stream.StreamResult; 
    public class RenderDynamicForm extends HttpServlet implements Servlet { 
        public void doGet(HttpServletRequest req, HttpServletResponse resp) 
            throws ServletException, IOException { 
        public void doPost(HttpServletRequest req, HttpServletResponse resp) 
            throws ServletException, IOException { 
                //Render a dynamic purchase order form 
                //Create an org.w3c.dom.Document object 
                org.w3c.dom.Document myDom = createDataSource(); 
                //Convert the org.w3c.dom.Document object 
                //to a com.adobe.idp.Document object 
                com.adobe.idp.Document formData = convertDataSource(myDom); 
                //Render the dynamic form using data located within the  
                //com.adobe.idp.Document object 
         //Creates an org.w3c.dom.Document object 
         private org.w3c.dom.Document createDataSource() 
            org.w3c.dom.Document document = null; 
                //Create DocumentBuilderFactory and DocumentBuilder objects 
                DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); 
                DocumentBuilder builder = factory.newDocumentBuilder(); 
                //Create a new Document object 
                document = builder.newDocument();  
                //Create the root element and append it to the XML DOM 
                Element root = (Element)document.createElement("transaction"); 
                //Create the header element 
                Element header = (Element)document.createElement("header"); 
                //Create the txtPONum element and append it to the 
                //header element 
                Element txtPONum = (Element)document.createElement("txtPONum"); 
                //Create the dtmDate element and append it to the  
                //header element     
                Element dtmDate = (Element)document.createElement("dtmDate"); 
                //Create the orderedByAddress element and append  
                //it to the header element 
                Element orderedByAddress =(Element)document.createElement("orderedByAddress"); 
                orderedByAddress.appendChild(document.createTextNode("222, Any Blvd")); 
                //Create the txtOrderedByPhone element and append  
                //it to the header element 
                Element txtOrderedByPhone = (Element)document.createElement("txtOrderedByPhone"); 
                txtOrderedByPhone.appendChild(document.createTextNode("(555) 555-2334")); 
                //Create the txtOrderedByFax element and append 
                //it to the header element 
                Element txtOrderedByFax = (Element)document.createElement("txtOrderedByFax");     
                txtOrderedByFax.appendChild(document.createTextNode("(555) 555-9334")); 
                //Create the txtOrderedByContactName element and append 
                //it to the header element 
                Element txtOrderedByContactName = (Element)document.createElement("txtOrderedByContactName"); 
                txtOrderedByContactName.appendChild(document.createTextNode("Frank Jones")); 
                //Create the deliverToAddress element and append 
                //it to the header element 
                Element deliverToAddress = (Element)document.createElement("deliverToAddress"); 
                deliverToAddress.appendChild(document.createTextNode("555, Any Blvd")); 
                //Create the txtDeliverToPhone element and append 
                //it to the header element 
                Element txtDeliverToPhone = (Element)document.createElement("txtDeliverToPhone"); 
                txtDeliverToPhone.appendChild(document.createTextNode("(555) 555-9098")); 
                //Create the txtDeliverToFax element and append 
                //it to the header element 
                Element txtDeliverToFax = (Element)document.createElement("txtDeliverToFax"); 
                txtDeliverToFax.appendChild(document.createTextNode("(555) 555-9000")); 
                //Create the txtDeliverToContactName element and 
                //append it to the header element 
                Element txtDeliverToContactName = (Element)document.createElement("txtDeliverToContactName"); 
                txtDeliverToContactName.appendChild(document.createTextNode("Jerry Johnson")); 
                //Create the detail element and append it to the root 
                Element detail = (Element)document.createElement("detail"); 
                //Create the txtPartNum element and append it to the 
                //detail element 
                Element txtPartNum = (Element)document.createElement("txtPartNum"); 
                //Create the txtDescription element and append it 
                //to the detail element 
                Element txtDescription = (Element)document.createElement("txtDescription"); 
                //Create the numQty element and append it to  
                //the detail element 
                Element numQty = (Element)document.createElement("numQty"); 
                //Create the numUnitPrice element and append it 
                //to the detail element 
                Element numUnitPrice = (Element)document.createElement("numUnitPrice"); 
                //Create another detail element named detail2 and  
                //append it to root 
                Element detail2 = (Element)document.createElement("detail"); 
                //Create the txtPartNum element and append it to the 
                //detail2 element 
                Element txtPartNum2 = (Element)document.createElement("txtPartNum"); 
                //Create the txtDescription element and append it  
                //to the detail2 element 
                Element txtDescription2 = (Element)document.createElement("txtDescription"); 
                txtDescription2.appendChild(document.createTextNode("Desk lamps")); 
                //Create the numQty element and append it to the  
                //detail2 element 
                Element numQty2 = (Element)document.createElement("numQty"); 
                //Create the NUMUNITPRICE element 
                Element numUnitPrice2 = (Element)document.createElement("numUnitPrice"); 
         catch (Exception e) { 
                  System.out.println("The following exception occurred: "+e.getMessage()); 
        return document; 
         //Converts an org.w3c.dom.Document object to a  
         //com.adobe.idp.Document object  
         private Document convertDataSource(org.w3c.dom.Document myDOM) 
            byte[] mybytes = null;  
            //Create a Java Transformer object 
            TransformerFactory transFact = TransformerFactory.newInstance(); 
            Transformer transForm = transFact.newTransformer();  
            //Create a Java ByteArrayOutputStream object 
            ByteArrayOutputStream myOutStream = new ByteArrayOutputStream();  
            //Create a Java Source object 
            javax.xml.transform.dom.DOMSource myInput = new DOMSource(myDOM); 
            //Create a Java Result object 
            javax.xml.transform.stream.StreamResult myOutput = new StreamResult(myOutStream);      
            //Populate the Java ByteArrayOutputStream object 
            // Get the size of the ByteArrayOutputStream buffer 
             int myByteSize = myOutStream.size(); 
            //Allocate myByteSize to the byte array 
             mybytes = new byte[myByteSize]; 
            //Copy the content to the byte array 
             mybytes = myOutStream.toByteArray(); 
            catch (Exception e) { 
              System.out.println("The following exception occurred: "+e.getMessage()); 
         //Create a com.adobe.idp.Document object and copy the  
         //contents of the byte array 
         Document myDocument = new Document(mybytes); 
         return myDocument;  
         //Render the purchase order form using the specified  
         //com.adobe.idp.Document object 
         private void renderPOForm(HttpServletResponse resp, Document formData) 
                //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_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 a FormsServiceClient object 
                FormsServiceClient formsClient = new FormsServiceClient(myFactory);  
                //Set the parameter values for the renderPDFForm method 
                String formName = "Applications/FormsApplication/1.0/FormsFolder/PO.xdp";   
                //Cache the form 
                PDFFormRenderSpec pdfFormRenderSpec = new PDFFormRenderSpec(); 
                pdfFormRenderSpec.setCacheEnabled(new Boolean(true)); 
                //Specify URI values that are required to render a form 
                URLSpec uriValues = new URLSpec();  
                //Invoke the renderForm method 
                FormsResult formOut = formsClient.renderPDFForm( 
                    formName,               //formQuery 
                    formData,                 //inDataDoc 
                    pdfFormRenderSpec,      //PDFFormRenderSpec 
                    uriValues,                //urlSpec 
                    null                    //attachments 
                //Create a ServletOutputStream object 
                ServletOutputStream oOutput = resp.getOutputStream(); 
                //Create a Document object that stores form data 
                Document myData = formOut.getOutputContent(); 
                //Create an InputStream object 
                InputStream inputStream = myData.getInputStream(); 
                //Write the data stream to the web browser 
                byte[] data = new byte[4096]; 
                int bytesRead = 0; 
                while ((bytesRead = inputStream.read(data)) > 0) 
                    oOutput.write(data, 0, bytesRead); 
                }catch (Exception e) { 
                     System.out.println("The following exception occurred: "+e.getMessage()); 

// Ethnio survey code removed