Article summary

Summary

Discusses how to create an Adobe Experience Manager OSGi bundle that is able to create AEM users and groups. The Jackrabbit UserManager API is used within the OSGi bundle. 

A special thank you to community members Ranta Kumar Kotla and Pratistha Mukherjee for testing this Community Article to ensure it works.

Digital Marketing Solution(s) Adobe Experience Manager (Adobe CQ)
Audience
Developer (beginner - intermediate)
Required Skills
JCR nodes, JavaScript, HTML
Tested On Adobe Experience Manager 6.1, 6.2

Note:

You can download an AEM package that contains the code used in this article. Download the package and deploy using package manager. That is, it's to illustrate how to use Jackrabbit User Manager API to create AEM users and groups. 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/editor.html/content/aemUsers/en.html (assuming you deploy on author).

Download

Note:

In order for this package to work, you still need to create an AEM System user and use Sling Mapping as described in this article. Otherwise, the code does not work. 

Introduction

You can develop an Adobe Experience Manager (AEM) OSGi bundle that uses the Jackrabbit UserManager APIs to perform AEM user operations. This API provides access to both AEM users and groups and is located in the org.apache.jackrabbit.api.security.user Java package. In this development article, a custom Sling Servlet is created that dynamically creates AEM users and groups.

For more information, see Interface UserManager.

The following illustration shows the AEM page that performs a POST operation to the AEM custom Sling Servlet that creates the user and group.

client2
User and Group values posted to a custom Sling Servlet

This development article steps you through how to build an AEM 6.x application that uses the Jackrabbit User Manager API to dynamically create users and groups by using an AEM Maven Archetype 10 project. 

Create a dedicated AEM user account

Create a dedicated AEM system user account that can be used to create users and groups. Ensure that this system is part of the administrators group, which is required to add users/groups. Otherwise, an OAK data exception occurs when you use this user in the Java API code (shown later in this development article). 

 

datawrite
An AEM system user belongs to the administators group

Create an AEM System user.

1. Open http://localhost:4502/crx/explorer/index.jsp.

2. Login as admin.

3. Click User Administration.

4. Click Create System User named datawrite (datawrite is used in this article).

5. Set the UserId.

6. Click Save

7. Access the AEM user page at http://localhost:4502/useradmin.

8. Add the datawrite user to the administrators group by dragging and dropping.

12. Click the Save button located in the top menu bar (located above the Path heading).

Note:

If you do not add datawrite to the administrator group, then the Java code in the servlet will not work. 

Configure the AEM Sling Map Service

The next step is to configure the Apache Sling Service User Mapper service by adding a new entry. You specify the following value:

aemUsers.core:dataservice=datawrite

where:

  • aemUsers.core – is the Bundle-SymbolicName value of the OSGi bundle this is developed in the upcoming sections of this article.
  • dataservice– the name of the sub service (you reference this value in a Java Map object).
  • datawrite – the AEM System user account with that belongs to the administators group.

The following illustration shows an entry for this service.

SlingMapping2
An entry in the Apache Sling Service Mapping Service

To create an entry in the Apache Sling Mapper service, perform these tasks:

1. Go to the Apache Sling Mapper service at http://localhost:4502/system/console/configMgr.

2. Click OSGI, Configurations.

2. Scroll to an entry named Apache Sling Service User Mapper Service.

3. Enter the value aemUsers.core:dataservice=datawrite.

4. Click Save.

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:

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:

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

Note:

The Adobe repository URL is now made secured. Change http://repo.adobe.com/nexus/content/groups/public/ to https://repo.adobe.com/nexus/content/groups/public/.

Create an AEM Maven 10 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.

files
Maven Archetype 10 generated files

The following list describes the Archetype 10 project arguments:

  • groupId - Base Maven groupId
  • artifactId - Base Maven ArtifactId
  • version - the version of your project
  • package - Java Source Package
  • appsFolderName - /apps folder name
  • artifactName - Maven Project Name
  • componentGroupName - AEM component group name
  • contentFolderName - /content folder name
  • cssId - prefix used in generated css
  • packageGroup - Content Package Group name
  • siteName - AEM site name

To create an AEM 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 -DarchetypeGroupId=com.adobe.granite.archetypes -DarchetypeArtifactId=aem-project-archetype -DarchetypeVersion=10 -DarchetypeRepository=https://repo.adobe.com/nexus/content/groups/public/

3. When prompted, specify the following information:

  • groupId - aemUsers
  • artifactId - aemUsers
  • version - 1.0-SNAPSHOT
  • package - com.foo.community.core
  • appsFolderName - aemUsers
  • artifactName - aemUsers
  • componentGroupName - aemUsers
  • contentFolderName - aemUsers
  • cssId - aemUsers
  • packageGroup -aemUsers
  • siteName - aemUsers

4. WHen prompted, specify Y.

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

[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[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 aemUsers 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.

project
Eclipse Import Project Dialog

The Eclipse project that you work in to build the OSGi bundle that uses User Manager API is aemUsers.core. You do not have to work in the other projects under aemUsers. 

Note:

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. Also, delete all files in the project except for the  com.foo.service.core package. Place the two Java files discussed in this article into this package. Delete all other Java files.  

The next step is to add a Java file to the com.foo.community.core package. The Java file represents a Java Servlet that uses the UserManager API. The Java class uses these annotations:

@Service(value = Servlet.class)

@Component(immediate = true, metatype = true)

@Properties({

@Property(name = "sling.servlet.paths", value = "/services/SimpleUserGroup"),

@Property(name = "service.description", value = "SimpleUserGroup"),

@Property(name = "label", value = "SimpleUserGroup") })

The sling.servlet.paths property corresponds to the URL that you specify when using an AJAX request.

The following code represents the SimpleUserGroup servlet that extends SlingAllMethodsServlet. This interface contains the doPost method that accepts a post operation (user and grop is posted to the servlet). The user and group values are then used to create an AEM user and group.

package com.foo.community.core;

import java.io.IOException;
import java.security.Principal;
 

import javax.jcr.PropertyType;
import javax.jcr.Session;
import javax.jcr.Value;
import javax.jcr.ValueFactory ; 
import javax.servlet.Servlet;
 
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.Service;
import org.apache.jackrabbit.api.security.user.Group;
import org.apache.jackrabbit.api.security.user.User;
import org.apache.jackrabbit.api.security.user.UserManager;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.api.resource.ResourceResolverFactory;
import org.apache.sling.api.servlets.SlingAllMethodsServlet;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.List;
import java.util.ArrayList;
import java.util.HashMap; 
import java.util.Map; 
 
@Service(value = Servlet.class)
@Component(immediate = true, metatype = true)
@Properties({
  @Property(name = "sling.servlet.paths", value = "/services/SimpleUserGroup"),
  @Property(name = "service.description", value = "SimpleUserGroup"),
  @Property(name = "label", value = "SimpleUserGroup") })
 
public class SimpleUserGroup extends SlingAllMethodsServlet{
  
	
	/**
  *
  */
 private static final long serialVersionUID = 1L;
 
 private Session adminSession;
 
 @Reference
 ResourceResolverFactory resolverFactory;
  

 private static Logger log = LoggerFactory.getLogger(SimpleUserGroup.class);
  
 protected final void doPost(final SlingHttpServletRequest request,
   final SlingHttpServletResponse response) throws IOException {
   
   
   ResourceResolver resolver = null;   
  String groupName= request.getParameter("groupName");
  String userName=request.getParameter("userName");
  String password="sampleUser";
  
  
  try {

	Map<String, Object> authInfoParam = new HashMap<String, Object>();
    authInfoParam.put(ResourceResolverFactory.SUBSERVICE, "dataservice");
    resolver = resolverFactory.getServiceResourceResolver(authInfoParam);
 
         
	  
	     log.info("*** IN SERVLET *** GroupName is "+groupName);
	    //Invoke the adaptTo method to create a Session used to create a QueryManager
	     resolver = resolverFactory.getServiceResourceResolver(authInfoParam);
	     adminSession = resolver.adaptTo(Session.class);
	       
         
         final UserManager userManager= resolver.adaptTo(UserManager.class);
                
         // Create a Group
         Group group= null;
         if (userManager.getAuthorizable(groupName) == null) {
             //adminResolver.refresh();
             group = userManager.createGroup(groupName,new SimplePrincipal(groupName),"/home/groups/test");
             
             ValueFactory valueFactory = adminSession.getValueFactory();
             Value groupNameValue = valueFactory.createValue(groupName, PropertyType.STRING);
             group.setProperty("./profile/givenName", groupNameValue);
             //adminResolver.commit();
             log.info("----------------------------------------> {} Group successfully created.",group.getID());
         } else {
             log.info("----------------------------------------> Group already exist..");
         }

         // Create a User
         User user = null;
         if (userManager.getAuthorizable(userName) == null) {
             //adminResolver.refresh();
             user=userManager.createUser(userName, password,new SimplePrincipal(userName),"/home/users/test");
             
             ValueFactory valueFactory = adminSession.getValueFactory();
             Value firstNameValue = valueFactory.createValue("Arpit", PropertyType.STRING);
             user.setProperty("./profile/givenName", firstNameValue);
             
             Value lastNameValue = valueFactory.createValue("Bora", PropertyType.STRING);
             user.setProperty("./profile/familyName", lastNameValue);
             
             Value emailValue = valueFactory.createValue("arpit.p.bora@gmail.com", PropertyType.STRING);
             user.setProperty("./profile/email", emailValue);
             //adminResolver.commit();
             log.info("----------------------------------------> {} User successfully created.",user.getID());
         } else {
             log.info("----------------------------------------> User already exist..");
         }

         // Add Users to Group
         Group addUserToGroup = (Group)(userManager.getAuthorizable(groupName));
         addUserToGroup.addMember(userManager.getAuthorizable(userName));
         adminSession.save();

     }catch (Exception e) {
         log.info("----------------------------------------> Not able to perform User Management..");
         log.info("----------------------------------------> Exception.." + e.getMessage());
         response.getWriter().write("AEM User WAS NOT successfully created.."); 
     } finally {
         if (adminSession != null && adminSession.isLive()) {
             adminSession.logout();
         }
         if (resolver != null)
        	 resolver.close();
         response.getWriter().write("AEM User "+userName +" successfully created.."); 
     }
 }
 
 private static class SimplePrincipal implements Principal {
     protected final String name;

     public SimplePrincipal(String name) {
         if (name.compareTo("")==0) {
             throw new IllegalArgumentException("Principal name cannot be blank.");
         }
         this.name = name;
     }

     public String getName() {
         return name;
     }

     @Override
     public int hashCode() {
         return name.hashCode();
     }

     @Override
     public boolean equals(Object obj) {
         if (obj instanceof Principal) {
             return name.equals(((Principal) obj).getName());
         }
         return false;
     }
 }
 
}

Modify the Maven POM file

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

<dependency>
<groupId>com.adobe.aem</groupId>
<artifactId>uber-jar</artifactId>
<version>6.1.0</version>
<scope>provided</scope>
<classifier>obfuscated-apis</classifier>
</dependency>

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

ParentPOM
Parent POM

Add the dependency shown above to the Parent POM file. Next, modify the POM file located at C:\AdobeCQ\aemUsers\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
 |
 |      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.
-->
<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/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>aemUsers</groupId>
        <artifactId>aemUsers</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <artifactId>aemUsers.core</artifactId>
    <packaging>bundle</packaging>
    <name>aemUsers - Core</name>
    <description>Core bundle for aemUsers</description>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-scr-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <extensions>true</extensions>
                <configuration>
                    <instructions>
                        <!--
                        <Embed-Dependency>
                            artifactId1,
                            artifactId2;inline=true
                        </Embed-Dependency>
                        -->
                        <Sling-Model-Packages>
                            com.foo.community.core
                        </Sling-Model-Packages>
                    </instructions>
                </configuration>
            </plugin>
        </plugins>
    </build>
    <profiles>
        <!-- Development profile: install only the bundle -->
        <profile>
            <id>autoInstallBundle</id>
            <activation>
                <activeByDefault>false</activeByDefault>
            </activation>
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.apache.sling</groupId>
                        <artifactId>maven-sling-plugin</artifactId>
                        <configuration>
                            <!-- Note that this requires /apps/aemUsers/install to exist!!          -->
                            <!--    This is typically the case when ui.apps is deployed first                -->
                            <!--    Otherwise, create /apps/aemUsers/install manually (CRXDE|Lite)  -->
                            <slingUrlSuffix>/apps/aemUsers/install/</slingUrlSuffix>
                            <failOnError>true</failOnError>
                        </configuration>
                    </plugin>
                </plugins>
            </build>
        </profile>
    </profiles>
    <dependencies>
        <!-- OSGi Dependencies -->
          
         <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>uber-jar</artifactId>
            <classifier>obfuscated-apis</classifier>
        </dependency>
        <dependency>
	<groupId>org.apache.jackrabbit</groupId>
	<artifactId>jackrabbit-api</artifactId>
	<version>2.10.0</version>
	<scope>provided</scope>
</dependency>
<dependency>
	<groupId>com.day.commons.osgi.wrapper</groupId>
	<artifactId>com.day.commons.osgi.wrapper.commons-lang2</artifactId>
	<version>2.5-0001</version>
	<scope>provided</scope>
</dependency>
         <dependency>
            <groupId>org.apache.felix</groupId>
            <artifactId>org.apache.felix.scr</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.felix</groupId>
            <artifactId>org.apache.felix.scr.annotations</artifactId>
        </dependency>
        <dependency>
            <groupId>biz.aQute</groupId>
            <artifactId>bndlib</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.compendium</artifactId>
        </dependency>
        <!-- Other Dependencies -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
        </dependency>
        <dependency>
            <groupId>javax.jcr</groupId>
            <artifactId>jcr</artifactId>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
        </dependency>
        <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>aem-api</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.sling</groupId>
            <artifactId>org.apache.sling.models.api</artifactId>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mockito</groupId>
            <artifactId>mockito-all</artifactId>
        </dependency>
        <dependency>
            <groupId>junit-addons</groupId>
            <artifactId>junit-addons</artifactId>
        </dependency>
    </dependencies>
</project>

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\aemUsers.
  2. Run the following maven command: mvn -PautoInstallPackage install.
  3. The OSGi component can be found in the following folder: C:\AdobeCQ\aemUsers\core\target. The file name of the OSGi component is aemUsers.core-1.0-SNAPSHOT.jar.

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

Create the Front End Component

When you use the Maven Archetype 10 archetype to create an AEM project, a default front end project is created, as shown in the following illustration.

aemUsersHello
Default files created by Adobe Maven 10 Archetype project

Note:

For information about the default files created by the Maven 10 Archetype project, see this community article: Creating your first AEM 6.2 Project using Adobe Maven Archetype 10.

For the purpose of this article, the code is written within a Maven Archetype 10 default component located here:

/apps/aemUsers/components/content/helloworld

Change the file extension from HTML to JSP.  Add code to the helloworld.jsp to post data to the Sling Servlet that was created in this development article.

In this example, a JQuery Ajax Post request is used and the form data is passed to the Sling Servlet's doPost method (the method defined in the SimpleUserGroup Java class). The following code represents the AJAX request.

 

<%@include file="/libs/foundation/global.jsp"%>
<cq:includeClientLib categories="cq.jquery" />
<html>
<head>
<meta charset="UTF-8">
<style>
#signup .indent label.error {
  margin-left: 0;
}
#signup label.error {
  font-size: 0.8em;
  color: #F00;
  font-weight: bold;
  display: block;
  margin-left: 215px;
}
#signup  input.error, #signup select.error  {
  background: #FFA9B8;
  border: 1px solid red;
}
</style>
<script>
 
   
$(document).ready(function() {
   
    $('body').hide().fadeIn(5000);
          
$('#submit').click(function() {
    var failure = function(err) {
             alert("Unable to retrive data "+err);
   };
   
    //Get the user-defined values that represent claim data to persist in the Adobe CQ JCR
    var myGroup= $('#GroupName').val() ; 
    var myUser= $('#UserName').val() ; 
 
   
   
    //Use JQuery AJAX request to post data to Sling Servlet that creates the group and user
    $.ajax({
         type: 'POST',    
         url:'/services/SimpleUserGroup',
         data:'groupName='+ myGroup+'&userName='+ myUser,
         success: function(msg){
             $('#Response').val(msg); 
 
         }
     });
  });
      
}); // end ready
</script>
</head>
     
<title>AEM User/Group Sample App</title>
     
<body>
       
            
    <h1>AEM User/Group Sample App</h1>
           
</div>
           
<form method="#">
             
 <table border="1" align="left">
   
 <tr>
 <td>
<label for="Response" id="Responselb" >Response</label>
 </td>
 <td>
 <input id="Response" name="A1. Server Response" readonly=true size="35" type="text" value="">
 </td>
 </tr> 
 <tr>
 <td>
<label for="GroupName" id="GroupNamelb">A.2. Group Name</label>
 </td>
 <td>
 <input id="GroupName" name="A.2 Group Name"  type="text" value="">
 </td>
 </tr> 
   
  <tr>
 <td>
<label for="UserName" id="UserNamelb" >B2. User Name</label>
 </td>
 <td>
<input id="UserName" name="B1. User Name    " type="text" value="">
 </td>
 </tr> 
 
 <tr>
 <td></td>
 <td>
<input type="button" value="Submit"  name="submit" id="submit" value="Submit">
  
 </td>
   
 </tr> 
   
 </table>
  
</form>
     
             
  
   
</body>
   
</html>

View the output of the component

To access the component, enter the following URL: 

http://localhost:4502/editor.html/content/aemUsers/en.html

The following illustration shows the component.

 

client2
The component created in this article

Once the response is returned, the user and group are created, as shown in the following illustration (http://localhost:4502/useradmin). 

AEMUsers
AEM Users created by the Jackrabbit User Manager API

See also

Congratulations, you have just created an AEM OSGi bundle that uses the Jackrabbit User Manager API to dynamically create AEM users and groups. Please refer to the AEM community page for other articles that discuss how to build AEM services/applications.

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