Quick Start: Rendering a form guide using the Java API

The following code example renders a form guide named LoanGuide.xdp to a client web browser. (See Rendering Form Guides.)

/*

 * This Java Quick Start uses the following JAR files

 * 1. adobe-forms-client.jar

 * 2. adobe-livecycle-client.jar

 * 3. adobe-usermanager-client.jar

 * 

 *  (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>/Adobe/LiveCycle8/LiveCycle_ES_SDK/client-libs

 * 

 * For complete details about the location of these JAR files, 

 * see "Including LiveCycle ES library files" in Programming with LiveCycle ES

 */

import java.io.IOException;

import java.io.InputStream;

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 com.adobe.idp.Document;

import com.adobe.idp.dsc.clientsdk.ServiceClientFactory;

import com.adobe.idp.dsc.clientsdk.ServiceClientFactoryProperties;

public class RenderFormGuide extends HttpServlet implements Servlet {

	public void doGet(HttpServletRequest req, HttpServletResponse resp)

		throws ServletException, IOException {

			doPost(req,resp); 

	}

	public void doPost(HttpServletRequest req, HttpServletResponse resp)

		throws ServletException, IOException {

	try{

		//Set connection properties required to invoke LiveCycle ES								

		Properties connectionProps = new Properties();

		connectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_EJB_ENDPOINT, "jnp://localhost:1099");

		connectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_EJB_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);

		FormsServiceClient formsClient = new FormsServiceClient(myFactory); 

		//Specify the parameters for the renderActivityGuide method

		String formName = "LoanGuide.xdp"; 

		byte[] cData = "".getBytes();

		Document oInputData = new Document(cData);

		//Cache the PDF form

		PDFFormRenderSpec pdfFormRenderSpec = new PDFFormRenderSpec();

		pdfFormRenderSpec.setCacheEnabled(new Boolean(true));

		//Set Form Guide run-time options

		ActivityGuideRenderSpec renderSpec = new ActivityGuideRenderSpec(); 

		renderSpec.setGuidePDF(false);

		//Specify URI values that are required to render a form

		//design located in the LiveCycle ES repository

		URLSpec uriValues = new URLSpec(); 

		uriValues.setApplicationWebRoot("http://localhost:8080/FormsQS");

		uriValues.setContentRootURI("C:\\Adobe");

		uriValues.setTargetURL("http://localhost:8080/FormsQS/HandleData");

		//Invoke the renderFormGuide method

		FormsResult formOut = formsClient.renderFormGuide(

				formName,            //formQuery

				oInputData,          //inDataDoc 

				pdfFormRenderSpec,    //pdfFormRenderSpec

				renderSpec,           //activityGuideRenderSpec

				uriValues			  //urlSpec

				);  

		//Create a Document object that stores form data

		Document myData = formOut.getOutputContent();

		//Get the content type of the response

		String contentType = myData.getContentType(); 

		resp.setContentType(contentType);

		//Create a ServletOutputStream object

		ServletOutputStream oOutput = resp.getOutputStream();

		//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 occured: "+e.getMessage());

			  }

	 }

}

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/help/000070.html

Add Comment