Article summary

Summary

Discusses how to create an Apache Sling Servlet that accepts LiveCycle ES process data that is posted from a custom document service component (DSC). The servlet also uses the JCR API to persist the process data in the JCR.

This article uses an Adobe Maven Archetype project to build an OSGi bundle. If you are not familiar with an Adobe Maven Archetype project, it is recommended that you read the following article: Creating your first AEM Service using an Adobe Maven Archetype project.

This development article talks about how to post data from LiveCycle ES to AEM. If you are interested in learning how to sent data from an AEM application to LiveCycle ES (the opposite use case), see Integrating LiveCycle into Adobe CQ applications.

Digital Marketing Solution(s) Adobe Experience Manager (Adobe CQ)
Audience
Developer (intermediate)
Required Skills
Java, LiveCycle ES, Maven, JCR, Sling
Tested On Adobe Experience Manager 5.5, 5.6

Introduction

As a user of both Adobe LiveCycle ES and Adobe Experience Manager, you can create business applications that make use of both platforms. That is, you can create an enterprise solution that uses functionality provided by Experience Manager and LiveCycle ES. By combining the functionality of both server products, you can create applications to solve your business requirements.

For example, assume that you have a LiveCycle business process that extracts data from a PDF document. Next assume that you want to store the data in a remote AEM server's JCR.

LCAEM

As shown in the previous illustration, you can create a custom LiveCycle ES Document Service Component (DSC) that is able to post process data to a custom AEM Sling Servlet. The custom Sling Servlet persists the process data in the AEM JCR by using the JCR API. The following illustration shows a LiveCycle ES process that sets process variables and then uses the custom DSC to persist the data into the AEM JCR.

LCProcess

To post LiveCycle ES process data to a remote AEM JCR, you write a custom DSC that uses Java APIs located in the java.net package. The custom DSC posts data to a custom Sling Servlet by using Java application logic.
 

 //Set credentials to successfully POST data to AEM
String username = "admin";
String password = "admin" ; 
String userPassword = username + ":" + password;
String encoding = new BASE64Encoder().encode(userPassword.getBytes());
            
HttpURLConnection conn = (HttpURLConnection)url.openConnection();
conn.setRequestMethod("POST");
conn.setRequestProperty("Authorization", "Basic " + encoding); // handles authentication with AEM
conn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
conn.setRequestProperty("Content-Length", String.valueOf(postDataBytes.length));
conn.setDoOutput(true);
     
// Write data
OutputStream os = conn.getOutputStream();
os.write(postDataBytes);
         
// Read response
StringBuilder responseSB = new StringBuilder();
BufferedReader br = new BufferedReader(new InputStreamReader(conn.getInputStream()));
          
String line;
while ( (line = br.readLine()) != null)
            responseSB.append(line);
                 
// Close streams
br.close();
os.close();

The custom Sling Servlet retrieves the process data and uses the JCR API to store the data into the AEM JCR. In this development article, assume that the LiveCycle ES process posts customer claim data to the AEM Sling Servlet. The following illustration show process data that is posted to the AEM Sling Servlet.

ProcessData

When the LiveCycle ES process is invoked, it posts the process data to the AEM Sling Servlet. The Sling Servlet persists the data to content/claim. For each post, a new nt:unstructured node is placed under claim. Data is saved as properties of the node, as shown in this illustration.  

AEMData

This development article guides you through creating the custom LiveCycle ES DSC, the LiveCycle process that uses the custom DSC, and the AEM Sling Servlet. The custom Sling Servlet is is implemented as an OSGi bundle that is built using Declarative Services (DS) and Maven. DS is used to inject a ResourceResolverFactory instance into the service. The OSGi bundle is a managed component, which means that the OSGi service container creates the ResourceResolverFactory instance.

Note:

Before following along with this development article, ensure that you have both Adobe LiveCycle ES and Adobe Experience Manager.

Create the LiveCycle ES custom component 

A LiveCycle ES document service component (DSC) contains one or more services, and each service contains one or more operations. A service contains business logic that is executed when an operation is invoked. The business logic consists of Java classes and interfaces. In this development article, the DSC comprises of a Java class named ModifyJCRImpl that extends a Java interface named ModifyJCR.

 

Note:

You have to add the sun.misc.BASE64Decoder.jar file to the custom DSC. This JAR file is used in component's application logic to post the process data to AEM. You can download this file from the Internet.  

Create application logic for the DSC

To create the custom DSC component, perform these tasks:

  1. Create an Eclipse project.
  2. Create a package named com.adobe.lc.aem.
  3. Define the service interface named modifyJCR.
  4. Define the service implementation modifyJCRImpl.

Create the modifyJCR interface

A service implementation is essentially a Plain Old Java Object (POJO) that you can develop by creating a Java interface that defines the service's operations (public methods), input values, and return values. The public methods that are defined within the Java interface become operations that are exposed by the service. You do not need to implement any Adobe-specific Java libraries when creating a service interface.

The following Java code represents the modifyJCR interface.

package com.adobe.lc.aem;

public interface modifyJCR {
	
public String addNode(String val, String firstName, String lastName, String address, String cat, String state, String detail, String date, String city); 
	
}

Define the service implementation 

Create a service implementation class that implements modifyJCR. A service implementation conforms to the following restrictions:

  • The implementation class must have a public no-argument constructor.
  • The service implementation class must be stateless.
  • Input parameters, output parameters, and exceptions must be serializable.
  • The business logic that is executed by LiveCycle ES when the operation is invoked must be specified in the corresponding methods. For example, consider the addNode method that is defined in the modifyJCR interface. You create business logic within the addNode method that posts process data to the AEM Sling Servlet (the example in this section shows Java HTTP application logic that posts process data).

The addNode method has the following arguments:

  • val: Specifies the claim identifier value
  • firstName: Specifies the first name
  • lastName: Specifies the last name
  • address: Specifies the address
  • cat: Specifies the category
  • state: Specifies the state
  • detail: Specifies the details
  • date: Specifies the date
  • city: Specifies the city

The following Java code shows the Java implementation class named ModifyJCRImpl that implements ModifyJCR.

package com.adobe.lc.aem;

import java.io.*;
import java.net.* ;
import java.util.*;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;

import Decoder.*;
public class ModifyJCRImpl implements modifyJCR {

  @Override
  public String addNode(String val, String firstName, String lastName, String address, String cat, String state, String detail, String date, String city) {
		
   try
     {
      
      //Specify the URL to the AEM Sling Servlet    
      URL url = new URL("http://AEMServer:4502/bin/handleclaim");
        
      Map<String,Object> params = new LinkedHashMap<String,Object>();
      params.put("id", val);
      params.put("firstName", firstName);
      params.put("lastName", lastName);
      params.put("address", address);
      params.put("cat", cat);
      params.put("state", state);
      params.put("details", detail);
      params.put("date", date);
      params.put("city", "city");
        
      StringBuilder postData = new StringBuilder();
       for (Map.Entry<String,Object> param : params.entrySet()) {
            if (postData.length() != 0) postData.append('&');
            postData.append(URLEncoder.encode(param.getKey(), "UTF-8"));
            postData.append('=');
            postData.append(URLEncoder.encode(String.valueOf(param.getValue()), "UTF-8"));
        }
        byte[] postDataBytes = postData.toString().getBytes("UTF-8");

      //Set credentials to successfully POST data to AEM
      String username = "admin";
      String password = "admin" ; 
      String userPassword = username + ":" + password;
      String encoding = new BASE64Encoder().encode(userPassword.getBytes());
            
      HttpURLConnection conn = (HttpURLConnection)url.openConnection();
      conn.setRequestMethod("POST");
      conn.setRequestProperty("Authorization", "Basic " + encoding); // handles authentication with AEM
      conn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
      conn.setRequestProperty("Content-Length", String.valueOf(postDataBytes.length));
      conn.setDoOutput(true);
     
      // Write data
       OutputStream os = conn.getOutputStream();
       os.write(postDataBytes);
         
       // Read response
       StringBuilder responseSB = new StringBuilder();
       BufferedReader br = new BufferedReader(new InputStreamReader(conn.getInputStream()));
          
      String line;
       while ( (line = br.readLine()) != null)
            responseSB.append(line);
                 
        // Close streams
        br.close();
        os.close();

        return "worked";
    }        
    catch(Exception e)
    {
    	e.printStackTrace() ; 
    }
    return null; 
 }
}

Define the component XML file

Create a component XML file to deploy a component to LiveCycle ES. A component XML file exists for each component and provides metadata about the component. You can use the component XML file to customize your component to meet your requirements. For more information about a component XML file, see Creating your first LiveCycle ES component.

The followinig XML code represents the component XML file for the custom DSC that posts data to the AEM JCR. Notice that the service name is JCRService and the operation that it exposes is named addNode. (This is the operation that is invoked from the LiveCycle ES process).

<component xmlns="http://adobe.com/idp/dsc/component/document">
<!-- Unique id identifying this component -->
   <component-id>com.adobe.lc.aem.ModifyJCRImpl</component-id>

<!-- Version -->
   <version>1.0</version>
   <class-path>sun.misc.BASE64Decoder.jar</class-path>   
    
      
<!-- Start of the Service definition -->
   <services>
<!-- Unique name for service descriptor. 
           The value is used as the default name for 
           deployed services -->
      <service name="JCRService">
<!-- service implementation class definition -->
        <implementation-class>com.adobe.lc.aem.ModifyJCRImpl</implementation-class>
         
<!-- description -->
        <description>Modifies an AEM JCR</description>



<!-- automatically deploys the service and starts it after installation -->
         <auto-deploy service-id="JCRService" />

<operations>
<!-- method name in the interface setSmtpHost-->
<operation name="addNode">
<!-- input parameters to the "send" method -->
                <input-parameter name="val" title="val" type="java.lang.String">
                    <hint>Value to add to the message property of the new node</hint>
                </input-parameter>
                <input-parameter name="firstName" title="firstName" type="java.lang.String">
                    <hint>Value to add to the message property of the new node</hint>
                </input-parameter>
                <input-parameter name="lastName" title="lastName" type="java.lang.String">
                    <hint>Value to add to the message property of the new node</hint>
                </input-parameter>
                <input-parameter name="address" title="address" type="java.lang.String">
                    <hint>Value to add to the message property of the new node</hint>
                </input-parameter>
                <input-parameter name="cat" title="cat" type="java.lang.String">
                    <hint>Value to add to the message property of the new node</hint>
                </input-parameter>
                <input-parameter name="state" title="state" type="java.lang.String">
                    <hint>Value to add to the message property of the new node</hint>
                </input-parameter>
                <input-parameter name="detail" title="detail" type="java.lang.String">
                    <hint>Value to add to the message property of the new node</hint>
                </input-parameter>
                <input-parameter name="date" title="date" type="java.lang.String">
                    <hint>Value to add to the message property of the new node</hint>
                </input-parameter>
                <input-parameter name="city" title="city" type="java.lang.String">
                    <hint>Value to add to the message property of the new node</hint>
                </input-parameter>
               <output-parameter name="outputval" type="java.lang.String">
                </output-parameter>
            </operation>
             </operations>
      </service>
   </services>
</component>

Package the component into a JAR file 

To deploy the component to LiveCycle ES, package your Eclipse project into a JAR file. Ensure that the external sun.misc.BASE64Decoder.jar file is included in the component JAR file. As well, the component XML file must be present. The component.xml file and external JAR files must be located at the root of the JAR file.

It is recommended that you include only the JAR files that are required to run the Java application logic located in your component. That is, if a JAR file is not required by your component, do not include it in the component JAR file.  

The following illustration shows the Eclipse project's content, which is packaged into the component's JAR file.

DSCProject2

Note:

Package the component into a JAR file. In the previous illustration, notice that JAVA files are listed. Once packaged into a JAR file, the corresponding CLASS files will also be part of the component JAR file. Without the CLASS files, the component will not work. Also, ensure that the compression option is turned off. 

 Deploy the custom LiveCycle ES component

Deploy the custom component to LiveCycle ES by using Workbench ES.

  1. Start Workbench ES.
  2. Log in to Workbench ES.
  3. Select Window > Show Views > Components. This action adds the Components view to Workbench ES.
  4. Right-click the Components icon and select Install Component.
  5. Select the component JAR jar file through the file browser and click Open.
  6. Select Service Descriptors, and then right-click JCRService and select Activate Service.
  7. Right-click the component and select Start Component. A green arrow appears next to the name if it succeeds. Notice that it is automatically deployed and has a green arrow next to it if it succeeds.

 

Create a LiveCycle process that uses the custom DSC

After you deploy the custom component to LiveCycle ES, you can create a new process that uses it. Although this section does not explain all the concepts involved in creating a process, it provides the basic concepts that lets you create a simple process that uses the newly created component. For complete information about creating LiveCycle ES processes, see Creating and managing processes.

The following illustration shows a short-lived process named SetNode that sets process variables with values and then uses the custom component to post the values to the AEM JCR.

ProcessSteps


In the SetValue step, create these input String process variables:

  • val - the id of the claim
  • firstName - the firstName
  • lastName- the lastName   
  • address - the address
  • cat - the category
  • state - the state
  • detail - details about the claim
  • date - the date
  • city - the city

In the addNode step, ensure that you set the input values in the design editor to the corresponding process variables, as shown in this illustration.

processVars


If you invoke this process from Workbench ES, you can specify the input values in the following property editor.

ProcessData

Setup Maven in your development environment

You can use Maven to build an OSGi bundle that contains a Sling Servlet. Maven manages required JAR files that a Java project needs in its class path. Instead of searching the Internet trying to find and download third-party JAR files to include in your project’s class path, Maven manages these dependencies for you.

You can download Maven 3 from the following URL:

http://maven.apache.org/download.html

After you download and extract Maven, create an environment variable named M3_HOME. Assign the Maven install location to this environment variable. For example:

C:\Programs\Apache\apache-maven-3.0.4

Set up a system environment variable to reference Maven. To test whether you properly setup Maven, enter the following Maven command into a command prompt:

%M3_HOME%\bin\mvn -version

This command provides Maven and Java install details and resembles the following message:

Java home: C:\Programs\Java64-6\jre
Default locale: en_US, platform encoding: Cp1252
OS name: "windows 7", version: "6.1", arch: "amd64", family: "windows"

Note:

For more information about setting up Maven and the Home variable, see: Maven in 5 Minutes.

Next, copy the Maven configuration file named settings.xml from [install location]\apache-maven-3.0.4\conf\ to your user profile. For example, C:\Users\scottm\.m2\.

You have to configure your settings.xml file to use Adobe’s public repository. For information, see Adobe Public Maven Repository at http://repo.adobe.com/.

The following XML code represents a settings.xml file that you can use.

<?xml version="1.0" encoding="UTF-8"?>

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->

<!--
 | This is the configuration file for Maven. It can be specified at two levels:
 |
 |  1. User Level. This settings.xml file provides configuration for a single user, 
 |                 and is normally provided in ${user.home}/.m2/settings.xml.
 |
 |                 NOTE: This location can be overridden with the CLI option:
 |
 |                 -s /path/to/user/settings.xml
 |
 |  2. Global Level. This settings.xml file provides configuration for all Maven
 |                 users on a machine (assuming they're all using the same Maven
 |                 installation). It's normally provided in 
 |                 ${maven.home}/conf/settings.xml.
 |
 |                 NOTE: This location can be overridden with the CLI option:
 |
 |                 -gs /path/to/global/settings.xml
 |
 | The sections in this sample file are intended to give you a running start at
 | getting the most out of your Maven installation. Where appropriate, the default
 | values (values used when the setting is not specified) are provided.
 |
 |-->
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" 
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
  <!-- localRepository
   | The path to the local repository maven will use to store artifacts.
   |
   | Default: ~/.m2/repository
  <localRepository>/path/to/local/repo</localRepository>
  -->

  <!-- interactiveMode
   | This will determine whether maven prompts you when it needs input. If set to false,
   | maven will use a sensible default value, perhaps based on some other setting, for
   | the parameter in question.
   |
   | Default: true
  <interactiveMode>true</interactiveMode>
  -->

  <!-- offline
   | Determines whether maven should attempt to connect to the network when executing a build.
   | This will have an effect on artifact downloads, artifact deployment, and others.
   |
   | Default: false
  <offline>false</offline>
  -->

  <!-- pluginGroups
   | This is a list of additional group identifiers that will be searched when resolving plugins by their prefix, i.e.
   | when invoking a command line like "mvn prefix:goal". Maven will automatically add the group identifiers
   | "org.apache.maven.plugins" and "org.codehaus.mojo" if these are not already contained in the list.
   |-->
  <pluginGroups>
    <!-- pluginGroup
     | Specifies a further group identifier to use for plugin lookup.
    <pluginGroup>com.your.plugins</pluginGroup>
    -->
  </pluginGroups>

  <!-- proxies
   | This is a list of proxies which can be used on this machine to connect to the network.
   | Unless otherwise specified (by system property or command-line switch), the first proxy
   | specification in this list marked as active will be used.
   |-->
  <proxies>
    <!-- proxy
     | Specification for one proxy, to be used in connecting to the network.
     |
    <proxy>
      <id>optional</id>
      <active>true</active>
      <protocol>http</protocol>
      <username>proxyuser</username>
      <password>proxypass</password>
      <host>proxy.host.net</host>
      <port>80</port>
      <nonProxyHosts>local.net|some.host.com</nonProxyHosts>
    </proxy>
    -->
  </proxies>

  <!-- servers
   | This is a list of authentication profiles, keyed by the server-id used within the system.
   | Authentication profiles can be used whenever maven must make a connection to a remote server.
   |-->
  <servers>
    <!-- server
     | Specifies the authentication information to use when connecting to a particular server, identified by
     | a unique name within the system (referred to by the 'id' attribute below).
     | 
     | NOTE: You should either specify username/password OR privateKey/passphrase, since these pairings are 
     |       used together.
     |
    <server>
      <id>deploymentRepo</id>
      <username>repouser</username>
      <password>repopwd</password>
    </server>
    -->
    
    <!-- Another sample, using keys to authenticate.
    <server>
      <id>siteServer</id>
      <privateKey>/path/to/private/key</privateKey>
      <passphrase>optional; leave empty if not used.</passphrase>
    </server>
    -->
  </servers>

  <!-- mirrors
   | This is a list of mirrors to be used in downloading artifacts from remote repositories.
   | 
   | It works like this: a POM may declare a repository to use in resolving certain artifacts.
   | However, this repository may have problems with heavy traffic at times, so people have mirrored
   | it to several places.
   |
   | That repository definition will have a unique id, so we can create a mirror reference for that
   | repository, to be used as an alternate download site. The mirror site will be the preferred 
   | server for that repository.
   |-->
  <mirrors>
    <!-- mirror
     | Specifies a repository mirror site to use instead of a given repository. The repository that
     | this mirror serves has an ID that matches the mirrorOf element of this mirror. IDs are used
     | for inheritance and direct lookup purposes, and must be unique across the set of mirrors.
     |
    <mirror>
      <id>mirrorId</id>
      <mirrorOf>repositoryId</mirrorOf>
      <name>Human Readable Name for this Mirror.</name>
      <url>http://my.repository.com/repo/path</url>
    </mirror>
     -->
  </mirrors>
  
  <!-- profiles
   | This is a list of profiles which can be activated in a variety of ways, and which can modify
   | the build process. Profiles provided in the settings.xml are intended to provide local machine-
   | specific paths and repository locations which allow the build to work in the local environment.
   |
   | For example, if you have an integration testing plugin - like cactus - that needs to know where
   | your Tomcat instance is installed, you can provide a variable here such that the variable is 
   | dereferenced during the build process to configure the cactus plugin.
   |
   | As noted above, profiles can be activated in a variety of ways. One way - the activeProfiles
   | section of this document (settings.xml) - will be discussed later. Another way essentially
   | relies on the detection of a system property, either matching a particular value for the property,
   | or merely testing its existence. Profiles can also be activated by JDK version prefix, where a 
   | value of '1.4' might activate a profile when the build is executed on a JDK version of '1.4.2_07'.
   | Finally, the list of active profiles can be specified directly from the command line.
   |
   | NOTE: For profiles defined in the settings.xml, you are restricted to specifying only artifact
   |       repositories, plugin repositories, and free-form properties to be used as configuration
   |       variables for plugins in the POM.
   |
   |-->
  <profiles>
    <!-- profile
     | Specifies a set of introductions to the build process, to be activated using one or more of the
     | mechanisms described above. For inheritance purposes, and to activate profiles via <activatedProfiles/>
     | or the command line, profiles have to have an ID that is unique.
     |
     | An encouraged best practice for profile identification is to use a consistent naming convention
     | for profiles, such as 'env-dev', 'env-test', 'env-production', 'user-jdcasey', 'user-brett', etc.
     | This will make it more intuitive to understand what the set of introduced profiles is attempting
     | to accomplish, particularly when you only have a list of profile id's for debug.
     |
     | This profile example uses the JDK version to trigger activation, and provides a JDK-specific repo.
    <profile>
      <id>jdk-1.4</id>

      <activation>
        <jdk>1.4</jdk>
      </activation>

      <repositories>
        <repository>
          <id>jdk14</id>
          <name>Repository for JDK 1.4 builds</name>
          <url>http://www.myhost.com/maven/jdk14</url>
          <layout>default</layout>
          <snapshotPolicy>always</snapshotPolicy>
        </repository>
      </repositories>
    </profile>
    -->

    <!--
     | Here is another profile, activated by the system property 'target-env' with a value of 'dev',
     | which provides a specific path to the Tomcat instance. To use this, your plugin configuration
     | might hypothetically look like:
     |
     | ...
     | <plugin>
     |   <groupId>org.myco.myplugins</groupId>
     |   <artifactId>myplugin</artifactId>
     |   
     |   <configuration>
     |     <tomcatLocation>${tomcatPath}</tomcatLocation>
     |   </configuration>
     | </plugin>
     | ...
     |
     | NOTE: If you just wanted to inject this configuration whenever someone set 'target-env' to
     |       anything, you could just leave off the <value/> inside the activation-property.
     |
    <profile>
      <id>env-dev</id>

      <activation>
        <property>
          <name>target-env</name>
          <value>dev</value>
        </property>
      </activation>

      <properties>
        <tomcatPath>/path/to/tomcat/instance</tomcatPath>
      </properties>
    </profile>
    -->
  

<profile>

                <id>adobe-public</id>

                <activation>

                    <activeByDefault>true</activeByDefault>

                </activation>

                <repositories>

                  <repository>

                    <id>adobe</id>

                    <name>Nexus Proxy Repository</name>

                    <url>http://repo.adobe.com/nexus/content/groups/public/</url>

                    <layout>default</layout>

                  </repository>

                </repositories>

                <pluginRepositories>

                  <pluginRepository>

                    <id>adobe</id>

                    <name>Nexus Proxy Repository</name>

                    <url>http://repo.adobe.com/nexus/content/groups/public/</url>

                    <layout>default</layout>

                  </pluginRepository>

                </pluginRepositories>

            </profile>

</profiles>

  <!-- activeProfiles
   | List of profiles that are active for all builds.
   |
  <activeProfiles>
    <activeProfile>alwaysActiveProfile</activeProfile>
    <activeProfile>anotherAlwaysActiveProfile</activeProfile>
  </activeProfiles>
  -->
</settings>

Create an archetype project 

You can create an Experiene Manager archetype project by using the Maven archetype plugin. In this example, assume that the working directory is C:\AdobeCQ. 

plugin1

To create an Experiene Manager archetype project, perform these steps:

1. Open the command prompt and go to your working directory (for example, C:\AdobeCQ).

2. Run the following Maven command:

mvn archetype:generate -DarchetypeRepository=https://repo.adobe.com/nexus/content/groups/public/ -DarchetypeGroupId=com.day.jcr.vault -DarchetypeArtifactId=multimodule-content-package-archetype -DarchetypeVersion=1.0.2 -DgroupId=com.adobe.lc.aem -DartifactId=claimlc -Dversion=1.0-SNAPSHOT -Dpackage=com.adobe.lc.aem -DappsFolderName=myproject -DartifactName="My Project" -DcqVersion="5.6.1" -DpackageGroup="My Company"

3. When prompted for additional information, specify Y.

4. Once done, you will see a message like:

[INFO] Finished at: Wed Mar 27 13:38:58 EDT 2013
[INFO] Final Memory: 10M/184M

5. Change the command prompt to the generated project. For example: C:\AdobeCQ\claimlc. Run the following Maven command:
mvn eclipse:eclipse

After you run this command, you can import the project into Eclipse as discussed in the next section.

Add Java files to the Maven project using Eclipse

To make it easier to work with the Maven generated project, import it into the Eclipse development environment, as shown in the following illustration. 

LCAEMPro

 

The next step is to add a Java file to the com.adobe.lc.aem package named HandleClaim. The Java class that you create in this section extends the Sling class named org.apache.sling.api.servlets.SlingAllMethodsServlet. This class supports the doPost method that lets you submit LiveCycle process data from the custom LiveCycle ES DSC. For information about this class, see Class SlingAllMethodsServlet.

The HandleClaim class uses Apache Felix SCR annotations to create the OSGi component. For information about Apache Felix SCR annotations, see http://felix.apache.org/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.html.

A ResourceResolverFactory instance is injected into the doPost method. This instance creates a Session instance that lets you persist data into the AEM JCR. To inject a ResourceResolverFactory instance, you use the @Reference annotation to define a class member, as shown in the following example.

//Inject a Sling ResourceResolverFactory
@Reference
private ResourceResolverFactory resolverFactory;

You invoke the ResourceResolver object's adaptTo method to create a Session object, as shown here.

//Persist the Data into the AEM JCR
//Invoke the adaptTo method to create a Session
ResourceResolver resourceResolver = resolverFactory.getAdministrativeResourceResolver(null);
session = resourceResolver.adaptTo(Session.class);

//Create a node that represents the root node
Node root = session.getRootNode();  

The Session object is used to retrieve JCR nodes and create new JCR nodes.  

Note:

When you open a JCR session, there is a reference to the JCR repository object. Every session will consume some memory unless the logout() method is called explicitly. If you do not call this call and create lots of sessions, you risk an out-of-memory exception by your JVM, which terminates the CQ instance. A single leaked session isn’t a problem, but if you have hundreds or thousands of leaked sessions, it might turn into a problem. For more information, see CQ development patterns – Sling ResourceResolver and JCR sessions

The HandleClaim Java class also uses a SlingServlet annotation:

@SlingServlet(paths="/bin/handleclaim", methods = "POST", metatype=true)

The paths property corresponds to the URL that you specify when using Java HTTP application logic to post process data. That is, to use Java application logic to post LiveCycle process data to this Sling Servlet, you create an URL object that maps to the path property in the SlingServlet annotation.  

//Specify the Sling Servlet URL

URL url = new URL("http://AEMServer:4502/bin/handleclaim");

HttpURLConnection conn = (HttpURLConnection)url.openConnection();
conn.setRequestMethod("POST");
conn.setRequestProperty("Authorization", "Basic " + encoding); // handles authentication with AEM
conn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
conn.setRequestProperty("Content-Length", String.valueOf(postDataBytes.length));
conn.setDoOutput(true);

 

Note:

The previous Java code was part of the LiveCycle ES DSC. The purpose of this code is to show you how the Java code located in the DSC maps to the Sling Servlet.  

The following Java code represents the HandleClaim class that extends org.apache.sling.api.servlets.SlingAllMethodsServlet.  This servlet persists the posted LiveCycle process data into the AEM JCR.

package com.adobe.cq.lc;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.HttpURLConnection;
import java.net.URL;
import java.rmi.ServerException;
import java.util.Dictionary;
  

import java.io.StringWriter;
import java.util.Iterator;
import java.util.List;
import java.util.ArrayList;

import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.sling.SlingServlet;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.SlingSafeMethodsServlet;
import org.apache.sling.commons.osgi.OsgiUtil;
import org.apache.sling.jcr.api.SlingRepository;
import org.apache.felix.scr.annotations.Reference;
import org.osgi.service.component.ComponentContext;
import javax.jcr.Session;
import javax.jcr.Node; 
import java.util.UUID;
 
import javax.jcr.Repository; 
import javax.jcr.SimpleCredentials; 
import javax.jcr.Node; 
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
   
import org.apache.jackrabbit.commons.JcrUtils;
  
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
  
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Service;
import javax.jcr.RepositoryException;
import org.apache.felix.scr.annotations.Reference;
import org.apache.jackrabbit.commons.JcrUtils;


import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
   
 
//Sling Imports
import org.apache.sling.api.resource.ResourceResolverFactory ; 
import org.apache.sling.api.resource.ResourceResolver; 
import org.apache.sling.api.resource.Resource; 
  
/**
 * This Custom Sling Servlet handles persists process data sent from a LiveCycle Custom DSC
 */


@SlingServlet(paths="/bin/handleclaim", methods = "POST", metatype=true)
public class HandleClaim extends org.apache.sling.api.servlets.SlingAllMethodsServlet {
     private static final long serialVersionUID = 2598426539166789515L;
       
     /** Default log. */
     protected final java.util.logging.Logger log = LoggerFactory.getLogger(this.getClass());
          
     //Inject a Sling ResourceResolverFactory
     @Reference
     private ResourceResolverFactory resolverFactory;
      
     private Session session;
     
     
     /*
      * Determines if the content/claim node exists 
      * This method returns these values:
      * -1 - if content/claim does not exist
      * 0 - if content/claim node exists; however, contains no children
      * number - the number of children that the content/claim node contains
     */
     private int doesClaimExist(Node content)
     {
    
    	 try
    	 {
    		 int index = 0 ; 
             int childRecs = 0 ; 
              
             java.lang.Iterable<Node> custNode = JcrUtils.getChildNodes(content, "claim");
             Iterator it = custNode.iterator();
             
             
             //only going to be 1 content/claim node if it exists
             if (it.hasNext())
                 {
                 //Count the number of child nodes in content/claim
                 Node claimRoot = content.getNode("claim");
                 Iterable itCust = JcrUtils.getChildNodes(claimRoot); 
                 Iterator childNodeIt = itCust.iterator();
                      
                 //Count the number of claim child nodes 
                 while (childNodeIt.hasNext())
                 {
                     childRecs++;
                     childNodeIt.next();
                 }
                  return childRecs; 
                }
             else
                 return -1; //content/claim does not exist
             
             
             
    	 }
        catch(Exception e)
        {
        	e.printStackTrace(); 
        }
         return 0;
      }    
       
                 
  @Override
  protected void doPost(SlingHttpServletRequest request, SlingHttpServletResponse response) throws ServerException, IOException {
	  
	    
	  int num  = 0;
 	 
	    try
	      {
	         //Get the submitted LC process data posted
	          String id = request.getParameter("id");
	          String firstName = request.getParameter("firstName");
	          String lastName = request.getParameter("lastName");
	          String address = request.getParameter("address");
	          String cat = request.getParameter("cat");
	          String state = request.getParameter("state");
	          String details = request.getParameter("details");
	          String date = request.getParameter("date"); 
	          String city = request.getParameter("city"); 
	           
	           
	          //Persist the Data into the AEM JCR
	          //Invoke the adaptTo method to create a Session 
	          ResourceResolver resourceResolver = resolverFactory.getAdministrativeResourceResolver(null);
	          session = resourceResolver.adaptTo(Session.class);
	                     
	          //Create a node that represents the root node
	          Node root = session.getRootNode(); 
	                           
	          //Get the content node in the JCR
	          Node content = root.getNode("content");
	                            
	          //Determine if the content/claim node exists
	          Node claimRoot = null;
	          
	          
	          int claimRec = doesClaimExist(content);
	          
	           //-1 means that content/claim does not exist
	          if (claimRec == -1)
	        	  //content/claim does not exist -- create it
	        	  claimRoot = content.addNode("claim","nt:unstructured");
	          else
	        	  //content/claim does exist -- retrieve it
	        	  claimRoot = content.getNode("claim");
            
	                 
	          //Store content posted from LiveCycle ES
	         Node claimNode = claimRoot.addNode("claim"+id +"_"+firstName +"_" +lastName, "nt:unstructured"); 
	                
	         //make sure name of node is unique
	         claimNode.setProperty("id", id); 
	         claimNode.setProperty("firstName", firstName); 
	         claimNode.setProperty("lastName", lastName); 
	         claimNode.setProperty("address", address);  
	         claimNode.setProperty("cat", cat);
	         claimNode.setProperty("state", state);
	         claimNode.setProperty("details", details);
	         claimNode.setProperty("date", date);
	         claimNode.setProperty("city", city);
	                                          
	        log.info("Process data has been added to content/claim"); 
	         
	         // Save the session changes and log out
	        session.save(); 
	        session.logout();
	        
	        //Return claim id
	        response.getWriter().write("claim"+firstName+lastName+id); 
	      }
	             
	       catch(Exception  e){
	           log.error("RepositoryException: " + e);
        }
    } 
  }

Modify the Maven POM file 

Modify the POM files to successfully build the OSGi bundle. In the POM file located at C:\AdobeCQ\claimlc\bundle, add the following dependencies.

  • org.apache.felix.scr
  • org.apache.felix.scr.annotations
  • org.apache.jackrabbit
  • org.apache.sling

The following XML represents this POM file.

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd ">
    <modelVersion>4.0.0</modelVersion>
    <!-- ====================================================================== -->
    <!-- P A R E N T P R O J E C T D E S C R I P T I O N -->
    <!-- ====================================================================== -->
    <parent>
        <groupId>com.adobe.cq.lc</groupId>
        <artifactId>claimlc</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <!-- ====================================================================== -->
    <!-- P R O J E C T D E S C R I P T I O N -->
    <!-- ====================================================================== -->

    <artifactId>claimlc-bundle</artifactId>
    <packaging>bundle</packaging>
    <name>LC AEM Bundle Bundle</name>

    <!-- ====================================================================== -->
    <!-- B U I L D D E F I N I T I O N -->
    <!-- ====================================================================== -->
    <build>

        <plugins>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-scr-plugin</artifactId>
                <executions>
                    <execution>
                        <id>generate-scr-descriptor</id>
                        <goals>
                            <goal>scr</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <extensions>true</extensions>
                <configuration>
                    <instructions>
                        <Bundle-SymbolicName>com.adobe.cq.lc.claimlc-bundle</Bundle-SymbolicName>
                    </instructions>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.sling</groupId>
                <artifactId>maven-sling-plugin</artifactId>
                <configuration>
                    <slingUrl>http://${crx.host}:${crx.port}/apps/adobe-training/install</slingUrl>
                    <usePut>true</usePut>
                </configuration>
            </plugin>
        </plugins>
    </build>

    <dependencies>
        
         <dependency>
            <groupId>org.apache.sling</groupId>
            <artifactId>org.apache.sling.api</artifactId>
            <version>2.2.4</version>
            <scope>provided</scope>
        </dependency>   
        
        
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.compendium</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.felix</groupId>
            <artifactId>org.apache.felix.scr.annotations</artifactId>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
           
        <dependency>
         <groupId>org.apache.felix</groupId>
    
         <artifactId>org.osgi.core</artifactId>
    
         <version>1.4.0</version>
      </dependency>
        
    <dependency>
        <groupId>org.apache.sling</groupId>
        <artifactId>org.apache.sling.commons.osgi</artifactId>
        <version>2.2.0</version>
    </dependency>
               
     
           
    <dependency>
    <groupId>org.apache.jackrabbit</groupId>
    <artifactId>jackrabbit-core</artifactId>
    <version>2.4.3</version>
    </dependency>
        
    <dependency>
    <groupId>org.apache.jackrabbit</groupId>
    <artifactId>jackrabbit-jcr-commons</artifactId>
    <version>2.4.3</version>
    </dependency>
    
    <dependency>
        <groupId>org.apache.sling</groupId>
        <artifactId>org.apache.sling.jcr.api</artifactId>
        <version>2.0.4</version>
      </dependency>
 
       <dependency>
        <groupId>org.apache.sling</groupId>
        <artifactId>org.apache.sling.api</artifactId>
        <version>2.0.2-incubator</version>
      </dependency>    
          
      <dependency>
         <groupId>javax.jcr</groupId>
         <artifactId>jcr</artifactId>
         <version>2.0</version>
      </dependency>
 
	<dependency>
    	<groupId>javax.servlet</groupId>
    	<artifactId>servlet-api</artifactId>
    	<version>2.5</version>
	</dependency>
             
    <dependency>
            <groupId>com.day.cq.wcm</groupId>
            <artifactId>cq-wcm-api</artifactId>
            <version>5.5.0</version>
            <scope>provided</scope>
    </dependency>
         
    <dependency>
            <groupId>com.day.cq</groupId>
            <artifactId>cq-commons</artifactId>
            <version>5.5.0</version>
            <scope>provided</scope>
     </dependency>
     
     
     <dependency>
            <groupId>org.apache.sling</groupId>
            <artifactId>org.apache.sling.api</artifactId>
            <version>2.2.4</version>
            <scope>provided</scope>
        </dependency>
         
      <dependency>
         <groupId>javax.jcr</groupId>
         <artifactId>jcr</artifactId>
         <version>2.0</version>
      </dependency>
       
       <dependency>
            <groupId>com.day.cq.wcm</groupId>
            <artifactId>cq-wcm-api</artifactId>
            <version>5.5.0</version>
            <scope>provided</scope>
        </dependency>
         
        <dependency>
            <groupId>com.day.cq</groupId>
            <artifactId>cq-commons</artifactId>
            <version>5.5.0</version>
            <scope>provided</scope>
        </dependency>
               
     
               
    </dependencies>
     
    <repositories>
        <repository>
            <id>adobe</id>
            <name>Adobe Public Repository</name>
            <url>http://repo.adobe.com/nexus/content/groups/public/</url>
            <layout>default</layout>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>adobe</id>
            <name>Adobe Public Repository</name>
            <url>http://repo.adobe.com/nexus/content/groups/public/</url>
            <layout>default</layout>
        </pluginRepository>
    </pluginRepositories>       
      
</project>

Build the OSGi bundle using Maven

Build the OSGi bundle by using Maven. When Maven builds the bundle, it also creates a  serviceComponents.xml file based on the annotations that are included in the com.adobe.cq.lc.HandleClaim class. The following XML represents this file.

<?xml version="1.0" encoding="UTF-8"?>
<components xmlns:scr="http://www.osgi.org/xmlns/scr/v1.0.0">
    <scr:component enabled="true" name="com.adobe.cq.lc.SimpleDSComponent">
        <implementation class="com.adobe.cq.lc.SimpleDSComponent"/>
        <service servicefactory="false">
            <provide interface="java.lang.Runnable"/>
        </service>
        <property name="service.pid" value="com.adobe.cq.lc.SimpleDSComponent"/>
    </scr:component>
    <scr:component enabled="true" name="com.adobe.cq.lc.HandleClaim">
        <implementation class="com.adobe.cq.lc.HandleClaim"/>
        <service servicefactory="false">
            <provide interface="javax.servlet.Servlet"/>
        </service>
        <property name="sling.servlet.paths" value="/bin/handleclaim"/>
        <property name="sling.servlet.methods" value="POST"/>
        <property name="service.pid" value="com.adobe.cq.lc.HandleClaim"/>
        <reference name="resolverFactory" interface="org.apache.sling.api.resource.ResourceResolverFactory" cardinality="1..1" policy="static" bind="bindResolverFactory" unbind="unbindResolverFactory"/>
    </scr:component>
</components>

Notice that the implementation class element specifies com.adobe.cq.lc.HandleClaim. This lines up with the Java class that extends org.apache.sling.api.servlets.SlingAllMethodsServlet that was created in an earlier step.

To build the OSGi component by using Maven, perform these steps:

  1. Open the command prompt and go to the C:\AdobeCQ\claimlc folder.
  2. Run the following maven command: mvn clean install.
  3. The OSGi component can be found in the following folder: C:\AdobeCQ\claimlc\bundle\target. The file name of the OSGi component is claimlc-bundle-1.0-SNAPSHOT.jar.

Deploy the bundle to Experience Manager

Once you deploy the OSGi bundle, you can post process data to the Sling Servlet  from a LiveCycle ES process (this is shown later in this development article). After you deploy the OSGi bundle, you can see it in the Apache Felix Web Console.

osgi

Deploy the OSGi bundle that contains the Sling Servlet by performing these steps:

  1. Login to Apache Felix Web Console at http://server:port/system/console/bundles (default admin user = admin with password= admin).
  2. Click the Bundles tab, sort the bundle list by Id, and note the Id of the last bundle.
  3. Click the Install/Update button.
  4. Browse to the bundle JAR file you just built using Maven. (C:\AdobeCQ\claimlc\bundle\target).
  5. Click Install.
  6. Click the Refresh Packages button.
  7. Check the bundle with the highest Id.
  8. Click Active.
  9. Your new bundle should now be listed with the status Active.
  10. If the status is not Active, check the error.log for exceptions. 

Invoke the LiveCycle ES Process

Invoke the process by using Workbench ES. To invoke the process, right click the proces name in the Applications window and select Invoke, as shown here.  

InvokeWB


After you invoke the process, you can view the process data in CRXDE Lite. The data is located under content/claim, as shown here.

 

node

See also

Congratulations, you have just created an AEM custom sling servlet that accepts LiveCycle ES process data by using an Adobe Maven Archetype project. Please refer to the AEM community page for other articles that discuss how to build AEM services/applications by using an Adobe Maven Archetype project.

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy