Article summary

Summary

Discusses how to create an Adobe Experience Manager application that is able to query data from the JCR and display the data in a chart. This article creates an OSGi bundle that uses the JCR Query API to query. In addition, discusses how to invoke an OSGi bundle operation from the client web page.

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.

Digital Marketing Solution(s) Adobe Experience Manager (Adobe CQ)
Audience
Developer (intermediate)
Required Skills
Java, JQuery, JCR SQL-JCR, CSS
Tested On Adobe Experience Manager 5.5, 5.6

Introduction

You can create an Adobe Experience Manager component that displays data queried from the Experience Manager JCR in a chart.  Assume, for example, that you want to display financial data queried from the Experience Manager JCR in a chart. In this situation, you can create a component that uses a JQuery chart library that displays result data in a chart.

chartdata

 

Each data point that is displayed is stored as a customer node's property named revenue, as shown in the following illustration.

custData

 

In this example, AEM data is queried from the JCR by using the JCR API within an OSGi bundle. The data is returned to the web page where it is displayed within a chart. This development article walks you through how to develop this AEM component.

To simplify the way customer data is persisted, customer data is stored as nt:unstructured nodes under /content/customer.

Note:

Before following along with this development article, create ten customer nodes of type nt:unstructured under /content/customer. Ensure that each node has two properties named desc and revenue. The desc property is a String whose value is Active Customer. The revenue property can contain a String value between 1-15.  

Application logic that queries data from the JCR 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.

Create an AEM application folder structure 

Create an AEM application folder structure that contains templates, components, and pages by using CRXDE Lite.

CQAppSetup

The following describes each application folder:

  • application name: contains all of the resources that an application uses. The resources can be templates, pages, components, and so on.
  • components: contains components that your application uses. 
  • page: contains page components. A page component is a script such as a JSP file. 
  • global: contains global components that your application uses.
  • template: contains templates on which you base page components. 
  • src: contains source code that comprises an OSGi component (this development article does not create an OSGi bundle using this folder). 
  • install: contains a compiled OSGi bundles container.

To create an AEM application folder structure:

  1. To view the welcome page, enter the URL http://[host name]:[port] into a web browser. For example, http://localhost:4502.
  2. Select CRXDE Lite (if you are using AEM 5.6, click Tools from the left menu). 
  3. Right-click the apps folder (or the parent folder), select Create, Create Folder.
  4. Enter the folder name into the Create Folder dialog box. Enter chart
  5. Repeat steps 1-4 for each folder specified in the previous illustration. 
    Click the Save All button.

Note:

You have to click the Save All button when working in CRXDE Lite for the changes to be made.

Create a template

You can create a template by using CRXDE Lite. A template enables you to define a consistent style for the pages in your application. A template comprises of nodes that specify the page structure. For more information about templates, see Templates.

To create a template, perform these tasks:

1. To view the welcome page, enter the URL http://[host name]:[port] into a web browser. For example, http://localhost:4502.

2. Select CRXDE Lite (if you are using AEM 5.6, click Tools from the left menu).

3. Right-click the template folder (within your application), select Create, Create Template.

4. Enter the following information into the Create Template dialog box:

  • Label: The name of the template to create. Enter templateChart
  • Title: The title that is assigned to the template.
  • Description: The description that is assigned to the template.
  • Resource Type: The component's path that is assigned to the template and copied to implementing pages. Enter chart/components/page/templateChart.
  • Ranking: The order (ascending) in which this template will appear in relation to other templates. Setting this value to 1 ensures that the template appears first in the list.

5. Add a path to Allowed Paths. Click on the plus sign and enter the following value: /content(/.*)?.

6. Click Next for Allowed Parents.

7. Select OK on Allowed Children.

Create a render component that uses the template 

Components are re-usable modules that implement specific application logic to render the content of your web site. You can think of a component as a collection of scripts (for example, JSPs, Java servlets, and so on) that completely realize a specific function. In order to realize this functionality, it is your responsibility as a developer to create scripts that perform specific functionality. For more information about components, see Components.

By default, a component has at least one default script, identical to the name of the component. To create a render component, perform these tasks:

1. To view the welcome page, enter the URL http://[host name]:[port] into a web browser. For example, http://localhost:4502.

2. Select CRXDE Lite (if you are using AEM 5.6, click Tools from the left menu).

3. Right-click /apps/chart/components/page, then select Create, Create Component.

4. Enter the following information into the Create Component dialog box:

  • Label: The name of the component to create. Enter templateChart
  • Title: The title that is assigned to the component.
  • Description: The description that is assigned to the template.

5. Select Next for Advanced Component Settings and Allowed Parents.

6. Select OK on Allowed Children.

7. Open the templateQueryjsp located at: /apps/chart/components/page/templateChart/templateChart.jsp.

8. Enter the following JSP code.
 

<html>
<head>
<title>Hello World !!!</title>
</head>
<body>
<h1>Hello JCR!!!</h1>
<h2>This page will query the AEM JCR and plot the data</h2>
</body>
</html>

Setup Maven in your development environment 

You can use Maven to build an OSGi bundle that uses the JCR API and is deployed to Experience Manager. 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:

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 Adobe Experience Manager archetype project 

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

Maven

To create an Experience 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.cq.chart -DartifactId=chart -Dversion=1.0-SNAPSHOT -Dpackage=com.adobe.cq.chart -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\chart. 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.

chartexclipse

 

The next step is to add Java files to the com.adobe.cq.chart package. The Java files that you create in this section use the Java JCR API. For information, see http://www.day.com/maven/jsr170/javadocs/jcr-2.0/overview-summary.html.

Add the following Java files to the com.adobe.cq.chart package:

  • A Java class named Customer that stores customer information.
  • A Java interface named CustomerService.
  • A Java class named CustomerServiceImp that implements the CustomerService interface.

Customer class

The following code represents the Customer class that is used to store customer information. This class contains getter and setter methods that modify class members.  

package com.adobe.cq.chart;

//This bean holds customer information
public class Customer {
     
//Define private class members
private String custId ;
private String revenue; // this value will be plotted in an AEM web page 
      
public void setCustId(String id)
{
    this.custId = id; 
}
     
public String getCustId()
{
    return this.custId;
}
     
public void setRev(String rev)
{
    this.revenue = rev; 
}
     
public String getRev()
{
    return this.revenue;
}
  
  
 
}

CustomerService interface 

The following code represents the CustomerService interface. This interface contains a method named getCustRevenue. The implementation logic for this method is located in the CustomerServiceImp class. The getCustRevenue method uses the JCR API to query customer nodes revenue property from the AEM JCR.

The following Java code represents the CustomerService interface.  

package com.adobe.cq.chart;

import org.w3c.dom.Document;

public interface CustomerService {
     
    //Retrieves customer data from the AEM JCR
    public String getCustRevenue(); 
      
}

CustomerServiceImp class

The CustomerServiceImp class uses the following Apache Felix SCR annotations to create the OSGi component:

  • @Component – defines the class as a component
  • @Service - defines the service interface that is provided by the component
  • @Reference – injects a service into the component. 

In this development article, a ResourceResolverFactory instance is injected into the getCustRevenue method. This instance is required to create a Session instance that lets you query 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;

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

//Queries the AEM JCR for customer revenue data and returns
//the data within an XML schema  - it is plotted in the client web page 
public String getCustRevenue() {
 
Customer cust = null;
 
List<Customer> custList = new ArrayList<Customer>();
try {
           
    //Invoke the adaptTo method to create a Session used to create a QueryManager
    ResourceResolver resourceResolver = resolverFactory.getAdministrativeResourceResolver(null);
    session = resourceResolver.adaptTo(Session.class);

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 getCustRevenue method returns an XML schema that contains revenue data within a string. The JCR Query API is used to query the AEM JCR. The JCR query is setup to query all customer nodes. This is achieved by querying the desc propery of all nt:unstructured nodes and seaching for the string value Customer

//Obtain the query manager for the session ...
javax.jcr.query.QueryManager queryManager = session.getWorkspace().getQueryManager();
          
//Setup the query to get all customer records
String sqlStatement = "SELECT * FROM [nt:unstructured] WHERE CONTAINS(desc, 'Customer')";
         
javax.jcr.query.Query query = queryManager.createQuery(sqlStatement,"JCR-SQL2");
 
//Execute the query and get the results ...
javax.jcr.query.QueryResult result = query.execute();
 
//Iterate over the nodes in the results ...
javax.jcr.NodeIterator nodeIter = result.getNodes();
 
while ( nodeIter.hasNext() ) {
 
    	//For each node-- create a customer instance
    	cust = new Customer();
         
    	javax.jcr.Node node = nodeIter.nextNode();
           
    	//Set all Customer revenue fields
    	cust.setRev(node.getProperty("revenue").getString());
    	           
    	//Push Customer to the list
    	custList.add(cust);
    }

The following Java code represents the CustomerServiceImp class. For each customer node that is retrieved from the AEM JCR, a new Customer object is created and stored in an ArrayList. The revenue property from each Customer object is retrieved from the ArrayList and stored in an XML schema by calling the toXML method. The XML schema is converted to a string that is used as the return value for getCustomerData.

package com.adobe.cq.chart;

import org.w3c.dom.Document;
import org.w3c.dom.Element;
  
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
  
import java.io.StringWriter;
import java.util.Iterator;
import java.util.List;
import java.util.ArrayList;
  
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 javax.jcr.Session;
import javax.jcr.Node; 
 
 
//Sling Imports
import org.apache.sling.api.resource.ResourceResolverFactory ; 
import org.apache.sling.api.resource.ResourceResolver; 
import org.apache.sling.api.resource.Resource; 
  
  
//This is a component so it can provide or consume services
@Component
  
@Service
public class CustomerServiceImpl implements CustomerService {
  
  
/** Default log. */
protected final Logger log = LoggerFactory.getLogger(this.getClass());
      
private Session session;
          
//Inject a Sling ResourceResolverFactory
@Reference
private ResourceResolverFactory resolverFactory;
      
 
 
//Queries the AEM JCR for customer revenue data and returns
//the data within an XML schema  - it is plotted in the client web page 
public String getCustRevenue() {
 
Customer cust = null;
 
List<Customer> custList = new ArrayList<Customer>();
try {
           
    //Invoke the adaptTo method to create a Session used to create a QueryManager
    ResourceResolver resourceResolver = resolverFactory.getAdministrativeResourceResolver(null);
    session = resourceResolver.adaptTo(Session.class);
 
    //Obtain the query manager for the session ...
    javax.jcr.query.QueryManager queryManager = session.getWorkspace().getQueryManager();
          
    //Setup the query to get all customer records
    String sqlStatement = "SELECT * FROM [nt:unstructured] WHERE CONTAINS(desc, 'Customer')";
         
    javax.jcr.query.Query query = queryManager.createQuery(sqlStatement,"JCR-SQL2");
 
    //Execute the query and get the results ...
    javax.jcr.query.QueryResult result = query.execute();
 
    //Iterate over the nodes in the results ...
    javax.jcr.NodeIterator nodeIter = result.getNodes();
 
    while ( nodeIter.hasNext() ) {
 
    	//For each node-- create a customer instance
    	cust = new Customer();
         
    	javax.jcr.Node node = nodeIter.nextNode();
           
    	//Set all Customer revenue fields
    	cust.setRev(node.getProperty("revenue").getString());
    	           
    	//Push Customer to the list
    	custList.add(cust);
    }
         
    // Log out
    session.logout();    
    return convertToString(toXml(custList));               
             
}
catch(Exception e)
{
 e.printStackTrace();
}
return null;
}
 
     
//Convert Customer rev data retrieved from the AEM JCR
//into an XML schema to pass back to client - where it's placed in a chart
private Document toXml(List<Customer> custList) {
try
{
    DocumentBuilderFactory factory =     DocumentBuilderFactory.newInstance();
    DocumentBuilder builder = factory.newDocumentBuilder();
    Document doc = builder.newDocument();
                  
    //Start building the XML to pass back to the AEM client
    Element root = doc.createElement( "Customers" );
    doc.appendChild( root );
               
    //Get the elements from the collection
    int custCount = custList.size();
     
    //Iterate through the collection to build up the DOM           
     for ( int index=0; index < custCount; index++) {
  
         //Get the Customer object from the collection
         Customer myCust = (Customer)custList.get(index);
                       
         Element Customer = doc.createElement( "Customer" );
         root.appendChild( Customer );
                        
         //Add rest of data as child elements to customer
         //Set First Name
         Element rev = doc.createElement( "rev" );
         rev.appendChild( doc.createTextNode(myCust.getRev() ) );
         Customer.appendChild( rev );
                                      
        
      }
             
return doc;
}
catch(Exception e)
{
    e.printStackTrace();
    }
return null;
}
  
  
private String convertToString(Document xml)
{
try {
   Transformer transformer = TransformerFactory.newInstance().newTransformer();
  StreamResult result = new StreamResult(new StringWriter());
  DOMSource source = new DOMSource(xml);
  transformer.transform(source, result);
  return result.getWriter().toString();
} catch(Exception ex) {
      ex.printStackTrace();
}
  return null;
 }
 
 }

Modify the Maven POM file 

Modify the POM files to successfully build the OSGi bundle. In the POM file located at C:\AdobeCQ\chart\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.chart</groupId>
        <artifactId>chart</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>chart-bundle</artifactId>
    <packaging>bundle</packaging>
    <name>AEM Chart 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.chart.chart-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/chart-aemtraining/install</slingUrl>
                    <usePut>true</usePut>
                </configuration>
            </plugin>
        </plugins>
    </build>

    <dependencies>
        <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>org.apache.felix</groupId>
   
         <artifactId>org.osgi.core</artifactId>
   
         <version>1.4.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>junit</groupId>
            <artifactId>junit</artifactId>
        </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 you build the OSGi bundle, Maven creates the required serviceComponents.xml file based on the annotations that are included in the CustomerServiceImp 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.chart.CustomerServiceImpl">
        <implementation class="com.adobe.cq.chart.CustomerServiceImpl"/>
        <service servicefactory="false">
            <provide interface="com.adobe.cq.chart.CustomerService"/>
        </service>
        <property name="service.pid" value="com.adobe.cq.CustomerServiceImpl"/>
        <reference name="resolverFactory" interface="org.apache.sling.api.resource.ResourceResolverFactory" cardinality="1..1" policy="static" bind="bindResolverFactory" unbind="unbindResolverFactory"/>
    </scr:component>
</components>

There are a couple of points to note about this XML file. First, notice that the implementation class element specifies com.adobe.cq.chart.CustomerServiceImpl. The service element contains an interface attribute that specifies com.adobe.cq.chart.CustomerService. This lines up with the Java interface that was created in an earlier step.

In order for the service injection to work, the reference element must be configured correctly. In this example, notice that name of the reference is resolverFactory. Also notice that it’s based on org.apache.sling.api.resource.ResourceResolverFactory

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

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

Deploy the bundle to Adobe Experience Manager

Once you deploy the OSGi bundle, you are able to invoke the getCustRevenue method defined in the CustomerServiceImpl class (this is shown later in this development article). After you deploy the OSGi bundle, you will be able to see it in the Apache Felix Web Conole.

osgi

Deploy the OSGi bundle by performing these steps:

  1. Login to the 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\chart\bundle\target).
  5. Click Install.
  6. Click the Refresh Packages button.
  7. Check the bundle with the highest Id.
  8. Click Active. Your new bundle should now be listed with the status Active.
  9. If the status is not Active, check the CQ error.log for exceptions.

 

Add CSS and JQuery files to a CQ:ClientLibraryFolder node 

You add CSS files and JQuery framework files to a cq:ClientLibraryFolder node to define the style of the client JSP. The JQuery framework file that is added is named jquery-1.7.2.min.js.

In addition to the JQuery framework file, a chart JQuery plugin is used in this AEM application named flot. This chart plugin is used to plot the customer revenue data in the CQ web page. Download the flot JQuery plugin from the following URL:

http://www.flotcharts.org/

Download and extract the flot archive file. The client AEM application uses these files from the Flop archive file:

  • jquery.flot.axislabels.js
  • jquery.flot.orderBars.js
  • jquery.flot.js

To add JQuery files to your component, add a cq:ClientLibraryFolder node to your component. After you create the node, set properties that allow the JSP script to find the CSS files and the JQuery library files.

To add the JQuery framework, add a new node named clientlibs to your component. Add these two properties to this node.

Name Type Value
dependencies String[] cq.jquery
categories String[] jquerysamples 

The dependencies property informs CQ to include the JQuery libraries in the page. The categories property informs CQ which clientlibs must be included.

After you create the Clientlibs folder, add the JQuery library files, and a map text file named js.txt. The js.txt file contains the JS file names: jquery-1.7.2.min.js, jquery.flot.axislabels.js, jquery.flot.orderBars.js, and jquery.flot.js.

Add the files to the ClientLibs folder

  1. Right-click /apps/chart/components then select New, Node.
  2. Make sure that the node type is cq:ClientLibraryFolder and name the node clientlibs.
  3. Right click on clientlibs and select Properties. Add the two properties specified in the previous table to the node.
  4. On your file system, navigate to the folder where the JQuery JS files are located. Drag and drop the JS files to the clientlibs node by using CRXDE.
  5. Add a TXT file to the clientlibs folder named js.txt. Add the content specified in this section.

Modify the Client JSP to invoke the getCustomerData method 

To create the AEM client that queries data from the JCR, create these files:

  • query.json.jsp: contains application logic that calls the OSGi bundle's getCustRevenue method.
  • templateChart.jsp: contains application logic that defines the JSP that displays revenue data in a chart control (flot control).

Create the query.json.jsp 

Add a new JSP file named query.json.jsp to the following CQ path:

/apps/jcrquery/components/page/templateQuery

In query.json.jsp, you create a CustomerService instance by using the sling.getService method, as shown in the following example:

com.adobe.cq.chart.CustomerService cs = sling.getService(com.adobe.cq.chart.CustomerService.class);

You pass the fully qualified name of the service to sling.getService method. Because the OSGi bundle is a managed component that injects a ResourceResolverFactory into the service, you must use the sling.getService method to create a CustomerService object. If you attempt to create a CustomerService using the new operation, the OSGi bundle is not considered a managed component and will not successfully inject a ResourceResolverFactory instance. A Java null pointer exception is thrown.

After you create a CustomerService object by using sling.getService, you can invoke the getCustRevenue method exposed by the service.  

The following code represents the query.json.jsp file.
 

<%@include file="/libs/foundation/global.jsp"%>
<%@ page import="org.apache.sling.commons.json.io.*,org.w3c.dom.*" %><%
String filter = request.getParameter("filter");
  
com.adobe.cq.chart.CustomerService cs = sling.getService(com.adobe.cq.chart.CustomerService.class);
  
String XML = cs.getCustRevenue() ; 
   
//Send the data back to the client 
JSONWriter writer = new JSONWriter(response.getWriter());
writer.object();
writer.key("xml");
writer.value(XML);
  
writer.endObject();
%>

In this code example, notice that a JSONWriter instance is created. This object returns XML that contains customer revenue information to the main JSP client after the call to the OSGi bundle is made. The client JSP parses the XML and displays the revenue customer data in a chart control.  

Modify the templateChart.jsp

Modify the templateChart.jsp file to call the query.json.jsp. In this example, a JQuery Ajax HTTP request is used.  

$.ajax(url, {
        dataType: "text",
        success: function(rawData, status, xhr) {
            var data;
            try {
                data = $.parseJSON(rawData);
                  
                //Set the fields in the forum
                var myXML = data.xml;
 
                 //Loop through this function for each Customer element
                 //in the returned XML
                 var index = 0 ; //track the index of the chart
                 var revdata = []; 
                 $(myXML).find('Customer').each(function(){
                         
                    var $field = $(this);
                    var revenue = $field.find('rev').text();

                  //Populate the array - whose values are plotted in the chart
                    revdata.push([index,revenue]); //push the data into the array
         
                    //increment index
                    index++; 
              });

             //plot the revenue data   
                 $.plot($("#placeholder"), [
                                            {
                                                data: revdata,
                                                bars: {
                                                    show: true
                                                }
                                            }
                                        ]); 
     
            } catch(err) {
                failure(err);
            }
        },
        error: function(xhr, status, err) {
            failure(err);
        } 
    });

Notice that for each Customer element in the returned XML, the revenue value is retrieved and added to a data array. This data array is used to populate the chart control.   

The following code represents the entire TemplateChart.jsp file.  

<%@include file="/libs/foundation/global.jsp"%>
<cq:includeClientLib categories="jquerysamples" />
<html>
<head>
<title>Plots AEM Data !!!</title>
 
 
 <style type="text/css">
body { font-family: Verdana, Arial, sans-serif; font-size: 12px; }
h1 { width: 450px; margin: 0 auto; font-size: 12px; text-align: center; }
#placeholder {
    width: 450px;
    height: 200px;
}
.legend table, .legend > div { height: 82px !important; opacity: 1 !important; right: -55px; top: 10px; width: 116px !important; }
.legend table { border: 1px solid #555; padding: 5px; }
#flot-tooltip { font-size: 12px; font-family: Verdana, Arial, sans-serif; position: absolute; display: none; border: 2px solid; padding: 2px; background-color: #FFF; opacity: 0.8; -moz-border-radius: 5px; -webkit-border-radius: 5px; -khtml-border-radius: 5px; border-radius: 5px; }
</style>
 
<script>
$(document).ready(function() {
    $('body').hide().fadeIn(5000);

    //Make an AJAX call to the OSGi bundle to plot the revenue data
    var url = location.pathname.replace(".html", "/_jcr_content.query.json") ;
        
$.ajax(url, {
        dataType: "text",
        success: function(rawData, status, xhr) {
            var data;
            try {
                data = $.parseJSON(rawData);
                  
                //Set the fields in the forum
                var myXML = data.xml;
 
                 //Loop through this function for each Customer element
                 //in the returned XML
                 var index = 0 ; //track the index of the chart
                 var revdata = []; 
                 $(myXML).find('Customer').each(function(){
                         
                    var $field = $(this);
                    var revenue = $field.find('rev').text();

                  //Populate the array - whose values are plotted in the chart
                    revdata.push([index,revenue]); //push the data into the array
         
                    //increment index
                    index++; 
              });

             //plot the revenue data   
                 $.plot($("#placeholder"), [
                                            {
                                                data: revdata,
                                                bars: {
                                                    show: true
                                                }
                                            }
                                        ]); 
     
            } catch(err) {
                failure(err);
            }
        },
        error: function(xhr, status, err) {
            failure(err);
        } 
    });
    
      
});
</script>


</head>
<body>
<h2>This page dynamically displays AEM data in a chart</h2>


    <div id="placeholder"></div>

</body>
</html>

Modify the templateQuery file

  1. To view the welcome page, enter the URL: http://[host name]:[port] into a web browser. For example, http://localhost:4502.
  2. Select CRXDE Lite. (If you are using AEM 5.6, click Tool in the left menu)
  3. Double-click apps/chart/components/page/templateChart/templateChart.jsp.
  4. Replace the JSP code with the new code shown in this section.
  5. Click Save All.

Create an AEM web page that displays AEM data in a chart 

The final task is to create a site that contains a page that is based on the templateChart (the template created earlier in this development article). When the page loads, the ajax call in the templateChart page is made and customer revenue data is returned. The returned data is displayed in the chart control. 

Create a AEM web page that displays AEM data in a chart.

  1. Go to the Websites page at http://localhost:4502/siteadmin#/content.
  2. Select New Page.
  3. Specify the title of the page in the Title field.
  4. Specify the name of the page in the Name field.
  5. Select templateChart from the template list that appears. This value represents the template that is created in this development article. If you do not see it, then repeat the steps in this development article. For example, if you made a typing mistake when entering in path information, the template will not show up in the New Page dialog box.
  6. Open the new page that you created by double-clicking it in the right pane. The new page opens in a web browser. You should see a page similar to the illustration shown at the start of this article.

See also  

Congratulations, you have just created an AEM OSGi bundle 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