Article summary

Summary

Discusses how to develop an AEM 6.3 HTML Template Language (HTL - formerly known as Sightly) component that uses a Sling Model class and invokes a third-party web service. Also discusses how to use the Experience Manager Urber 6.3 JAR.

HTL is the AEM template language that can be used to replace use of JSP when developing an AEM component. HTL helps you to separate your design from your application logic. For more information, see Introduction to the HTML Template Language.

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.3
Audience Developer
Required Skills Java, HTML, JavaScript
Version 6.3

Note:

You can download an AEM package that contains the code 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 write a HTL component that invokes a third-party web service. This community code is for teaching purposes only and not meant to go into production as is.

You can view the sample community application by using the following URL:

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

Download

Prerequisites

This use case works on AEM; however, you may encounter the following exception:

org.apache.sling.commons.classloader.impl.ClassLoaderFacade.loadClass(ClassLoaderFacade.java:127)at java.lang.ClassLoader.loadClass(Unknown Source)at javax.xml.ws.spi.FactoryFinder.safeLoadClass(Unknown Source)... 107 more

To fix this issue and ensure that you can create a bundle that consumes web services as described in this article, modify the sling.properties file located in the crx-quickstart\conf folder. Add the following line of code to this file: sling.bootdelegation.com.sun=com.sun.*. Then restart the server using the JCR file. Once you perform this task, you can follow along with this article.

If you start CQ using the start script, CQ creates a new sling.properties file directly under crx-quickstart folder. If you start the server again using "start" script, it picks the newly created sling.properties file, not the original one(under crx-quickstart\conf folder). Make sure you modify the one under the crx-quickstart folder if you are using the start script as opposed to the JAR file.

 

Important

This Experience Manager example invokes a third-party web service located at:

http://www.webservicex.net/New/Home/ServiceDetail/56  (GetCitiesByCountry)

If you cannot get the result set using this web site, the AEM component will not work as its invoking the same service. Before running this example, ensure that you have a return set using this web page.

Introduction

You can create an Adobe Experience Manager (AEM) 6.3 HTML Template Language (HTL) component that displays data retrieved from a third-party web service. An HTL component can dynamically display a different data set based upon the return value of SOAP web service. For example, assume you want to display cities located in a Country. Using a HTL component dialog, you can specify the Country, such as the United States, and the number of cities to return. A web service call is made from the Java part of the HTL component and the result set is displayed in the HTL component, as shown in the following illustration.

IntroClient
A HTL Component that updates its view based on web service data

The Country and the number of cities to return are specified by the HTL component dialog, as shown here. 

dialog63
A HTL component dialog

This development article steps you through how to build an AEM 6.3 HTL component by using an AEM Maven Archetype 11 project. This HTL uses a Java class uses a Model annotation.

In this article, you develop an OSGi bundle that contains Java proxy classes that were created by using Apache CFX. That is, you can use a tool such as Apache CXF WSDL to Java to generate the Java proxy classes that are based on the WSDL of an external web service. For information about Apache CXF, see WSDL to Java.

Then you can use these Java proxy classes within your OSGi bundle. The OSGi bundle that is created in this development article contains Java proxy classes that consume operations exposed by the following WSDL:

http://www.webservicex.net/globalweather.asmx?WSDL

The web service operation in this article returns a list of cities given the country name.

 

<City>Hudson Bay, Sask</City>
<City>Hope, B. C.</City>
<City>Hamilton Airport</City>
<City>Saint Hubert Airport</City> 
<City>Hay River, N. W. T.</City>

Create Java proxy classes using Apache CXF that consume the soap stack of the external web service

You can use Apache CXF to convert a third-party WSDL to Java proxy classes. These Java classes enable you to invoke operations exposed by the soap stack.

To create Java proxy classes using Apache CXF, perform these steps:

1. Download Apache CFX on the client computer (see http://cxf.apache.org/download.html).

2. Install JDK 1.6 or later.

  • Add the JDK bin directory to your class path.
  • Add the JRE bin directory to your class path. This bin is located in the [JDK_INSTALL_LOCATION]/jre directory.
  • Set the JAVA_HOME environment variable to the directory where you installed the JDK. The JDK 1.6 includes the wsimport program used in the build.xml file. JDK 1.5 does not include that program.

3. Open the command line and change the directory to the apache-cxf-2.6.0\bin. This directory contains the wsdl2java BAT file that you use.

4. Enter the following command:

wsdl2java -p com.aem.ws -d c:\APIs http://www.webservicex.net/globalweather.asmx?wsdl

The -p argument specifies the package in which the Java proxy classes are placed into. The -d argument specifies the directory in which the Java proxy classes are placed into. Finally the URL of the WSDL is specified. These Java proxy classes are imported into a Maven Archetype project used to create the custom AEM service.

The following illustration shows the Java proxy files that Apache CXF creates.

JavaProxyFiles
Java proxy files

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

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

M10
Files generated by Maven 10 Archetype

To create an Experience Manager archetype project, perform these steps:

1. Open the command prompt and go to your working directory (for example, C:\AdobeCQ).

2. Run the following Maven command:

mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate -DarchetypeGroupId=com.adobe.granite.archetypes -DarchetypeArtifactId=aem-project-archetype -DarchetypeVersion=11 -DarchetypeCatalog=https://repo.adobe.com/nexus/content/groups/public/

3. When prompted, specify the following information:

  • groupId - wsHTL63
  • artifactId - wsHTL63
  • version - 1.0-SNAPSHOT
  • package - com.community.htl
  • appsFolderName - wsHTL63
  • artifactName - wsHTL63
  • componentGroupName - wsHTL63
  • contentFolderName - wsHTL63
  • cssId - wsHTL63
  • packageGroup -wsHTL63
  • siteName - wsHTL63

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 wsHTL63 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 HTL API is wsHTL63.core. You do not have to work in the other projects under wsHTL63.

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.

Add the Java proxy files to the project

Create a Java package named com.aem.ws. Import all of the Java proxy classes that were created by using Apache CFX.  Once done, the com.aem.ws package looks like this illustration.

JavaProxyFiles
Java proxy files located in Eclipse

Add Java classes to the project

The next step is to add Java files to the com.community.htl.core.models package. The Java classes are named HeroWSComponent and HeroTextBean. The HeroTextBean is a Java bean that has class members to store data returned from the web service.

In this example, it has these string class members:

  • private ArrayList cityList;
  • private String county;  

For example, the cityList data member stores the cities values that are returned by the web service call. 

The HeroWSComponent class is the Java side of the HTL component and uses the Model annotation. 

HeroTextBean class

The HeroTextBean defines data members and contains getter and setter methods. The following Java code represents this class. 

package com.community.htl.core.models;


import java.util.ArrayList;

public class HeroTextBean {
    
    /** Stores the cities returned by the web service*/
    private ArrayList cityList;
    
     /** Stores the county name */
    private String county; 
       

    public void setList(ArrayList list)
    {
        this.cityList = list; 
    }
     
    public ArrayList getList()
    {
        return this.cityList ; 
    }
     
   
    public void setCounty(String country)
    {
        this.county = country; 
    }
     
    public String getCounty()
    {
        return this.county ; 
    }
   
}

HeroWSComponent class

The HeroWSComponent is the Java server-side part of the AEM HTL component. This class uses the @Model annotation.

@Model(adaptables = Resource.class)

The next thing to notice is the data member named countryName. This uses the @Inject annotation. What is happening here is the value that the AEM author enters into the AEM component dialog field named ./countryName is injected into this data member.

@Inject @Optional
public String countryName

Notice the method named invokeWS. This method uses the Java proxy classes to invoke the web service. This method accepts the country name as a parameter value. It invokes the web service and returns a string that contains cities in XML format.

Next, the method FromXmlString converts the string to a WC3 Document object that represents the XML that contains cities informtion. The FormXMLString method returns the Document instance.

The getAllCities method takes the Document object and populates an ArrayList with names of cities. The size variable, which is obtained from the component dialog, controls the number of cities added to the ArrayList.

The following Java code represents the HeroWSComponent class. 

package com.community.htl.core.models;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.annotation.PostConstruct;
import javax.inject.Inject;
 
import org.apache.sling.api.resource.Resource;
import org.apache.sling.models.annotations.Model;
import org.apache.sling.models.annotations.Optional;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.aem.ws.GlobalWeather;
import com.aem.ws.GlobalWeatherSoap;
  
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
    
  

import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.api.resource.ValueMap;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
  
  
  
import org.w3c.dom.*;
import org.xml.sax.InputSource;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import java.io.StringReader;
import java.io.StringWriter;
 
 
@Model(adaptables = Resource.class)
public class HeroWSComponent {

	 private final Logger LOG = LoggerFactory.getLogger(getClass());
	 
	    @Inject @Optional
	    public String countryName;
	 
	    @Inject @Optional
	    public String countyNum;
	 
	    private HeroTextBean heroTextBean = null;
	    
	    private int size ; 
	     
	    private ArrayList citiesList ;
	 
	    @PostConstruct
	    protected void init() {
	    	
	    	
	    	
	        LOG.info("Web Service Component  **** INIT ***");
	       
	        
	        heroTextBean = new HeroTextBean();
	        
	      //Set variables - we need city and country to make a successful web service call 
	        String number = countyNum; 
	        String country = countryName ;
	        
	        
	        String myXML = invokeWS(country) ; 
	         
	        //populate data member size
	        size = Integer.parseInt(number);
	          
	        //Convert the String XML to WC3 Document 
	        Document cityXML = FromXmlString(myXML) ; 
	          
	        //Populate the List - this list contents will be displayed in the Client part of the HTL component 
	        ArrayList cityList = getAllCities(cityXML) ; 
	          
	          
	        heroTextBean.setList(cityList);
	        heroTextBean.setCounty(country);
	    }
	        
	        
	    //Return a HeroTextBean!    
	    public HeroTextBean getHeroTextBean() {
	        return this.heroTextBean;
	    }
	      
	      
	    //Place the specified number of cities into a List  
	    public ArrayList getAllCities(Document doc)
	    {
	 
	        citiesList = new ArrayList(size);
	 
	        NodeList LineItemAttributeChildrenList = doc.getElementsByTagName("City");
	 
	        if (LineItemAttributeChildrenList != null && LineItemAttributeChildrenList.getLength() > 0)
	        {
	            System.out.println("Inside if and checking length"+LineItemAttributeChildrenList.getLength());
	            for (int i = 0; i < size; i++) {
	 
	                //Add the city to the list! 
	                citiesList.add(LineItemAttributeChildrenList.item(i).getTextContent());
	            }
	        }
	 
	       return  citiesList ;
	 }
	 
	     
	     
	     
	    //Makes a call to the 3rd party SOAP Stack to weather information 
	    private String invokeWS(String country)
	    {
	          
	        try
	        {
	            GlobalWeather global = new GlobalWeather();
	            GlobalWeatherSoap weatherService = global.getGlobalWeatherSoap();
	            String allCities = weatherService.getCitiesByCountry(country) ;
	      
	    return allCities ; 
	        }
	        catch (Exception e)
	        {
	            e.printStackTrace();
	        }
	           
	    return "";      
	  
	    }
	      
	      
	    //Convert String to WC3 Document
	    public Document FromXmlString(String xmlString)
	    {
	        try
	        {
	            DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
	            DocumentBuilder builder = factory.newDocumentBuilder();
	            return builder.parse(new InputSource(new StringReader(xmlString)));
	        }
	        catch(Exception e)
	        {
	            e.printStackTrace();
	        }
	        return null;
	    }
		     
	}

Modify the Maven POM file

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

<dependency>
               <groupId>com.adobe.aem</groupId>
               <artifactId>uber-jar</artifactId>
               <version>6.3.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.

MPP
Parent POM

Add the dependency shown above to the Parent POM file. Next, modify the POM file located at C:\AdobeCQ\wsHTL63\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>wsHTL63</groupId>
        <artifactId>wsHTL63</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <artifactId>wsHTL63.core</artifactId>
    <packaging>bundle</packaging>
    <name>wsHTL63 - Core</name>
    <description>Core bundle for wsHTL63</description>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.sling</groupId>
                <artifactId>maven-sling-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <extensions>true</extensions>
                <executions>
                    <execution>
                        <id>bundle-manifest</id>
                        <phase>process-classes</phase>
                        <goals>
                            <goal>manifest</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <instructions>
                        <!-- Import any version of javax.inject, to allow running on multiple versions of AEM -->
                        <Import-Package>javax.inject;version=0.0.0,*</Import-Package>
                        <Sling-Model-Packages>
                            com.community.htl.core
                        </Sling-Model-Packages>
                    </instructions>
                </configuration>
            </plugin>
        </plugins>
    </build>

    <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.osgi</groupId>
            <artifactId>osgi.core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>osgi.cmpn</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>osgi.annotation</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>uber-jar</artifactId>
            <classifier>apis</classifier>
        </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-core</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\wsHTL.
  2. Run the following maven command: mvn -PautoInstallPackage install.
  3. The OSGi component can be found in the following folder: C:\AdobeCQ\wsHTL\core\target. The file name of the OSGi component is wsHTL.core-1.0-SNAPSHOT.jar.

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

Create the HTL Front End Component

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

crxde
Default files created by Adobe Maven 11 Archetype project

Note:

For information about the default files created by the Maven 11 Archetype project, see this community article: Creating an Adobe Experience Manager 6.3 Project using Adobe Maven Archetype 11.

Add HTL code

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

/apps/wsHTL63/components/content/helloworld

 

Add the following code.

 

 

<p>Web Service Component</p>

<div data-sly-use.heroTextObject="com.community.htl.core.models.HeroWSComponent" data-sly-test="${heroTextObject}">

 <h3>Specified Country:</h3>
 <h3>${heroTextObject.heroTextBean.county}</h2>
<h4>Here are the Cities: </h4>
    <ul data-sly-list="${heroTextObject.heroTextBean.list}"> 
        <li>${item}</li>
    </ul>   
</div>

In this example, notice data-sly-use.heroTextObject references the Java class: com.community.htl.core.models.HeroWSComponent.

The code:

data-sly-test="${heroTextObject}"

checks whether the heroTextObject is null. Next notice these lines of code:

<h4>Here are the Cities: </h4>
<ul data-sly-list="${heroTextObject.heroTextBean.list}">
<li>${item}</li>
</ul>
</div>

In this example, the HTL code is iterating through the ArrayList in the Java class. In this case, heroTextObject.heroTextBean.list maps to the HeroTextBean object's getList method. The HTL writes out the value of each city in the ArrayList in an HTML list. 

 

Create the component dialog

A dialog lets an author click on the component in the Touch UI (or Classic UI) view during design time and enter values that are used by the component. The component created in this development article lets the AEM author enter text values, which are then displayed in the AEM web page. (See the illustration shown at the beginning of this development article.)

A dialog that is built for the Touch UI is defined by using nodes of type un:structured. You define the type of control on the Touch UI dialog by setting the node's sling:resourceType property. For example, to define a text field on a Touch UI dialog, set the sling:resourceType property to granite/ui/components/foundation/form/textfield.

The following table lists the sling:resourceType values that are used to create the component in this development article.

  • granite/ui/components/foundation/container  - defines a container for the dialog
  • granite/ui/components/foundation/layouts/tabs  - defines a tab that is used in the dialog
  • granite/ui/components/foundation/section - defines a section within a tab
  • granite/ui/components/foundation/layouts/fixedcolumns - defines fixed columns
  • granite/ui/components/foundation/form/textfield - defines a text field that lets authors enter data
  • granite/ui/components/foundation/form/textarea - Defines a text area field that lets author more data than a text field

When building a dialog for the Touch UI view, you define the type of control (for example, a text field) by setting the sling:resourceType property. In contrast, when building a dialog for the classic view, you define the type of control by setting its xtype property.

Create the Touch UI Dialog

Perform these tasks to create the AEM Touch UI dialog for the helloworld component:

1. Select /apps/myHTL63/components/content/helloworld.

2. Right click and select Create, Create Node.

3. Enter the following values:

  • Name: cq:dialog
  • Type: nt:unstructured

4. Add the following properties to the cq:dialog node.

  • helppath (String) - en/cq/current/wcm/default_components.html#Carousel
  • jcr:title (String) - Hero Text
  • sling:resourceType (Stgring) - cq/gui/components/authoring/dialog

5. Click on the following node: /apps/myHTL63/components/content/helloworld/cq:dialog.

6. Right click and select Create, Create Node. Enter the following values:

  • Name: content
  • Type: nt:unstructured

7. Add the following property to the content node.

  • sling:resourceType (String) - granite/ui/components/foundation/container

8. Click on the following node: /apps/myHTL63/components/content/helloworld/cq:dialog/content.

9. Right click and select Create, Create Node. Enter the following values:

  • Name: layout
  • Type: nt:unstructured

10. Add the following properties to the layout node.

  • sling:resourceType (String) - granite/ui/components/foundation/layouts/tabs
  • type (String) -nav

11. Click on the following node: /apps/myHTL63/components/content/helloworld/cq:dialog/content.

12. Right click and select Create, Create Node. Enter the following values:

  • Name: items
  • Type: nt:unstructured

13. Click on the following node: /apps/myHTL63/components/content/helloworld/cq:dialog/content/items.

14. Right click and select Create, Create Node. Enter the following values:

  • Name: herotext
  • Type: nt:unstructured

15. Add the following properties to the herotext node (this node represents the tab).

  • jcr:title (String) - Hero Text Properties
  • sling:resourceType (String) - granite/ui/components/foundation/section

16. Click on the following node: /apps/myHTL63/components/content/helloworld/cq:dialog/content/items/herotext.

17. Right click and select Create, Create Node. Enter the following values:

  • Name: layout
  • Type: nt:unstructured

18. Add the following property to the layout node.

  • sling:resourceType (String) - granite/ui/components/foundation/layouts/fixedcolumns

19. Click on the following node: /apps/myHTL63/components/content/helloworld/cq:dialog/content/items/herotext.

20. Right click and select Create, Create Node. Enter the following values:

  • Name: items
  • Type: nt:unstructured

21. Click on the following node: /apps/myHTL63/components/content/helloworld/cq:dialog/content/items/herotext/items.

22. Right click and select Create, Create Node. Enter the following values:

  • Name: columns
  • Type: nt:unstructured

23. Click on the following node: /apps/myHTL63/components/content/helloworld/cq:dialog/content/items/herotext/items/column.

24. Add the following property to the columns node.

  • sling:resourceType (String) - granite/ui/components/foundation/container

25. Click on the following node: /apps/myHTL63/components/content/helloworld/cq:dialog/content/items/herotext/items/column.

26. Right click and select Create, Create Node. Enter the following values:

  • Name: items
  • Type: nt:unstructured

27. Click on the following node: /apps/myHTL63/components/content/helloworld/cq:dialog/content/items/herotext/items/column/items.

28. Right click and select Create, Create Node. Enter the following values:

  • Name: headingText
  • Type: nt:unstructured

29. Click on the following node: /apps/myHTL63/components/content/helloworld/cq:dialog/content/items/herotext/items/column/items/headingText.

30. Add the following properties to the headingText node (this node represents the Heading Text input control on the dialog. See the illustration at the start of this article.)

  • fieldLabel (String) - Country
  • name (String) - ./countryName
  • sling:resourceType (String) - granite/ui/components/foundation/form/textfield

31. Click on the following node: /apps/myHTL/components/content/helloworld/cq:dialog/content/items/herotext/items/column/items.

32. Right click and select Create, Create Node. Enter the following values:

  • Name: description
    Type: nt:unstructured

33. Click on the following node: /apps/myHTL/components/content/helloworld/cq:dialog/content/items/herotext/
items/column/items/description.

34. Add the following property to the description node (this node represents the Description input control on the dialog. See the illustration at the start of this article.)

  • fieldLabel (String) - Number of cities
  • name (String) - ./countryNum
  • sling:resourceType (String) - granite/ui/components/foundation/form/textfield

View the output of the HTL component

To access the component, enter the following URL:

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

The following illustration shows the HTL component.

IntroClient
Output of the HTL component

Note:

Be sure to set the values in the component dialog. 

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