Article summary


Discusses how to create a basic Adobe Experience Manager Service that uses a Maven Adobe Archetype project.  

This article uses the Maven archetype that produces a single OSGi bunlde. For information on using Maven archetype 10, see Creating your first AEM 6.2 Project using Adobe Maven Archetype 10.

Digital Marketing Solution(s) Adobe Experience Manager (Adobe CQ)
Developer (intermediate)
Required Skills
Java, OSGi, Maven
Tested On Adobe Experience Manager 5.5, 5.6, 6.0


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 communtiy these concepts in action. That is, it's to illustrate how to write an OSGi bundle that contains a custom service. This community code is for teaching purposes only and not meant to go into production as is.

You can view the sample community application by using the following URL: http://localhost:4502/content/KeyPage.html (assuming you deploy on author).

* keyservice_package-1.0 (1).zip
An AEM custom service
The KeyService OSGi


Install the using package manager. Check to ensure that the OSGi bundle is installed and in Active State.

If it's not there, then unzip and install the OSGi (the JAR file) located in the key_serviceOSGi zip as described in this article. 


In some business use cases, you create an OSGi bundle when creating an Adobe Experience Manager (AEM) application. Although there are different ways to create an OSGi bundle, a recommended way is to use Maven and the Adobe Maven Archetype. This development article walks you through creating a basic OSGi bundle that contains a simple service named KeyService. All this service does is accept an input value and sets a key value. It also exposes a method that returns the key value and the value can be displayed within an AEM web page.


Application logic that represents the KeyService is implemented as Java code that is placed within an OSGi bundle.

Create an application folder structure  

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


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 application folder structure:

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

  2. Go to CRXDE Lite at http://localhost:4502/crx/de/index.jsp.

  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 firstOSGI

  5. Repeat steps 1-4 for each folder specified in the previous illustration. 

  6. Click the Save All button.


You have to click the Save All button when working in CRXDELite 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 Select CRXDE Lite at http://localhost:4502/crx/de/index.jsp.

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

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

    • Label: The name of the template to create. Enter keyTemplate
    • 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 firstOSGI/components/page/keyTemplate.
    • 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 Page Rendering Component

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 CQ 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 Select CRXDE Lite at http://localhost:4502/crx/de/index.jsp.

  2. Right-click /apps/firstOSGI/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 keyTemplate. 
    • Title: The title that is assigned to the component.
    • Description: The description that is assigned to the template.
    • Super Type: foundation/components/page (in AEM 6, you specify this value for page components. In previous versions of AEM, this was not required.)
  4. Select Next for Advanced Component Settings and Allowed Parents.

  5. Select OK on Allowed Children.

  6. Open the slingTemplateJCR.jsp located at: /apps/firstOSGI/components/page/keyTemplate/keyTemplate.jsp.

  7. Enter the following JSP code.

<title>Hello World !!!</title>
<h1>Hello Key Service!!!</h1>
<h2>This page will post data to a Key Service</h2>

Setup Maven in your development environment

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

You can download Maven 3 from the following URL:

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


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

%M3_HOME%\bin\mvn -version

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

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


It is recommended that you use Maven 3.0.3 or greater. 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

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

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
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="" 
  <!-- localRepository
   | The path to the local repository maven will use to store artifacts.
   | Default: ~/.m2/repository

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

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

  <!-- 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.
    <!-- pluginGroup
     | Specifies a further group identifier to use for plugin lookup.

  <!-- 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.
    <!-- proxy
     | Specification for one proxy, to be used in connecting to the network.

  <!-- 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.
    <!-- 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.
    <!-- Another sample, using keys to authenticate.
      <passphrase>optional; leave empty if not used.</passphrase>

  <!-- 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.
    <!-- 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.
      <name>Human Readable Name for this Mirror.</name>
  <!-- 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.
    <!-- 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.


          <name>Repository for JDK 1.4 builds</name>

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











                    <name>Nexus Proxy Repository</name>








                    <name>Nexus Proxy Repository</name>







  <!-- activeProfiles
   | List of profiles that are active for all builds.


The Adobe repository URL is now made secured. Change to

Create an 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. 


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= -DarchetypeArtifactId=multimodule-content-package-archetype -DarchetypeVersion=1.0.2 -DgroupId=com.adobe.cq -DartifactId=key61 -Dversion=1.0-SNAPSHOT -Dpackage=com.adobe.cq -DappsFolderName=myproject -DartifactName="My Project" -DcqVersion="5.6.1" -DpackageGroup="My Company"

  3. When prompted, Specify Y. 

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

    [[INFO] Total time: 14:46.131s
    [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\key61. 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. 

Eclipse project


Do not worry about the errors reported in Eclipse. It does not read the POM file where the APIs are resolved. You build the bundle with Maven. Eclipse is used to edit the Java files and the POM file.

Delete the key-content project from the Eclipse IDE. Work in the key-bundle project and make sure that you work in the com.adobe.cq package.

KeyService interface

The next step is to add Java interface named KeyService to the com.adobe.cq package. This interface defines the operations exposed by your custom AEM service. The following Java code represents the KeyService Java interface. Notice that this interface exposes two methods named setKey and getKey.


package com.adobe.cq;

public interface KeyService {
	public void setKey(int val); 
	public String getKey();


KeyServiceImpl class

The KeyServiceImpl Java class extends the KeyService and defines the implementation for setKey and getKey methods. Add this class to the com.adobe.cq.impl package.

The Maven project creates other files. You can delete them. Only keep the com.adobe.cq and com.adobe.cq.impl packages, as shown in the following illustration. 


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

For information about these annotations, see

The following Java code represents the KeyServiceImpl class.

package com.adobe.cq.impl;

import com.adobe.cq.KeyService;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Service;

//This is a component so it can provide or consume services
public class KeyServiceImpl implements KeyService {

	//Define a class member named key
    private int key = 0 ; 
	//A basic setter method that sets key
    public void setKey(int val)
        //Set the key class member
        this.key = val ; 

	//A basic getter that gets key
    public String getKey()
        //return the value of the key class member
        //Convert the int to a String to display it within an AEM web page
        String strI = Integer.toString(this.key);
        return strI; 

Modify the Maven POM file

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

  • org.apache.felix.scr
  • org.apache.felix.scr.annotations

Modify the POM file that appears in the root of the project in Eclipse, as shown in this illustration.


The following XML represents the POM file to build the custom Sling Scheduler. Copy the XML code to your POM file.

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="" xmlns:xsi=""
    xsi:schemaLocation=" ">
    <!-- ====================================================================== -->
    <!-- P A R E N T P R O J E C T D E S C R I P T I O N -->
    <!-- ====================================================================== -->

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

    <name>My Project Bundle</name>


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

Build the OSGi bundle using Maven

To build the Sling Scheduler OSGi bundle by using Maven, perform these steps:

  1. Open the command prompt and go to the C:\AdobeCQ\key61 folder.

  2. Run the following maven command: mvn clean install.

  3. The OSGi component can be found in the following folder: C:\AdobeCQ\key61\bundle\target. The file name of the OSGi component is key61-bundle-1.0-SNAPSHOT.

Deploy the bundle to Experience Manager

After you deploy the key service bundle, you can see it in the Apache Felix Web Console.


After you place the OSGi bundle in an activate state, you can invoke the KeyService from an AEM JSP. This is shown in the next step.

Deploy the key service by performing these steps:

  1. Login to Apache Felix Web Console at http://server:port/system/console/bundles (default admin user = admin with password= admin).

  2. Click the Bundles tab, sort the bundle list by Id, and note the Id of the last bundle.

  3. Click the Install/Update button.

  4. Browse to the bundle JAR file you just built using Maven. (C:\AdobeCQ\key61\bundle\target).

  5. Click Install.

  6. Click the Refresh Packages button.

  7. Check the bundle with the highest Id.

  8. Click Active.

  9. Your new bundle should now be listed with the status Active.

  10. If the status is not Active, check the CQ error.log for exceptions.

Create an AEM application that invokes the KeyService

Modify the keyTemplate.JSP to invoke the KeyService. To invoke the KeyService, use the sling.getService method , as shown in this code example.

com.adobe.cq.KeyService keyService = sling.getService(com.adobe.cq.KeyService.class);

Besure to pass the fully qualified named of the Java interface, not the implementation class. The following code represents the keyTemplate.JSP file.

<%@include file="/libs/foundation/global.jsp"%>
<h1><%= properties.get("title", currentPage.getTitle()) %></h1>
com.adobe.cq.KeyService keyService = sling.getService(com.adobe.cq.KeyService.class);
keyService.setKey(10) ; 
String ff = keyService.getKey();
<h2>This page invokes the AEM KeyService</h2>
<h3>The value of the key is: <%=ff%></h3>

Replace the code in the /apps/firstOSGI/components/page/keyTemplate/keyTemplate.jsp with the code shown in the previous code example.

Create a page that displays data retrieved from the KeyService

The final task that you perform in order to see a web page that displays data retrieved from the KeyService is to create a site that contains a page that is based on the keyTemplate (the template created earlier in this development article).

The following illustration shows the data returned by the KeyService displayed in the web page.   


To create a web page that displays data retrieved from the KeyService, perform these tasks:

  1. To view the Websites page, enter the URL http://localhost:4502/siteadmin#/content.

  2. Select New, 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 keyTemplate 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 when creating the template, 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 displaying data similar to the previous illustration.

See also

Congratulations, you have just created a basic custom AEM Service by using Maven Adobe Archetype project. Please refer to the AEM community page for more articles that discuss how to build AEM services/applications.