Rendering forms based on fragments using the web service API

To render a form based on fragments using the web service API, perform the following tasks:

1.	Include project files

•	Create Java proxy classes that consume the Forms service WSDL. For information, see Creating Java proxy classes using Apache Axis.

•	Include the Java proxy classes into your class path.

2.	Create a Forms Client API object

Create a FormsService object and set authentication values.

3.	Specify URI values

•	Create a URLSpec object that store URI values by using its constructor.

•	Invoke the URLSpec object’s setApplicationWebRoot method and pass a string value that represents the application’s web root.

•	Invoke the URLSpec object’s setContentRootURI method and pass a string value that specifies the content root URI value. Ensure that the form design is located in the content root URI. If not, the Forms service throws an exception. To reference the LiveCycle ES repository, specify repository://.

•

Invoke the URLSpec object’s setTargetURL method and pass a string value that specifies the target URL value to where form data is posted. If you define the target URL in the form design, then you can pass an empty string. You can also specify the URL to where a form is sent in order to perform calculations.

4.	Render the form

Invoke the FormsService object’s renderPDFForm method and pass the following values:

•	A string value that specifies the form design name, including the file name extension. If you are referencing a form design that is saved in the LiveCycle ES repository, ensure that you specify the / character before the file name.

•	A BLOB object that contains data to merge with the form. If you do not want to merge data, then pass null. For information, see Prepopulating Dynamic Forms.

•	A PDFFormRenderSpec object that stores run-time options. Note that the tagged PDF option cannot be set if the input document is a PDF document. If the input file is an XDP file, then the tagged PDF option can be set. For information about run-time options, see the LiveCycle ES API References.

•	A URLSpec object that contains URI values required by the Forms service.

•	A java.util.HashMap object that stores file attachments. This is an optional parameter and you can specify null if you do not want to attach files to the form. For information, see Attach files to the form.

•	An empty com.adobe.idp.services.holders.BLOBHolder object that is populated by the method. This parameter is used to store the rendered form.

•	An empty javax.xml.rpc.holders.LongHolder object that is populated by the method. This argument will store the number of pages in the form.

•	An empty javax.xml.rpc.holders.StringHolder object that is populated by the method. This argument will store the locale value.

•	An empty com.adobe.idp.services.holders.FormsResultHolder object that will contain the results of this operation.

The renderPDFForm method populates the com.adobe.idp.services.holders.FormsResultHolder object that is passed as the last argument value with a form data stream that must be written to the client web browser.

5.	Write the form data stream to the client web browser

•	Create a FormResult object by getting the value of the com.adobe.idp.services.holders.FormsResultHolder object’s value data member.

•	Create a BLOB object that contains form data by invoking the FormsResult object’s getOutputContent method.

•	Get the content type of the BLOB object by invoking its getContentType method.

•	Set the javax.servlet.http.HttpServletResponse object’s content type by invoking its setContentType method and passing the content type of the BLOB object.

•	Create a javax.servlet.ServletOutputStream object used to write the form data stream to the client web browser by invoking the javax.servlet.http.HttpServletResponse object’s getOutputStream method.

•	Create a byte array and populate it by invoking the BLOB object’s getBinaryData method. This task assigns the content of the FormsResult object to the byte array.

•	Invoke the javax.servlet.http.HttpServletResponse object’s write method to send the form data stream to the client web browser. Pass the byte array to the write method.

View Quick Start

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/sdkHelp/renderingFormFragments.36.4.html