Article summary

Summary

Discusses how to manage multiple configured instances of the same Experience Manager service using Apache SRC Annotations

A special thank you to Ranta and Prince Shivhare, top AEM community members, for testing this article to ensure it works.

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

Download

Note:

You can download an AEM package that contains code and the OSGi bundle that are used in this article. Download the package and deploy using package manager. The purpose of this code is to show the community these concepts in action. That is, it's to illustrate how to use Apache annotations to manage multiple configurations of the same AEM service. This community code is for teaching purposes only and not meant to go into production as is.

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

After you install the package, you still need to configure the MessageGatewayService and the custom service as discussed in this article. 

Introduction

When developing custom services for Adobe Experience Manager, you can define a service that requires properties that are configured by using the Felix Configuration screen.

AEM Configuration screen

You define configuration fields that show up in the Felix configuration screen by using a @Property annotations. For example:

@Property(description="adress to whom email is sent",value=DEFAULT_ADDRESS)
    private static final String ADDRESS = "mailservice.address";
    private String address;

You can configure your AEM service, named MailService, to use different configuration values. For example, you can configure 1 to many different instances of the same service.

Assume you want to develop a custom email service that contain the following configuration values.

  • the email address to which an email is sent
  • the email address from which the email is sent

You can configure the MailService service so that each service instance has a different configuration value. You can enter an AEM configuration value into an AEM configuration dialog, as shown here (notice that the emailservice.address property corresponds to the @Property annotation shown in this section).

AEM Service configuration values

Notice that the mailservice.label property is named InternetA

Here is another configuration of the same service where the mailservice.label property is named InternetB

A separate configuration with different values

When using the @Reference annotation to reference a service, which service configuration is referenced? Is InternetA or InternetB referenced?

You can create a reference to the exact configured AEM service. To perform this task, use the @Reference annotation and specify the property and value (target = "(mailservice.label=InternetA)" ):

 @Reference(target = "(mailservice.label=InternetA)")
     MailService mailServiceA; 
     
 @Reference(target = "(mailservice.label=InternetB)")
     MailService mailServiceB;   

In the above dialog, there is an additional field named emailservice.label. You can reference the value in this field with the target value when using the @Reference annotation.

This development article guides you through how to create an OSGi service where there are multiple configured services and how to use the @Reference(target = "(mailservice.label=InternetA)") annotation properly.

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 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 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 - MultiService
  • artifactId - MultiService
  • version - 1.0-SNAPSHOT
  • package - com.community.foo.multi
  • appsFolderName - MultiService
  • artifactName - MultiService
  • componentGroupName - MultiService
  • contentFolderName - MultiService
  • cssId - MultiService
  • packageGroup -MultiService
  • siteName - MultiService

4. WHen prompted, specify Y.

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

[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 MultiService 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 MultiService.core. You do not have to work in the other projects under MultiService.

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.

The next step is to add Java files to the com.community.foo.multi.core package. Add the following Java files to this package: 

  • An interface named MailService
  • An implementation class that extends MailService named MailServiceImpl

 

MailService interface

The MailService interface defines the operations of the custom AEM service.

package com.community.foo.multi.core;

public interface MailService {
	
	public void sendMail (String message);

}

MailServiceImpl class

The MailServiceImpl is the Java implementation class for the MailService interface. This class defines three properties by using the @Property annotation that can be configured using the AEM Configuration user interface. Notice the following code.

@Property(description="adress to whom email is sent",value=DEFAULT_ADDRESS)
    private static final String ADDRESS = "mailservice.address";
   
    private static final String DEFAULT_FROMADDRESS="smacdonald2006@hotmail.com";
    @Property(description="address uses to represent from address",value=DEFAULT_FROMADDRESS)
    private static final String FROMADDRESS = "mailservice.username";
   
    @Property(description="Label for this SMTP service")
    private static final String NAME = "mailservice.label" ; 

These properties correspond to the fields for this service that can be set in the AEM Service Configuration user interface. The next thing to notice about this code is that data members in the MailServiceImpl class can be set by reading the configuration values, as shown in the following code example. 

 @Activate
    protected void activate (ComponentContext ctx) {
      address = PropertiesUtil.toString(ctx.getProperties().get(ADDRESS),DEFAULT_ADDRESS);
      fromaddress = PropertiesUtil.toString(ctx.getProperties().get(FROMADDRESS),DEFAULT_FROMADDRESS);
      
      log.info("THE from address is " + fromaddress);
      
            
    }

Notice how both the address and fromaddress data members are set by using the ctx.getProperties() method. In this example, these data members are set in the OSGi service Activate method. This is how you can read back configuration values and use them in your AEM service. 

Both of these data members are used to send email messages by using a MessageGatewayService object. The following Java class represents the MailServiceImpl class. 

 

package com.community.foo.multi.core;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.HttpURLConnection;
import java.net.URL;
import java.rmi.ServerException;
import java.util.Dictionary;
   
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.sling.SlingServlet;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.SlingSafeMethodsServlet;
import org.apache.sling.commons.osgi.OsgiUtil;
import org.apache.sling.jcr.api.SlingRepository;
import org.apache.felix.scr.annotations.Service;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.Properties ; 
import org.apache.felix.scr.annotations.Property ; 
import org.apache.felix.scr.annotations.Activate ; 
import org.osgi.service.component.ComponentContext;
import javax.jcr.Session;
import javax.jcr.Node; 
import java.util.UUID;
import java.util.Date; 
import java.text.SimpleDateFormat;  
 
import org.apache.sling.api.resource.Resource ; 
 
import java.util.Map; 
import java.util.HashMap; 
//import javax.mail.MessagingException ; 
 
import org.apache.commons.lang.text.StrLookup; 
 
import org.apache.felix.scr.annotations.Reference;
 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
   
 
import com.day.cq.mailer.MessageGateway;
import com.day.cq.mailer.MessageGatewayService;
 
import com.day.cq.commons.mail.MailTemplate ;  
   
import org.apache.commons.mail.Email;
import org.apache.commons.mail.HtmlEmail;
import org.apache.commons.mail.EmailException;
import org.apache.commons.mail.SimpleEmail;

import org.apache.sling.commons.osgi.PropertiesUtil;

//Sling Imports
import org.apache.sling.api.resource.ResourceResolverFactory ; 
import org.apache.sling.api.resource.ResourceResolver; 
import org.apache.sling.api.resource.Resource; 



//This is a component so it can provide or consume services
@Component(metatype=true, label="simple mailservice",description="simple mailservice",configurationFactory=true)
  
@Service
public class MailServiceImpl implements MailService {
	
	
	 @Reference
     private MessageGatewayService messageGatewayService;
	 
	 @Reference
	 private ResourceResolverFactory resolverFactory;
	
	
	/** Default log. */
    protected final Logger log = LoggerFactory.getLogger(this.getClass());
           
    private static final String DEFAULT_ADDRESS="scottm@adobe.com";
    private String address;
    private String fromaddress;
    
    
    @Property(description="adress to whom email is sent",value=DEFAULT_ADDRESS)
    private static final String ADDRESS = "mailservice.address";
   
    private static final String DEFAULT_FROMADDRESS="smacdonald2006@hotmail.com";
    @Property(description="address uses to represent from address",value=DEFAULT_FROMADDRESS)
    private static final String FROMADDRESS = "mailservice.username";
   
    @Property(description="Label for this SMTP service")
    private static final String NAME = "mailservice.label" ; 

   

    @Activate
    protected void activate (ComponentContext ctx) {
      address = PropertiesUtil.toString(ctx.getProperties().get(ADDRESS),DEFAULT_ADDRESS);
      fromaddress = PropertiesUtil.toString(ctx.getProperties().get(FROMADDRESS),DEFAULT_FROMADDRESS);
      
      log.info("THE from address is " + fromaddress);
      
      
      
    }
	
	public void sendMail (String message)
	{
	
		try
        {
             //Declare a MessageGateway service
             MessageGateway<Email> messageGateway; 
                   
             //Set up the Email message
             Email email = new SimpleEmail();
                           
             email.addTo(address);
             email.setSubject("AEM Service");
             email.setFrom(fromaddress); 
             email.setMsg(message);
               
             //Inject a MessageGateway Service and send the message
             messageGateway = messageGatewayService.getGateway(Email.class);
           
             // Check the logs to see that messageGateway is not null
             messageGateway.send((Email) email);
         
        }
            catch (Exception e)
            {
                 
                 log.info(e.getMessage())  ; 
            }
   }	
		
		
	
	

}

SimpleServlet code

The next step is to overwrite the Java file named SimpleServlet located in the com.community.foo.multi.core.servlets package. The Java class represents the Sling Servlet to which the HTL component posts data to. This class supports the doPost method that lets you submit data from an Experience Manager web page to the Sling servlet. For information about this class, see Class SlingAllMethodsServlet.

The Sling Servlet contains application logic to reference the custom email service. Depending upon the submitted value (the topic.subject values is used in this example), a reference to either InternetA or InternetB configured service is established. 

The following code reprents the SimpleServlet.

package com.community.foo.multi.core.servlets;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.HttpURLConnection;
import java.net.URL;
import java.rmi.ServerException;
import java.util.Dictionary;
   
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.sling.SlingServlet;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.SlingSafeMethodsServlet;
import org.apache.sling.commons.osgi.OsgiUtil;
import org.apache.sling.jcr.api.SlingRepository;
import org.apache.felix.scr.annotations.Reference;
import org.osgi.service.component.ComponentContext;
import javax.jcr.Session;
import javax.jcr.Node; 
import java.util.UUID;
import java.util.Date; 
import java.text.SimpleDateFormat;  
 
import org.apache.sling.api.resource.Resource ; 
 
import java.util.Map; 
import java.util.HashMap; 
//import javax.mail.MessagingException ; 
 
import org.apache.commons.lang.text.StrLookup; 
 
import org.apache.felix.scr.annotations.Reference;
 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
   
 
import com.community.foo.multi.core.MailService; 

   
@SlingServlet(paths="/bin/htlMailServlet", methods = "POST", metatype=true)
public class SimpleServlet extends org.apache.sling.api.servlets.SlingAllMethodsServlet {
     private static final long serialVersionUID = 2598426539166789515L;
        
     @Reference(target = "(mailservice.label=InternetA)")
     MailService mailServiceA; 
     
     @Reference(target = "(mailservice.label=InternetB)")
     MailService mailServiceB;      
      
     /** Default log. */
     protected final Logger log = LoggerFactory.getLogger(this.getClass());
            
             
     @Override
     protected void doPost(SlingHttpServletRequest request, SlingHttpServletResponse response) throws ServerException, IOException {
         
      try
      {
         //Get the submitted data from the HTL front end
          String TopicSubject = request.getParameter("TopicSubject");
          String message = request.getParameter("message"); 
                     
          log.info("*** SUBJECT: "+TopicSubject); 
      
           
        if (TopicSubject.equals("InternetA")==true)
        	mailServiceA.sendMail(message);
        else
        	mailServiceB.sendMail(message);
        	
           
          
          
         //Return the JSON formatted data
         response.getWriter().write("EMAIL GONE");   
          
      }
      catch(Exception e)
      {
          e.printStackTrace();
      }
    }
}

The Java class uses a SlingServlet annotation:

@SlingServlet(paths="/bin/htlMailServlet", methods = "POST", metatype=true)

The paths property corresponds to the URL that you specify when using an AJAX request. For information about different ways to register sling servlets, see Servlet Registration.

To use an AJAX request to post data to this Sling Servlet, you use this syntax:

//Use JQuery AJAX request to post data to a Sling Servlet
$.ajax({
type: 'POST',
url:'/bin/htlMailServlet',
data:'TopicSubject='+ TopicSubject+'&message='+ message,
success: function(msg){


$('#message').val(msg);
}
});

Notice that the url in the AJAX request maps to the path property in the SlingServlet annotation. The type in the AJAX request maps to the methods property in the SlingServlet annotation. Finally notice that the AJAX request specifies the form data that is submitted. Each form field is retrieved in the doPost method by using the request.getParameter method.

Modify the Maven POM file

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

<dependency>
               <groupId>com.adobe.aem</groupId>
               <artifactId>uber-jar</artifactId>
               <version>6.2.0</version>
               <!-- 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> -->
               <classifier>obfuscated-apis</classifier>
               <scope>provided</scope>
           </dependency>
            
           <dependency>
               <groupId>org.apache.geronimo.specs</groupId>
               <artifactId>geronimo-atinject_1.0_spec</artifactId>
               <version>1.0</version>
               <scope>provided</scope>
           </dependency>

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\MultiService\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>MultiService</groupId>
        <artifactId>MultiService</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <artifactId>MultiService.core</artifactId>
    <packaging>bundle</packaging>
    <name>MultiService - Core</name>
    <description>Core bundle for MultiService</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.community.foo.multi.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/MultiService/install to exist!!          -->
                            <!--    This is typically the case when ui.apps is deployed first                -->
                            <!--    Otherwise, create /apps/MultiService/install manually (CRXDE|Lite)  -->
                            <slingUrlSuffix>/apps/MultiService/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.geronimo.specs</groupId>
            <artifactId>geronimo-atinject_1.0_spec</artifactId>
        </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>
               <dependency>
    <groupId>com.day.commons.osgi.wrapper</groupId>
    <artifactId>com.day.commons.osgi.wrapper.commons-email</artifactId>
    <version>1.2.0-0002</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>javax.mail</groupId>
    <artifactId>mailapi</artifactId>
    <version>1.4.3</version>
</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\MultiService.
  2. Run the following maven command: mvn -PautoInstallPackage install.
  3. The OSGi component can be found in the following folder: C:\AdobeCQ\MultiService\core\target. The file name of the OSGi component is MultiService.core-1.0-SNAPSHOT.jar.

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

Configure AEM to use a Mail Server

Configure Experience Manager to use a Mail Server so that the custom workflow step can send email messages. For information, see Configuring Email Notification.

To configure Experience Manager to use a Mail Server, perform these tasks:

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

2. Under the OSGi menu item, select Configuration.

3. Click the + icon that appearts in the Day CQ Mail Service row.

4. Enter the following values:

  • SMTP server host name - the SMTP server that you want to use.
  • SMTP server port - the server port to use, Typically this value is 25. 
  • Username - the user name for the SMTP user. 
  • Password - the corresponding password.

5. Click Save.

Note:

If you are using GMAIL to configure AEM, see Mailing Issue in AEM with Gmail SMTP Configuration.

Configure the Custom Email Service

Configure the custom service by using the Experience Manager Service configuration page. Perform these tasks: 

To configure Experience Manager to use a Mail Server, perform these tasks:

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

2. Under the OSGi menu item, select Configuration.

3. Click the + icon that appearts in the simple mailservice row (named defined in the @Component annotation in EmailServiceImpl class).

4. Enter the following values:

  • mailservice.address - the email address to send an email message to
  • mailservice.username - the email address from which the email is sent from
  • mailservice.label - the label that is used. Enter InternetA and the second configuration enter InternetB to correspond to the value used in the SimpleServlet.

5. Click Save.

Create two configurations named InternetA and InternetB

Create the HTL 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.

Default files created by Adobe Maven 10 Archetype project

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.

Add HTL code

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

/apps/MultiService/components/content/helloworld

 

Add the following HTML code that creates a basic form.

<sly data-sly-use.clientLib="/libs/granite/sightly/templates/clientlib.html" data-sly-call="${clientLib.js @ categories='htlajax'}" data-sly-unwrap/>
<p data-sly-test="${properties.text}">Text property: ${properties.text}</p>
 
 
<h1>AEM HTL Email Template Example</h1>
 
</div>
           
<form method="#">
             
 <table border="1" align="left">
   
 <tr>
 <td>
<label for="hostPrefix" id="hostPrefix">A.2. Host Prefix</label>
 </td>
 <td>
 <input id="hostPrefixF" name="A.2 Host Prefix"  type="text" value="MyHost">
 </td>
 </tr> 
   
  <tr>
 <td>
<label for="forumUrl" id="forumUrl" >B2. Forum Url</label>
 </td>
 <td>
<input id="forumUrlF" name="B1. Forum Url    " type="text" value="www.myurl.com">
 </td>
 </tr> 
 
 <tr>
 <td>
<label for="modifiedByFullname" id="modifiedByFullname" name="modifiedByFullname">C1. Modified By Fullname     </label>
 </td>
 <td>
<input id="modifiedByFullnameF" name="C1. Modified By Fullname    " type="text" value="Tom Blue">
 </td>
 </tr> 
   
 <tr>
 <td>
<label for="TopicSubject">D1. Topic Subject </label>
 </td>
 <td>
<select id="TopicSubjectF" name="Topic Subject ">
              <option value="InternetA">InternetA</option>
              <option value="InternetB">InternetB</option>
             </select>
 </td>
 </tr> 

 <tr>
 <td>
<label for="topicUrl" id="topicUrl" name="topicUrl">E1. Topic URL   </label>
 </td>
 <td>
<input id="topicUrlF" name="topicUrl   " type="text" value="My Topic">
 </td>
 </tr> 
   
 
 <tr>
 <td></td>
   
  <td>
<textarea id="message" rows="4" cols="50">
</textarea>
 </td>
   
 </tr> 
   
 <tr>
 <td></td>
 <td>
<input type="button" value="Submit"  name="submit" id="submit" value="Submit">
  
 </td>
   
 </tr> 
   
 </table>
  
</form>

In this example, notice: references a AEM ClientLibs folder named htlajax. This ClientLibs contains script that performs the AJAX operation and posts data that a user enters into the web page. THis is how you perform AJAX operations from an HTL component. 

Create the ClientLibs folder

In order to perform an AJEX operation to work with a HTL component, you need to create a ClientLibs folder. Add a cq:ClientLibraryFolder node to the Helloworld component located at:

/apps/MultiService/components/content/helloworld

In this folder, add the following two files:

  • js.txt - references the script.js file
  • script.js - contains JavaScript logic that you want to use as part of your HTL component

The following code represents the script.js file

$(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 hostPrefix= $('#hostPrefixF').val() ; 
    var forumUrl= $('#forumUrlF').val() ; 
    var modifiedByFullname= $('#modifiedByFullnameF').val() ; 
    var TopicSubject= $('#TopicSubjectF').val() ; 
    var topicUrl= $('#topicUrlF').val() ; 
    var message= $('#message').val() ; 
 
   
   
    //Use JQuery AJAX request to post data to a Sling Servlet
    $.ajax({
         type: 'POST',    
         url:'/bin/htlMailServlet',
         data:'TopicSubject='+ TopicSubject+'&message='+ message,
         success: function(msg){
  
 
            $('#message').val(msg);   
         }
     });
  });
 
});

Assign the value htlajax to the categories property of the clientlibs node. In addition, assign the value cq.jquery to the dependencies property. This property is required to use AEM JQuery library that lets you use JQuery in the script.

View the output of the HTL component

In edit mode at this URL:

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

In the drop-down field located in the form, you can select InternetA or InternetB. Depending upon which value is selected, the Sling Servlet uses the corresponding version of the Mail Service (the application logic is located in the Sling Servlet developed early in this article).

If InternetA is configured to send an email mesage to Tom Blue and you select InternetA, then Tom Blue will get an email message. Likewise, if InternetB is configured to send an email to Sarah White, then this user will get an email message if InternetB is selected. 

When the Sling Servlet invokes the custom mail service, it returns a message to the client, as shown in the following illustration. 

The following illustration shows the AEM web page if the checkbox is checked. 

The HTL front end

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