Article summary


Discusses how to use the Experience Manager PageManager API to dynamically create a new page. The article also uses Declarative Services Annotations.

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

This HELPX article is based on community content that community members have implemented in various projects. If you see content that needs to be corrected or other updates , please email Scott Macdonald and Kautuk Sahni at and 

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



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 use the PageManager API to create a new AEM Page.

You can view the application by using the following URL:

http://localhost:4502/editor.html/content/AEMPage/en.html (assuming you deploy on author).

IMPORTANT: Before you can successfully run this example, you must whitelist the OSGi bundle. To learn how to whitelist a bundle, see the AEM Forum thread: OSGI Bundle whitelist.

Use the OSGi bundle symbolic name which in this example is AEMPage.core


You can create an Adobe Experience Manager (AEM) 6.3 service that uses the Page Manager API to dynamatically create pages. To create a page using the Experience Manager Java API, you use the Page Manager API. For information, see Page Manager API in the Experienced Manager JavaDocs.

The following illustration shows the page that is created by following this development article. 

An Experience Manager page that is created by using the Page Manager API

This article steps you through how to build an AEM 6.3 project that uses the Page Manager API by using an AEM Maven Archetype 11 project. 

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"


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 AEM Maven 11 archetype project

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

Maven Archetype 10 generated files

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 - AEMPage
  • artifactId - AEMPage
  • version - 1.0-SNAPSHOT
  • package -
  • appsFolderName - AEMPage
  • artifactName - AEMPage
  • componentGroupName - AEMPage
  • contentFolderName - AEMPage
  • cssId - AEMPage
  • packageGroup - AEMPage
  • siteName - AEMPage

4. WHen prompted, specify Y.

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

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

An Eclipse project

The Eclipse project that you work in to build the OSGi bundle is AEMPage.core. You do not have to work in the other projects under AEMPage.


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.

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

  • PageService - an interface that defines the operations of the service.
  • PageServiceImp - an implementation class that uses the Page Manager API to create a page.


PageService Interface

The PageService interface defines an operation exposed by the service. The following Java code represents this class.


public interface PageService {
	public String CreatePage(String pageName) ;


PageServiceImp class

The PageServiceImp uses the PageManager API to dynmically created a page. In this example, the page will be under /content/AEMPage/en  (this location is created automatically by the Maven 11 project). Notice that the PageManager object's create method is used to create the page. This method accepts the following parameters: 

  • A values that specifies the JCR location of the new page
  • The page name 
  • The Experience Manager Template on which the page is based
  • The page title 

The following Java code represents the PageServiceImp 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;

import java.util.HashMap;
import java.util.Map;
import javax.jcr.Node;
import javax.jcr.Session;
import org.apache.jackrabbit.commons.JcrUtils;
import com.adobe.cq.sightly.WCMUsePojo;

public class PageServiceImp implements PageService {
	private String user = "";
	private Session session;
	//Inject a Sling ResourceResolverFactory
	private ResourceResolverFactory resolverFactory;
	public String CreatePage(String pageName) 
	String pagePath = "/content/AEMPage/en";
	String templatePath = "/apps/AEMPage/templates/page-home";
	String pageTitle = "AEM home page";
	Page newPage;
	PageManager pageManager; 
	ResourceResolver resolver = null;
	try {
	    //Invoke the adaptTo method to create a Session 
	    resolver = resolverFactory.getAdministrativeResourceResolver(null);
	    session = resolver.adaptTo(Session.class);
	    //create a page manager instance
	    pageManager = resolver.adaptTo(PageManager.class); 
	    //create a new page
		newPage = pageManager.create(pagePath, pageName, templatePath, pageTitle);
		if (newPage != null) {
			user = resolver.getUserID();

			Node newNode = newPage.adaptTo(Node.class);
			Node cont = newNode.getNode("jcr:content");
			if (cont != null) {
				Node rootNode = session.getRootNode();
				String path = rootNode.getPath();
				Node parNode = JcrUtils.getNodeIfExists(cont, "par");
				Node imageNode = JcrUtils.getOrCreateByPath(parNode.getPath() + "/image", JcrConstants.NT_UNSTRUCTURED, session);
				Node textNode = JcrUtils.getNodeIfExists(parNode, "text");
				imageNode.setProperty("sling:resourceType", "foundation/components/image");
				imageNode.setProperty("fileReference", "/content/dam/we-retail-screens/we-retail-instore-logo.png");
				textNode.setProperty("text", "<p>This page is created using page manager</p>");;
		return pageName; 
	} catch (Exception e) {
		// TODO Auto-generated catch block
	return ""  ; 




For code brevity, this code example uses resolverFactory.getAdministrativeResourceResolver method. This is used simply to keep the code shorter. If you are using this in Production, the recommended way is to create a system user and use the Sling Mapping Service. For more information, see Querying Adobe Experience Manager 6 data using the Sling getServiceResourceResolver method.

Modify the HelloWorldModel class

Modify the HelloWorldModel class (located in the package) so that it invokes the PageService service by using a @Inject annotation. The code calls the CreatePage method and writes out the page name (which is the return value of the CreatePage method).

The following Java code represents the HelloWorldModel Java class.


import javax.annotation.PostConstruct;

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


public class HelloWorldModel {

    private SlingSettingsService settings;
    private PageService ps;

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

    private String message;

    protected void init() {
        message = "\tHello World!\n";
        message += "\tThis is instance: " + settings.getSlingId() + "\n";
        message += "\tNew Page name is: " + ps.CreatePage("AEM_PAGE") + "\n";

    public String getMessage() {
        return message;

Modify the Maven POM file

Add the following POM dependencies to the POM file located at C:\AdobeCQ\AEMPage.

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

You need to modify two POM files. The first one is the parent POM file shown in this illustration.

Parent POM

Add the dependency shown above to the Parent POM file. Next, modify the POM file located at C:\AdobeCQ\AEMPage\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>AEMPage - Core</name>
    <description>Core bundle for AEMPage</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\c.
  2. Run the following maven command: mvn -PautoInstallPackage install.
  3. The OSGi component can be found in the following folder: C:\AdobeCQ\AEMPage\core\target. The file name of the OSGi component is AEMPage.core-1.0-SNAPSHOT.jar.

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

Invoke the AEMPage Service

When you open the sample AEMPage web page, the default component on the page invokes the HelloWorldModel Sling Model class, which in return invokes the AEMPage service that creates a new page. You can view the page by using this URL: 


The following illustration shows the default page. 

The Default page that invokes the AEMPage Service that uses the PageManager API


In this example, each time you load the example web page, the AEMPage service dynamically creates a new page. 

Location of the new page

The new page is created in the following JCR location:


The following illustraton shows the new page. 


The location of the new page

See also

Join the AEM community at: Adobe Experience Manager Community