Article summary

Summary

Discusses how to develop an AEM HTML Template Language (HTL - formerly known as Sightly) component that displays YouTube videos.

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 specical thank you to Prince Shivhare and Tousif for contributing an AEM package on which this article was based. 

A special thank you to Ratna Kumar Kotla, a  top AEM community member, 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

Download

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 displays a YouTube video. 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/AEMVideo/en.html (assuming you deploy on author).

Introduction

Displaying video content within a web site is a typical requirement for Experience Manager authors. Furthermore, the video may not be located within the AEM DAM, but rather a YouTube video. To address this requirement, you can create a custom component that can display a YouTube video. 

In addition, you can develop the component to retrieve information about the video and display the information within the component, as shown in the following illustration. The component developed in this article is built using HTL, which helps you to separate your design from your application logic. For more information, see Introduction to the HTML Template Language.

Intro
An AEM YouTube component displaying a video

To select the YouTube video, an AEM author provides the Video ID in a component dialog.

dialog
A YouTube video ID is specified in the component dialog

This development article covers the following tasks:

  1. Performs a Restful call to a YouTube service and retrieves the JSON response by using JSONObject instance.
  2. Plays the video within an Experience Manager page without the need to use an Iframe.
  3. Video title and channel name are shown using an accordion widget.

This development article steps you through how to build an AEM HTL component by using an AEM Maven Archetype 10 project. This HTL uses a Java class that extends com.adobe.cq.sightly.WCMUsePojo. For information, see com.adobe.cq.sightly.WCMUsePojo.

Note:

The Java class com.adobe.cq.sightly.WCMUse is deprecated.

Setup Maven in your development environment

You can use Maven to build an OSGi bundle. 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
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 - AEMVideo
  • artifactId - AEMVideo
  • version - 1.0-SNAPSHOT
  • package - com.aem.community.aem
  • appsFolderName - AEMVideo
  • artifactName - AEMVideo
  • componentGroupName - AEMVideo
  • contentFolderName - AEMVideo
  • cssId - AEMVideo
  • packageGroup -AEMVideo
  • siteName - AEMVideo

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 AEMVideo 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 project dialog

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

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.aem.community.core package. The Java classes are named YoutubeComponentC and YoutubePojo

YoutubePojo class

The YoutubePojo is a Java bean that has class members to store details about the given YouTube video. The information is obtained by using a Restful call and the information is returned in JSON format.

The YoutubePojo class has these string class members:

  • videohtml 
  • videoid 
  • videotitle
    • video_author_name

The following Java code represents the YoutubePojo class.

package com.aem.community.core;

public class YoutubePojo
{
  private String videohtml;
  private String videoid;
  private String videotitle;
  private String video_author_name;
  
  public String getVideoid()
  {
    return this.videoid;
  }
  
  public void setVideoid(String videoid)
  {
    this.videoid = videoid;
  }
  
  public String getVideotitle()
  {
    return this.videotitle;
  }
  
  public void setVideotitle(String videotitle)
  {
    this.videotitle = videotitle;
  }
  
  public String getVideo_author_name()
  {
    return this.video_author_name;
  }
  
  public void setVideo_author_name(String video_author_name)
  {
    this.video_author_name = video_author_name;
  }
  
  public String getVideohtml()
  {
    return this.videohtml;
  }
  
  public void setVideohtml(String videohtml)
  {
    this.videohtml = videohtml;
  }
}

YoutubeComponentC class


	




The YoutubeComponentC class is the Java side of the HTL component and extends WCMUsePojo, which is an abstract class that implements the Use interface. A HTL component's Java class must implement this abstract class. 


The activate method gets the value of the video id that an author specifies in the component dialog.

if (currentNode.hasProperty("jcr:videoid")) {
videoid = currentNode.getProperty("./jcr:videoid").getString();
}

This value is used in a Restful call to a YouTube service to obtain information about the video that corresponds to the video. Information is returned within JSON.

DefaultHttpClient httpClient = new DefaultHttpClient();

HttpGet getRequest = new HttpGet("https://www.youtube.com/oembed?url=http://www.youtube.com/watch?v=" + videoid + "&format=json");
getRequest.addHeader("accept", "application/json");

HttpResponse response = httpClient.execute(getRequest);
if (response.getStatusLine().getStatusCode() != 200)
{
log.info("exception");

throw new RuntimeException("Failed : HTTP error code : " + response.getStatusLine().getStatusCode());
}
BufferedReader br = new BufferedReader(new InputStreamReader(response.getEntity().getContent()));

String myJSON = "";
String output;
while ((output = br.readLine()) != null) {
myJSON = myJSON + output;
}

Then the JSON values are stored in the YoutubePojo data members. Once they are stored in the data members, the HTL logic can display them (this is shown later in this development article).


The following Java code represents the YoutubeComponentC class.

package com.aem.community.core;

import com.adobe.cq.sightly.WCMUsePojo;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import javax.jcr.Node;
import javax.jcr.Property;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.StatusLine;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.conn.ClientConnectionManager;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.commons.json.JSONObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class YoutubeComponentC
  extends WCMUsePojo
{
  private YoutubePojo youtubepojo = null;
  protected static final Logger log = LoggerFactory.getLogger(YoutubeComponentC.class.getClass());
  
  public void activate()
    throws Exception
  {
    Node currentNode = (Node)getResource().adaptTo(Node.class);
    this.youtubepojo = new YoutubePojo();
    
    String videoid = "oeO6zwjxyQw";
    if (currentNode.hasProperty("jcr:videoid")) {
      videoid = currentNode.getProperty("./jcr:videoid").getString();
    }
    log.info("**** Video ID " + videoid);
    
    String jsonstr = getJSON(videoid);
    JSONObject youtubeJson = new JSONObject(jsonstr);
    this.youtubepojo.setVideotitle(youtubeJson.get("title").toString());
    this.youtubepojo.setVideo_author_name(youtubeJson.get("author_name").toString());
    this.youtubepojo.setVideohtml(youtubeJson.getString("html").toString());
  }
  
  public YoutubePojo getYoutubepojo()
  {
    return this.youtubepojo;
  }
  
  public static String getJSON(String videoid)
  {
    try
    {
      DefaultHttpClient httpClient = new DefaultHttpClient();
      
      HttpGet getRequest = new HttpGet("https://www.youtube.com/oembed?url=http://www.youtube.com/watch?v=" + videoid + "&format=json");
      getRequest.addHeader("accept", "application/json");
      
      HttpResponse response = httpClient.execute(getRequest);
      if (response.getStatusLine().getStatusCode() != 200)
      {
        log.info("exception");
        
        throw new RuntimeException("Failed : HTTP error code : " + response.getStatusLine().getStatusCode());
      }
      BufferedReader br = new BufferedReader(new InputStreamReader(response.getEntity().getContent()));
      
      String myJSON = "";
      String output;
      while ((output = br.readLine()) != null) {
        myJSON = myJSON + output;
      }
      log.info("**** Myjson: " + myJSON);
      httpClient.getConnectionManager().shutdown();
      
      return myJSON;
    }
    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\AEMVideo.

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

PPom
Parent POM

Add the dependency shown above to the Parent POM file. Next, modify the POM file located at C:\AdobeCQ\AEMVideo\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>AEMVideo</groupId>
        <artifactId>AEMVideo</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <artifactId>AEMVideo.core</artifactId>
    <packaging>bundle</packaging>
    <name>AEMVideo - Core</name>
    <description>Core bundle for AEMVideo</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.aem.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/AEMVideo/install to exist!!          -->
                            <!--    This is typically the case when ui.apps is deployed first                -->
                            <!--    Otherwise, create /apps/AEMVideo/install manually (CRXDE|Lite)  -->
                            <slingUrlSuffix>/apps/AEMVideo/install/</slingUrlSuffix>
                            <failOnError>true</failOnError>
                        </configuration>
                    </plugin>
                </plugins>
            </build>
        </profile>
    </profiles>
   <dependencies>
        <!-- OSGi 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>com.google.code.gson</groupId>
        <artifactId>gson</artifactId>
        <version>2.8.0</version>
    </dependency>
 
 
        <dependency>
            <groupId>org.apache.httpcomponents</groupId>
            <artifactId>httpclient</artifactId>
            <version>4.1.1</version>
        </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\AEMVideo.
  2. Run the following maven command: mvn -PautoInstallPackage install.
  3. The OSGi component can be found in the following folder: C:\AdobeCQ\AEMVideo\core\target. The file name of the OSGi component is AEMVideo.core-1.0-SNAPSHOT.jar.

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

Create an Experience Manager Touch UI component

Create the YouTube component by performing these tasks using CRXDE Lite:

1. Right click on /apps/AEMVideo/components/content and then select New, Component.

2. Enter the following information into the Create Component dialog box:

  • Label: The name of the component to create. Enter youtube-component.
  • Title: The title that is assigned to the component. Enter youtube-component.
  • Description: The description that is assigned to the template. Enter: A YouTube component.
    Super Resource Type: Enter foundation/components/parbase.
    Group: The group in the side kick where the component appears. Enter AEMVideo.

4. Click Ok.

Build the Touch UI dialog

A dialog lets an author click on the component in the Touch 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 a YouTube video ID. (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 list describes the sling:resourceType values that are used to create the component in this development article.

  • granite/ui/components/foundation/container
  • granite/ui/components/foundation/layouts/tabs
  • granite/ui/components/foundation/section
  • granite/ui/components/foundation/layouts/fixedcolumns
  • granite/ui/components/foundation/form/textarea

 

Note:

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. 

The following illustration shows the JCR nodes of the component
created in this development article.

dialogNodes

To build the Touch UI dialog, perform these tasks:

1. Select /apps/AEMVideo/components/content/youtube-component.

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.

  • jcr:title (String) – Properties
  • sling:resourceType (String) - cq/gui/components/authoring/dialog

5. Click on the following node: /apps/AEMVideo/components/content/youtube-component/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/AEMVideo/components/content/youtube-component/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/fixedcolumns

11. Click on the following node: /apps/AEMVideo/components/content/youtube-component/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/AEMVideo/components/content/youtube-component/cq:dialog/content /items.

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

  • Name: column
  • Type: nt:unstructured

15. Add the following property to the column node.

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

16. Click on the following node: /apps/AEMVideo/components/content/youtube-component/cq:dialog/content/items/column.

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

  • Name: items
  • Type: nt:unstructured

18. Click on the following node: /apps/AEMVideo/components/content/youtube-component/cq:dialog/content/items/column/items.

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

  • Name: text
  • Type: nt:unstructured

18. Add the following properties to the text node.

  • FieldLabel (String) - Video id
  • Name (String) - ./jcr:videoid
  • sling:resourceType (String) - granite/ui/components/foundation/form/textfield

Add the HTL Code

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

/apps/AEMVideo/components/content/youtube-component/youtube-component.html

Change the file extention to .html and add the following code.

<!-- <sly data-sly-use.clientlib="/libs/granite/sightly/templates/clientlib.html" data-sly-call="${clientlib.all @ categories='youtubecss.comp'}"/> -->
<html>
<head>

<style>
button.accordion {
    background-color: #eee;
    color: #444;
    cursor: pointer;
    padding: 18px;
    width: 480px;
    border: none;
    text-align: left;
    outline: none;
    font-size: 15px;
    transition: 0.4s;
    font-family:  "Times New Roman", Times, serif;
     font-size: 20px;
}

button.accordion.active, button.accordion:hover {
    background-color: #ddd;
}

button.accordion:after {
    content: '\002B';
    color: #777;
    font-weight: bold;
    float: right;
    margin-left: 5px;
}

button.accordion.active:after {
    content: "\2212";
}

div.panel {
    padding: 0px 18px;
    margin:6px;
    background-color: white;
    max-height: 0;
    overflow: hidden;
    transition: max-height 0.2s ease-out;
    font-family:  "Times New Roman", Times, serif;
     font-size: 20px;
     width:480px;
}
</style>
</head>
<body>

<!-- /* YouTube Component */ -->

<h1> Youtube Video </h1>
<sly data-sly-use.hello="com.aem.community.core.YoutubeComponentC" />

Video: <br> ${hello.Youtubepojo.videohtml @ context='html'}

<button class="accordion">Video title:</button>
<div class="panel">
<p> ${hello.Youtubepojo.videotitle}</p></div>

<button class="accordion">Video Author:</button>
<div class="panel">
<p> ${hello.Youtubepojo.video_author_name}</p></div>

<script>
var acc = document.getElementsByClassName("accordion");
var i;

for (i = 0; i < acc.length; i++) {
  acc[i].onclick = function() {
    this.classList.toggle("active");
    var panel = this.nextElementSibling;
    if (panel.style.maxHeight){
      panel.style.maxHeight = null;
    } else {
      panel.style.maxHeight = panel.scrollHeight + "px";
    } 
  }
}
</script>

<!-- /* Checkbox code to check if link needs to open in new tab. */ -->
<hr>
<div><a target='${properties.isChecked ? "_blank" : "_self"}' href="${properties.path @ extension = 'html'}">${properties.name}</a>
</div>
<hr>
<!-- /* Code to check if link entered in path in Dialog */ -->

<div data-sly-test.socialshare="${properties.social1}">
<A HREF="${properties.social1}"  title="Facebook" width="50px" target="_blank"><img src="/content/dam/YouTubeComponent/png-facebook-icon-194.jpg"  alt="Facebook" ></A>
</div>

<!-- /* Code if link is not given in dialog then hide it from front end */ -->

<div data-sly-test="${!socialshare}">
<A data-sly-test="${''}" HREF="${properties.social1}"  title="Facebook" target="_blank"><img src="/content/dam/YouTubeComponent/png-facebook-icon-194.jpg"  alt="Facebook" ></A> 
</div>
</body>
</html>

View the output of the HTL component

The final task is to drag and drop the YouTube component from the Side Rail to the AEM web page located at:

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

Click on the component and specify the video id of a YouTube video, as shown in the following illustration.

ClientPage
Drag and drop the YouTube component into the AEM web page

Note:

A video ID can be obtained from the URL of the video. For example, given this URL: https://www.youtube.com/watch?v=oeO6zwjxyQw, the ID is oeO6zwjxyQw

Open the dialog and enter the video id value. The video appears in the AEM web page, as shown here.

Final
An AEM Web Page displaying a YouTube video

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