Article Summary

Summary

Discusses how to create an OSGi bundle that contains the AEM Query Builder API. This OSGi operation contains application logic to search the AEM repository. This article also discusses how to create a web page that invokes an operation exposed by the OSGi bundle and display the results in a grid control.

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 article has been updated to replace the use of a SlingRepository instance with a ResourceResolverFactory instance. The ResourceResolverFactory is used to create a Session instance that is required to use the AEM Query Builder API. Now a Session instance is created by using the adaptTo method:

resourceResolver.adaptTo(Session.class);

Digital Marketing Solution(s) Adobe Experience Manager (Adobe CQ)
Audience
Developer (intermediate)
Required Skills
Java, JQuery, AJAX, CSS, Maven, JSON, HTML
Version(s) Adobe Experience Manager 5.x, 6.x

Note:

You can download an AEM package that contains code and the OSGi bundle that are used in this article. Download the package and deploy using package manager. The purpose of this code is to show the community these concepts in action. That is, it's to illustrate how to write an AEM application that uses the QueryBuilder API. This community code is for teaching purposes only and not meant to go into production as is.You can view the application by using the following URL: http://localhost:4502/content/QueryApp.html (assuming you deploy on author). 

Download

Introduction

You can create an Adobe Experience Manager application that searches the Experience Manager repository for assets and displays results to the end user. For example, you can search pages under a specific repository node (for example, nodes under /content) and look for a specific search term. All content that satisfies the search criteria are included in the search results. To search the Experience Manager repository, you use the Experience Manager Query Builder API. This API requires that you define search parameters, and an optional filter. After you execute the query, the results are stored in a result set. You can display the result set in an Experience Manager web page. 

When working with the Query Builder API, you can use a Java API or a Restful API. This development article uses the Experience Manager Query Builder Java API within an OSGi bundle to perform searches.

Search
A user specifies search criteria and the Experience Manager repository is searched

The server-side query builder (QueryBuilder) accepts a query description, creates and runs a query. For example, you can search pages located under /content using the search term: "Geometrixx". The following illustration shows the result set for this query.

App
Results produced by using the Query Builder API

The query description is simply a set of predicates (Predicate). Examples include a full-text predicate, which corresponds to the jcr:contains() function in XPath, and an image size predicate that looks for width and height properties in the DAM asset subtree.

For each predicate type, there is an evaluator component (PredicateEvaluator) that knows how to handle that specific predicate for XPath, filtering, and facet extraction. It is very easy to create custom evaluators, which are plugged-in through the OSGi component runtime.

The REST API provides access to exactly the same features through HTTP with responses being sent in JSON.

For more information about the Experience Manager Query Builder API, see Query Builder API.

This development article walks you through how to build an OSGi bundle that uses the Query Builder API and searches the Experience Manager repository. 

Note:

Instead of using the Query Builder API to search the AEM JCR, you can also use the JCR API. For details, see Querying Adobe Experience Manager Data using the JCR API.

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. Go to CRXDE Lite at http://localhost:4502/crx/de/index.jsp
  2. Right-click the apps folder (or the parent folder), select Create, Create Folder.
  3. Enter the folder name into the Create Folder dialog box. Enter queryBuilder
  4. Repeat steps 1-4 for each folder specified in the previous illustration. 
  5. 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 CQ 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. Go to CRXDE Lite at http://localhost:4502/crx/de/index.jsp.

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

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

  • Label: The name of the template to create. Enter templateQueryBuilder
  • 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 queryBuilder/components/page/templateQueryBuilder.
  • 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.

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

5. Click Next for Allowed Parents.

6. 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 an AEM 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. Go to CRXDE Lite at http://localhost:4502/crx/de/index.jsp.

2. Right-click /apps/queryBuilder/components/page, then select Create, Create Component.

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

  • Label: The name of the component to create. Enter templateQueryBuilder
  • Title: The title that is assigned to the component.
  • Description: The description that is assigned to the template.
  • Super Type: foundation/components/page 

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

5. Select OK on Allowed Children.

6. Open the templateQueryjsp located at: /apps/queryBuilder/components/page/templateQueryBuilder/templateQueryBuilder.jsp.

7. Enter the following JSP code.
 

<html>
<head>
<title>Hello World !!!</title>
</head>
<body>
<h1>Hello Query Builder API!!!</h1>
<h2>This page will query the AEM JCR using the Query Builder API</h2>
</body>
</html>

Setup Maven in your development environment 

You can use Maven to build an OSGi bundle that uses the QueryBuilder 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=custom.querybuilder -DartifactId=querybuilder -Dversion=1.0-SNAPSHOT -Dpackage=custom.querybuilder -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] Final Memory: 10M/184M

5. Change the command prompt to the generated project. For example: C:\AdobeCQ\querybuilder. 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. 

MavenProject

 

The next step is to add Java files to the custom.querybuilder package. The Java files that you create in this section use the QueryBuilder API. For information, see Interface QueryBuilder.

Add the following Java files to the package named custom.querybuilder:

  • A Java interface named SearchService.
  • A Java class named SearchServiceImpl that implements the SearchService interface.

The following illustration shows the Java files in this project.

java

SearchService interface

The following code represents the SearchService interface that contains a method named SearchCQForContent. The implementation logic for this method is located in the SearchServiceImpl class. This method uses the QueryBuilder API to search the AEM JCR.

package custom.querybuilder;

public interface SearchService {
	
	public String SearchCQForContent(); 

}

SearchServiceImpl class 

The SearchServiceImp 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
Ensure that you place this class in the custom.querybuilder.impl package, as shown in the previous illustration. 

Note:

For information about Apache Felix SCR annotations, see http://felix.apache.org/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.html

In this development article, a QueryBuilder instance is injected into the SearchCQForContent method. This instance is required to perform Query Builder operations from within an OSGi bundle. To inject a QueryBuilder instance, you use the @Reference annotation to define a class member, as shown in the following example.

@Reference
	private QueryBuilder builder;

Within the SearchCQForContent method, a ResourceResolverFactory instance is injected into the SearchCQForContent method. This instance is required to create a Session instance that lets you create a Query instance. To inject a ResourceResolverFactory instance, you use the @Reference annotation to define a class member, as shown in the following example.

@Reference
private ResourceResolverFactory resolverFactory;
      

@Override
public String SearchCQForContent() {
try { 

    //Create a Session
    ResourceResolver resourceResolver = resolverFactory.getAdministrativeResourceResolver(null);
    session = resourceResolver.adaptTo(Session.class);

The SearchCQForContent method returns an XML schema that contains data that conforms to the QueryBuilder search.  In this development article, the following QueryBuilder search is used.

//Define the search term
String fulltextSearchTerm = "Geometrixx";
			     
// create query description as hash map (simplest way, same as form post)
Map<String, String> map = new HashMap<String, String>();

 // create query description as hash map (simplest way, same as form post)
map.put("path", "/content");
map.put("type", "cq:Page");
map.put("group.p.or", "true"); // combine this group with OR
map.put("group.1_fulltext", fulltextSearchTerm);
map.put("group.1_fulltext.relPath", "jcr:content");
map.put("group.2_fulltext", fulltextSearchTerm);
map.put("group.2_fulltext.relPath", "jcr:content/@cq:tags");

// can be done in map or with Query methods
map.put("p.offset", "0"); // same as query.setStart(0) below
map.put("p.limit", "20"); // same as query.setHitsPerPage(20) below
				   
//Create a Query instance
Query query = builder.createQuery(PredicateGroup.create(map), session);

The following Java code shows how to process the result set of the query. Notice that the results are placed into XML. The XML is passed back to the client web page and displayed in the client (this is shown later in this development article).

//Get the query results
SearchResult result = query.getResult();
			     
// paging metadata
int hitsPerPage = result.getHits().size(); // 20 (set above) or lower
long totalMatches = result.getTotalMatches();
long offset = result.getStartIndex();
long numberOfPages = totalMatches / 20;
			    
//Place the results in XML to return to client
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( "results" );
doc.appendChild( root );
			    
// iterating over the results
for (Hit hit : result.getHits()) {
   String path = hit.getPath();

    //Create a result element
    Element resultel = doc.createElement( "result" );
    root.appendChild( resultel );
			        
    Element pathel = doc.createElement( "path" );
    pathel.appendChild( doc.createTextNode(path ) );
    resultel.appendChild( pathel );
}

The following Java code represents the SearchServiceImpl class. 

package custom.search;

import org.w3c.dom.Document;
import org.w3c.dom.Element;
import custom.querybuilder.*;    
  
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 java.util.HashMap;
import java.util.Map;
  
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; 
  

//QUeryBuilder APIs
import com.day.cq.search.QueryBuilder; 
import com.day.cq.search.Query; 
import com.day.cq.search.PredicateGroup;
import com.day.cq.search.result.SearchResult;
import com.day.cq.search.result.Hit; 


//This is a component so it can provide or consume services
@Component
 
@Service
public class SearchServiceImpl implements SearchService {

/** Default log. */
protected final Logger log = LoggerFactory.getLogger(this.getClass());
	     
private Session session;
	         
//Inject a Sling ResourceResolverFactory
@Reference
private ResourceResolverFactory resolverFactory;
	     
@Reference
private QueryBuilder builder;
	
@Override
public String SearchCQForContent() {
try { 
			 
 //Invoke the adaptTo method to create a Session 
    ResourceResolver resourceResolver = resolverFactory.getAdministrativeResourceResolver(null);
    session = resourceResolver.adaptTo(Session.class);
			
    String fulltextSearchTerm = "Geometrixx";
			     
    // create query description as hash map (simplest way, same as form post)
    Map<String, String> map = new HashMap<String, String>();

 // create query description as hash map (simplest way, same as form post)
		      
    map.put("path", "/content");
    map.put("type", "cq:Page");
    map.put("group.p.or", "true"); // combine this group with OR
    map.put("group.1_fulltext", fulltextSearchTerm);
    map.put("group.1_fulltext.relPath", "jcr:content");
    map.put("group.2_fulltext", fulltextSearchTerm);
    map.put("group.2_fulltext.relPath", "jcr:content/@cq:tags");
    // can be done in map or with Query methods
    map.put("p.offset", "0"); // same as query.setStart(0) below
    map.put("p.limit", "20"); // same as query.setHitsPerPage(20) below
				   
    Query query = builder.createQuery(PredicateGroup.create(map), session);
	 			    
    query.setStart(0);
    query.setHitsPerPage(20);
			 
    SearchResult result = query.getResult();
			     
    // paging metadata
    int hitsPerPage = result.getHits().size(); // 20 (set above) or lower
    long totalMatches = result.getTotalMatches();
    long offset = result.getStartIndex();
    long numberOfPages = totalMatches / 20;
			    
    //Place the results in XML to return to client
    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( "results" );
    doc.appendChild( root );
			    
			    
    // iterating over the results
    for (Hit hit : result.getHits()) {
	       String path = hit.getPath();
	        //Create a result element
	        Element resultel = doc.createElement( "result" );
	        root.appendChild( resultel );
			        
	        Element pathel = doc.createElement( "path" );
	        pathel.appendChild( doc.createTextNode(path ) );
	        resultel.appendChild( pathel );
			       		       
    }

    //close the session
    session.logout();			 
    return convertToString(doc);  // Convert the XML to a string to return to the web client
			    
}
 catch(Exception e){
	 log.info(e.getMessage());
  }
 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\querybuilder\bundle, add the following dependencies. 

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

Because the QueryBuilder API is used, a Maven dependency on the repository that contains the QueryBuilder API exists. Add the following <repositories> element to your POM file.

<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>
 

Once you add this repository element to your POM file, you can add the following dependency to your POM file, that lets you use the QueryBuilder API in your Java code.

<dependency>
    <groupId>com.day.cq</groupId>
    <artifactId>cq-search</artifactId>
    <version>5.5.4</version>
    <scope>provided</scope>
</dependency>

The following XML represents the POM file to build the OSGi bundle that contains the QueryBuilder API.  

<?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>custom.querybuilder</groupId>
        <artifactId>querybuilder</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>querybuilder-bundle</artifactId>
    <packaging>bundle</packaging>
    <name>My Project Bundle</name>

    <dependencies>
        
        
               
        
        <dependency>
            <groupId>com.day.cq</groupId>
            <artifactId>cq-search</artifactId>
            <version>5.5.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.api</artifactId>
            <version>2.2.4</version>
            <scope>provided</scope>
        </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>javax.jcr</groupId>
         <artifactId>jcr</artifactId>
         <version>2.0</version>
      </dependency>
        
                
    </dependencies>
    <!-- ====================================================================== -->
    <!-- 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>custom.querybuilder.querybuilder-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/myproject/install</slingUrl>
                    <usePut>true</usePut>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                 <configuration>
                    <excludePackageNames>
                        *.impl
                    </excludePackageNames>
                 </configuration>
            </plugin>
        </plugins>
    </build>
</project>

Build the OSGi bundle using Maven 

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

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

 

Deploy the bundle to Experience Manager

Once you deploy the OSGi bundle, you are able to invoke the SearchCQForContent method defined in the SearchServiceImpl 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

You will also be able to view the service defined in the OSGi bundle by using the Service tab in the Apache Felix Web Console.

OSGiService

 

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\querybuilder\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.
    If the status is not Active, check the error.log for exceptions.

Add the data grid library 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.6.3.min.js.

In addition to the JQuery framework file, a data grid plugin named flexigrid is used. This plugin is used to display search results in a tabular format. Download the flexigrid plugin from the following URL:

https://code.google.com/p/flexigrid/

Note:

You can use other data grid plugins in an AEM application as well. For example, the following AEM article uses another data grid control named DataTables. For information, see Querying Adobe Experience Manager Data using the JCR API

Download and extract the flexigrid archive file. The AEM application uses these files from the archive file:

  • flexigrid.pack.css
  • flexigrid.pack.js

In addition, copy the images folder to the cq:ClientLibraryFolder node. The following illustration displays the files that you must add to this node.

clientlibs

To add CSS files and JQuery framework 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. Add these two properties to this node. 

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

The dependencies property informs Experience Manager to include the CSS files and JQuery libraries in the page. The categories property informs Experience Manager which clientlibs must be included.

After you create the Clientlibs folder, add the flexigrid CSS file, the flexigrid JS file, the JQuery library file, and two map text files.

Text files 

You have to add two text files to the clientlibs folder. These text files map to the JS files and the CSS file. The names of the text files are: css.txt and js.txt. The css.txt file contains the CSS file named flexigrid.pack.css. Likewise, the js.txt file contains the JS file names jquery-1.6.3.min.js and flexigrid.pack.js. 

Add the files to the ClientLibs folder  

  1. Right-click /apps/users/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. On your file system, navigate where you placed the CSS files. Drag and drop the CSS files to the clientlibs folder by using CRXDE.
  6. Add a TXT file to the clientlibs folder named js.txt. Add the content specified in this section.
  7. Add a TXT file to the clientlibs node named css.txt. Add the content specified in this section.

Modify the render component to invoke SearchService operations  

To create the AEM client that searches the JCR by using the OSGi bundle that contains the Query Builder API, create these files:

  • query.json.jsp: contains application logic that calls the OSGi bundle's SearchCQForContent method.
  • templateQueryBuilder.jsp: contains application logic that calls the query.json.jsp and displays the search results in a grid control.  

Create the query.json.jsp 

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

apps/querybuilder/components/page/templateQueryBuilder/

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

custom.querybuilder.SearchService cs = sling.getService(custom.querybuilder.SearchService.class);

Pass the fully qualified name of the service to sling.getService method. Because the OSGi bundle is a managed component that injects a QueryBuilder instance into the service, you must use the sling.getService method to create a QueryBuilder object.

If you attempt to create a SearchService using the new operation, the OSGi bundle is not considered a managed component and will not successfully inject a QueryBuilder instance. A Java null pointer exception is thrown.

After you create a SearchService object by using sling.getService, you can invoke the SearchCQForContent method exposed by the service. This method retrurns XML that contains the results of the search.

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

<%@page session="false" %>
<%@include file="/libs/foundation/global.jsp"%>
<%@ page import="org.apache.sling.jcr.api.SlingRepository" %>
<%@ page import="custom.search.SearchServiceImpl" %>
<%@ page import="com.day.cq.security.UserManagerFactory" %>
<%@ page import="com.day.cq.security.User" %>
<%@ page import="com.day.cq.security.Authorizable" %>
<%@ page import="com.day.cq.security.profile.Profile" %>
<%@ page import="java.util.Iterator" %>
<%@ page import="java.util.List" %>
<%@ page import="java.util.ArrayList" %>
<%@ page import="org.apache.sling.commons.json.io.JSONWriter" %>

<%@page import="com.day.cq.dam.api.Asset"%> 
<%

String filter = request.getParameter("filter");
  
//create a SeachService instance
custom.querybuilder.SearchService queryBuilder = sling.getService(custom.querybuilder.SearchService.class);
  
String XML = queryBuilder.SearchCQForContent() ; 
   
//Send the data back to the client 
JSONWriter writer = new JSONWriter(response.getWriter());
writer.object();
writer.key("xml");
writer.value(XML);
  
writer.endObject();
%>

Modify the templateQueryBuilder.jsp 

Modify the templateQueryBuilder.jsp file to call the query.json.jsp and write the search results to the Flexigrid control. In this example, a JQuery Ajax HTTP request is used to invoke the code in the query.json.jsp. This code shows the submit method that is called when the user clicks the Search CQ button.   

$('#submit').click(function() {
        var failure = function(err) {
             alert("Unable to retrive data "+err);
            
          };
            
 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);
               var val = data.xml  ;        

              //Display the results in the Grid control
              var jsonObj = []    ;
              var index = 1 ; 

              $(val).find('result').each(function(){

                  var Template = {};
                  var field = $(this);

                  Template["id"] =  index; 
                  Template["name"] =  $(field).find('path').text();
       
                  //Push JSON
                  jsonObj.push(Template)   ;
                  index++; 
              });

            //Populate the Data Grid Control 
            var gridData =  formatCustomerResults(jsonObj)  ; 
            $("#flex1").flexAddData(eval(gridData));
                   
 }  catch(err) {
          failure(err);
      }
  },
  error: function(xhr, status, err) {
          failure(err);
      } 
  });
});

Notice that for each result in the XML, the data is placed into a JSON data structure that is used to populate the data grid control.  

The following code represents the entire TemplateQueryBuilder.jsp file.  

<%@include file="/libs/foundation/global.jsp"%>
<cq:includeClientLib categories="jquerysamples" />
<script type="text/javascript">
 

jQuery(function ($) {
 

$("#flex1").flexigrid(
{
        dataType: 'json',
        colModel : [
        {display: 'Num', name : 'id', width : 100, sortable : true, align: 'left'},
        {display: 'Asset Path', name : 'name', width : 500, sortable : true, align: 'left'},
	                    
	],
	buttons : [
	{name: 'Report', bclass: 'report', onpress : test},
	{name: 'Deactivate', bclass: 'delete', onpress : test},
	{name: 'FormIT', bclass: 'view', onpress : test},
	{separator: true}
	],
        searchitems : [
            {display: 'First Name', name : 'first_name'},
            {display: 'Surname', name : 'surname', isdefault: true},
            {display: 'Position', name : 'position'}
        ],
    sortname: "id",
    sortorder: "asc",
    usepager: true,
    title: "Results for term Geometrixx",
    useRp: true,
    rp: 10,
    showTableToggleBtn: false,
    resizable: true,
    width: 1000,
    height: 470,
    singleSelect: true
    }
);


$('#submit').click(function() {
var failure = function(err) {

  alert("Unable to retrive data "+err);
  };
            
       
  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);
                        
                  var val = data.xml  ;        

                //Display the results in the Grid control
              var jsonObj = []    ;
              var index = 1 ; 

              $(val).find('result').each(function(){

                      var Template = {};
                      var field = $(this);

                      Template["id"] =  index; 
                      Template["name"] =  $(field).find('path').text();
    
                      //Push JSON
                      jsonObj.push(Template)   ;
                      index++; 

          });

    //Populate the Flexigrid control
     var gridData =  formatCustomerResults(jsonObj)  ; 
     $("#flex1").flexAddData(eval(gridData));
                   
      } catch(err) {
          failure(err);
          }
      },
      error: function(xhr, status, err) {
              failure(err);
      } 
  });
   });
  
      
});
 
function test() {
    alert("Not implemented yet.");
}

function formatCustomerResults(Templates){

    var rows = Array();
    var temp =      Templates ;

    for (i = 0; i <temp.length; i++) {
        var item = temp[i];

        rows.push({ cell: [item.id,
            item.name
        ]
        });
    }

    var len =  temp.length;

    return {
        total: len,
        page: 1,
        rows: rows
    }

};

 
</script>
 
<body>
<h2>Adobe AEM Query Builder Example Application</h2>

 <table id="flex1" width="1050">

 </table>
 
 <input type="button" value="Search CQ"  name="submit" id="submit" value="Submit">
                   
</body>
</html>

Modify the templateQueryBuilder file:

  1. Go to CRXDE Lite at http://localhost:4502/crx/de/index.jsp
  2. Double-click apps/querybuilder/components/page/templateQueryBuilder/templateQueryBuilder.jsp.
  3. Replace the JSP code with the new code shown in this section.
  4. Click Save All.

 

Create an AEM web page that searches the JCR

The final task is to create a site that contains a page that is based on the templateQueryBuilder (the template created earlier in this development article). When the user clicks the Search CQ button, the search results are displayed in the data grid control.

App

Create an AEM web page that queries data from the AEM JCR:

  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 templateQueryBuilder 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 previous illustration.

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