Programming with LiveCycle ES2.5

API Quick Starts (Code Examples)

Introducing API Quick Starts

Adobe® LiveCycle® ES2 (Enterprise Suite) API Quick Starts can help you accelerate your efforts to develop programs that interact with LiveCycle ES2.5 services. Quick Starts are complete programs that you can copy and paste into your own projects and use as a starting point. You can run a Quick Start to see how it behaves and modify it for your own needs.

How LiveCycle ES2.5 Quick Starts are organized

LiveCycle ES2.5 operations are organized into the following Quick Start categories:

  • Java API (EJB) - Uses the LiveCycle ES2.5 strongly-typed API and the connection mode is set to EJB. (See Setting connection properties.)
  • Java API (SOAP) - Uses the LiveCycle ES2.5 strongly-typed API and the connection mode is set to SOAP.
  • Web service API (MTOM) - Uses a .NET client proxy and MTOM. The .NET client proxy is created. (See Invoking LiveCycle ES2.5 using MTOM.)
  • Web service API (Base64) - Uses a .NET client proxy and Base64. The .NET client proxy is created. (See Invoking LiveCycle ES2.5 using Base64 encoding.)
  • Web service API (SwaRef) - Demonstrates using Java proxy classes and SwaRef. These Java proxy classes are separate from the LiveCycle ES2.5 strongly-typed API. The Java proxy files are created. (See Invoking LiveCycle ES2.5 using SwaRef.)

Note: Most services either have a MTOM or Base64 web service example using a .NET client application.

Each Java strongly-typed API Quick Start provides a listing of JAR files that are required to execute the Java application. Most Java Quick Starts are console application that run within main. However, the Forms Quick Starts are implemented as Java servlets that run within a web application.

The JAR file listing is located in a comment section located at the beginning of the Quick Start. For example, the following comment is located in an Output quick start and is a typical JAR file listing found in each Java Quick Start.

/*
 * This Java Quick Start uses the EJB 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. adobe-utilities.jar
 * 5. jbossall-client.jar (use a different JAR file if LiveCycle ES2.5 is not deployed
 * on JBoss)
 * 
 *  These JAR files are located in the following path:
 * <install directory>/Adobe/Adobe LiveCycle ES2.5/LiveCycle_ES_SDK/client-libs/common
 * 
 * The adobe-utilities.jar file is located in the following path:
 * <install directory>/Adobe/Adobe LiveCycle ES2.5/LiveCycle_ES_SDK/client-libs/jboss
 * 
 * The jbossall-client.jar file is located in the following path:
 * <install directory>/Adobe/Adobe LiveCycle ES2.5/jboss/client
 * 
 * If you want to invoke a remote LiveCycle ES2.5 instance and there is a
 * firewall between the client application and LiveCycle ES2.5, 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>/Adobe/Adobe LiveCycle ES2.5/LiveCycle_ES_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 LiveCycle ES2.5
 * 
 * For complete details about the location of the LiveCycle ES2.5 JAR files, 
 * see "Including LiveCycle ES2.5 library files" in Programming 
 * with LiveCycle ES2.5
 */

Multiple Services Quick Starts

Most Quick Starts located in Programming with LiveCycle ES2.5 invoke a specific service in order to perform an operation. However, some Quick Starts invoke multiple LiveCycle ES2.5 services in order to perform a given workflow. The following list provides Java quick starts that invoke more than one LiveCycle ES2.5 service:

Quick Start (EJB mode): Passing a document located in the LiveCycle Repository to the Output service using the Java API (invokes the Repository and Output service)

Quick Start (EJB mode): Creating a PDF document based on fragments using the Java API (invokes the Assembler and Output service)

Quick Start (EJB mode): Creating PDF Documents with submitted XML data using the Java API (invokes the Forms, Output, and Document Management service)

Quick Start (EJB mode): Passing documents to the Forms Service using the Java API (invokes the Forms and Document Management service)

Quick Start (EJB mode): Digitally signing a XFA-based Form using the Java API (invokes the Forms and Signature service)

Quick Start (EJB mode): Managing roles and permissions using the Java API (invokes the DirectoryManager and the AuthorizationManager service )

Quick Start (EJB mode): Passing documents to the Output Service using the Java API (invoke the Output and Document Management service)

Note: Quick Starts located in Programming with LiveCycle ES2.5 are based on LiveCycle ES2.5 being deployed on JBoss® Application Server and the Microsoft® Windows® operating system. However, if you are using another operating system, such as UNIX®, replace Windows-specific paths with paths that are supported by the applicable operating system. Likewise, if you are using another J2EE application server, ensure that you specify valid connection properties. (See Setting connection properties.)

Note: Most web service Quick Starts are written in C# and uses the .NET framework. However, you can create client application logic that is able to invoke LiveCycle ES2.5 services in any development environment that supports SOAP standards. (See Invoking LiveCycle ES2.5 Using Web Services.)

Note: When using LiveCycle Remoting (as of LiveCycle ES2.5 8.2), it is recommended that you invoke short-lived and long-lived processes created in Workbench ES2 as opposed to invoking service operations directly. As a result, Remoting Quick Starts are now located in the Invocation Quick Start section and not in the individual service Quick Start sections. (See Invoking LiveCycle ES2.5 Using LiveCycle Remoting.)