Article summary


Discusses how to create an Adobe Experience Manager OSGi bundle that reads configuration values. This article uses Declarative Services Annotations

A special thank you to Ratna Kumar Kotla, and Prince Shivhare, top AEM community members, for contributing towards this article to ensure it works.

Digital Marketing Solution(s) Adobe Experience Manager 6.3
Audience Developer
Required Skills Java 
Version 6.3


You can define OSGi configuration values by using CRXDE lite and dynamically read these values from within an OSGi service. By defining configuration values, you can define values used by an OSGi service and use these values while the service is running. Unlike hard-coding values in an AEM OSGi service, defining values in the AEM configuration user interface (http://localhost:4502/system/console/configMgr) lets you change values without re-compiling the bundle.

Configuration values that are read by the AEM Service

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:

Default locale: en_US, platform encoding: Cp1252
OS name: "windows 7", version: "6.1", arch: "amd64", family: "windows"

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

Create an Experience Manager archetype project by using the Maven archetype 11 project. In this example, assume that the working directory is C:\AdobeCQ.

Files generated by Maven 11 Archetype

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 org.apache.maven.plugins:maven-archetype-plugin:2.4:generate -DarchetypeGroupId=com.adobe.granite.archetypes -DarchetypeArtifactId=aem-project-archetype -DarchetypeVersion=11 -DarchetypeCatalog=

3. When prompted, specify the following information:

  • groupId - configDS
  • artifactId - configDS
  • version - 1.0-SNAPSHOT
  • package -
  • appsFolderName - configDS
  • artifactName - configDS
  • componentGroupName - configDS
  • contentFolderName - configDS
  • cssId - configDS
  • packageGroup - configDS
  • siteName - configDS

4. WHen prompted, specify Y.

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

[INFO] ------------------------------------------------------------------------
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 01:42 min
[INFO] Finished at: 2016-04-25T14:34:19-04:00
[INFO] Final Memory: 16M/463M
[INFO] ------------------------------------------------------------------------

6. Change the working directory to osgiconfigrun and then enter the following 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 Import Project Dialog


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. In this example, the test package was deleted

The next step is to add these Java files to the package. 

  • MyServiceConfiguration - defines configuration values that are read by the OSGi service. 
  • MySimpleService - an interface that defines the operations exposed by the service. 
  • MySimpleServiceImpl- the implementation class that reads the configuration values. 

MyServiceConfiguration interface

The following Java code represents the MyServiceConfiguration interface. Notice the name of the configuration is My Service Configuration (this value is displayed under the configuration view). Also, for each configuration value that is defined, an @AttributeDefinition annotation is specified.


import org.osgi.service.metatype.annotations.AttributeDefinition;
import org.osgi.service.metatype.annotations.AttributeType;
import org.osgi.service.metatype.annotations.ObjectClassDefinition;

@ObjectClassDefinition(name = "My Service Configuration", description = "Service Configuration")
public @interface MyServiceConfiguration {
	@AttributeDefinition(name = "Config Value", description = "Configuration value")
	String configValue();
	@AttributeDefinition(name = "MultipleValues", description = "Multi Configuration values")
	String[] getStringValues();
	@AttributeDefinition(name = "NumberValue", description = "Number values", type=AttributeType.INTEGER)
	int getNumberValue();

MySimpleService interface

The MySimpleService interface defines the operations exposed by the main service. The implementation class that implements this interface reads the configuratioin values. 

The following Java code represents the MySimpleService interface. 


public interface MySimpleService {
	// you can use this service directly with data-sly-use
	// like this example
	// <sly data-sly-use.service="com.adobe.examples.htl.core.service.MySimpleService"/>
	// ${service.simpleValue}
	String getSimpleValue();
	boolean isAuthor();

MySimpleServiceImpl class

The MySimpleServiceImpl class reads the OSGi configuration values defined in MyServiceConfiguration. This class uses these annotations.

  • @Component – defines the class as a component
  • @Designate - defines at class level the object-class-definition (where configuration values are defined). 

The following Java code represents the MySimpleServiceImpl class.


import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.ConfigurationPolicy;
import org.osgi.service.component.annotations.Reference;
import org.osgi.service.metatype.annotations.Designate;

@Component(service = MySimpleService.class,configurationPolicy=ConfigurationPolicy.REQUIRE)
@Designate(ocd = MyServiceConfiguration.class)
public class MySimpleServiceImpl implements MySimpleService {
	// to use the OSGi annotations
	// use version 3.2.0 of maven-bundle-plugin

	private MyServiceConfiguration config;
	private boolean author;
	private SlingSettingsService settings;

	public void activate(MyServiceConfiguration config) {
		this.config = config;
		author = settings.getRunModes().contains("author");

	public String getSimpleValue() {
		return "hello " + config.configValue();
	public boolean isAuthor() {
		return author;


Modify the Maven POM file

Add the following POM dependency to the POM file located at C:\AdobeCQ\configDS.

               <!-- for AEM6.1 use this version     : <version>6.1.0</version> -->
               <!-- for AEM6.1 SP1 use this version : <version>6.1.0-SP1-B0001</version> -->
               <!-- for AEM6.1 SP2 use this version : <version>6.1.0-SP2</version> -->
               <!-- for AEM6.2 use this version     : <version>6.2.0</version> -->

When you add new Java classes under core, you need to modify a POM file to successfully build the OSGi bundle. You modify the POM file located at C:\AdobeCQ\configDS\core.

The following code represents this POM file.

<?xml version="1.0" encoding="UTF-8"?>
 |  Copyright 2015 Adobe Systems Incorporated
 |  Licensed 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 "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.
<project xmlns="" xmlns:xsi=""
    <name>configDS - Core</name>
    <description>Core bundle for configDS</description>
                        <!-- Import any version of javax.inject, to allow running on multiple versions of AEM -->

        <!-- OSGi Dependencies -->
        <!-- Other Dependencies -->

Build the OSGi bundle using Maven

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

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

The command -PautoInstallPackage automatically deploys the OSGi bundle to AEM.

Populate the configuration values

Populate the configuration values by going to this URL: 


Search for My Service Configuration and then click on the edit icon. Enter values into each of the fields as shown in this illustration. 


Configuration values


After you define the configruation values, click Save

Modify the HelloWorldModel class

To see the configuration values written out, modify the HelloWorldModel class. First create a MySimpleService object by using the @Inject annotation. 


MySimpleService ms; 

Then you can invoke a method of MySimpleService that returns a configuration values. Add this code: 

message = "\tHello World!\n";
message += "\tResource type is: " + resourceType + "\n";
message += "\tVALUE IS " + ms.getSimpleValue()+ "\n";

Replace the HelloWorldModel class in the package with the following Java code. 


import javax.annotation.PostConstruct;

import javax.inject.Inject;
import javax.inject.Named;


import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class HelloWorldModel {
	protected final Logger log = LoggerFactory.getLogger(this.getClass());

    @Inject @Named("sling:resourceType") @Default(values="No resourceType")
    protected String resourceType;
    MySimpleService ms; 

    private String message;

    protected void init() {
 "***** IN INIT") ; 
        message = "\tHello World!\n";
        message += "\tResource type is: " + resourceType + "\n";
        message += "\tVALUE IS " + ms.getSimpleValue()+ "\n";

    public String getMessage() {
        return message;

Recompile the OSGi bundle by using this Maven command: 

mvn clean install

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\configDS\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 error.log for exceptions.

View the configuration values in a web page

You can view the configuration values in the web page at this URL: 


as shown in this illustration.

The web page with configuration values displayed

See also

Join the AEM community at: Adobe Experience Manager Community

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