Article summary

Summary

Discusses how to create your first Adobe Experience Manager (AEM) 6 custom social component by using Maven and an Adobe Archetype project. The use case in this development article is to customize the AEM social comment component.  

A special thank you to Siddharth Palaniswami a senior AEM engineer for contributing towards this article. 

Digital Marketing Solution(s) Adobe Experience Manager (Adobe CQ)
Audience
Developer (Intermedicate)
Required Skills
Java, Maven, HTML
Tested On Adobe Experience Manager 6 (AEM 6)

Introduction

Adobe Experience Manager (AEM) 6 supports social components that let you build web sites that contain social functionality that lets you engage with your customers. For example, you can add functionality that lets your users leave comments on your website. AEM supports out of the box socials components. For information, see Introduction to Social Communities.

AEM also supports the ability to customize these social components to meet your business requirements. You can use the AEM Social Component Framework Java API to create a custom social component. An user can interact with an AEM web site by interacting with functionality exposed by your custom social component.

 

 

SOCO

An AEM social component forms the basis of HTTP API responses and the context made available to a front end component. Sometimes you need to add more information or hide information to the default social component to meet your business requirement. You can achieve this use case by writing an AEM OSGi bundle that uses the AEM Social Component Framework Java API located in the com.adobe.cq.social.commons.client.api package. For information about this API, see Package com.adobe.cq.social.commons.

For example, you can modify the appearance of the AEM comment system by using AEM Java APIs.

commentsPage


This development article walks you through how to customize the AEM social comment component. Assume that your requirement is to hide the 'author' object (which has more details about the author).

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:

Java home: C:\Programs\Java64-6\jre
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:

Sometimes Maven reads the settings.xml file from under its install folder. For example, instead of reading the settings.xml file from user\m2, it reads from apache-maven-3.2.1\.m2. Make sure that Maven is reading the settings.xml from the correct location. Otherwise, Maven will not successfully build an AEM Maven Archetype project.

Create an Experience Manager archetype project 

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

plugin1

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 -DarchetypeRepository=https://repo.adobe.com/nexus/content/groups/public/ -DarchetypeGroupId=com.day.jcr.vault -DarchetypeArtifactId=multimodule-content-package-archetype -DarchetypeVersion=1.0.2 -DgroupId=com.adobe.cq.social.custom.comment -DartifactId=soco -Dversion=1.0-SNAPSHOT -Dpackage=com.adobe.cq.social.custom.comment -DappsFolderName=myproject -DartifactName="My Project" -DcqVersion="5.6.1" -DpackageGroup="My Company"

3. When prompted for additional information, specify Y.

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

[INFO] Finished at: Wed Mar 27 13:38:58 EDT 2013
[INFO] Final Memory: 10M/184M

5. Change the command prompt to the generated project. For example: C:\AdobeCQ\soco. Run the following Maven 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

 

Note:

Eclipse is not used to build the project or even compile it. In this use case, you use Eclipse to view and edit the Java files and the project POM file. Do not worry about the errors that are displayed in the Eclipse IDE. You are using Maven to build the OSGi bundle from the command line, not Eclipse.  

In order to override the AEM comment social component, perform these tasks using the AEM Social Framework Java API:  

  1. Implement com.adobe.cq.social.commons.comments.api.Comment. See CustomComment.java below.
  2. Implement a com.adobe.cq.social.commons.client.api.SocialComponentFactory for Comment. Make it return your implementation of Comment and also set a higher priority so that it is given preference over the existing AEM comment factory. See CustomCommentFactory.java below
  3. CustomComment.java does not need to implement all the methods that are required by the Comment API. It delegates them to the default AEM comment (the out-of-the-box comment implementation) by extending the com.adobe.cq.social.commons.comments.api.AbstractComment class. It only implements any additional methods to provide or override. For example, to add a new field to the JSON produced by the comment component, add a new getter to this class. To hide an existing field, make the getter method return null or return an empty result. (This is shown below as the getAuthor method returns null).
  4. CustomCommentFactory.java registers the CustomComment with the framework and informs AEM that this factory can be used when retrieving comments. It also extends the existing AEM comment factory so that it can register itself as the provider for any resource type that the out-of-the-box factory registers for.   

The next step is to add the following files to the com.adobe.cq.social.custom.comment package:

  • A Java class named CustomComment. This class extends AbstractComment and implements Comment.
  • A Java class named CustomCommentFactory. This class extends CommentSocialComponentFactory and implements SocialComponentFactory.

Note:

Make sure that you work in the Eclipse project named soco-bundle. You can delete soco-content from Eclipse. Also be sure to work in the scr/main/java folder.  

CustomComment class

The CustomComment class defines the behaviour of your custom comment component. In this example, notice that the getAuthor method returns null. This results in the comment component not displaying author information. (This is shown later in this development article.)

package com.adobe.cq.social.custom.comment;

import java.util.Calendar;
import java.util.List;
import java.util.Map;

import javax.jcr.RepositoryException;

import org.apache.sling.api.resource.Resource;

import com.adobe.cq.social.commons.client.api.BaseSocialComponent;
import com.adobe.cq.social.commons.client.api.ClientUtilities;
import com.adobe.cq.social.commons.client.api.CollectionPagination;
import com.adobe.cq.social.commons.client.api.CollectionSortedOrder;
import com.adobe.cq.social.commons.client.api.QueryRequestInfo;
import com.adobe.cq.social.commons.client.api.ResourceID;
import com.adobe.cq.social.commons.client.api.SocialComponent;
import com.adobe.cq.social.commons.client.api.User;
import com.adobe.cq.social.commons.comments.api.AbstractComment;
import com.adobe.cq.social.commons.comments.api.Comment;
import com.adobe.cq.social.commons.comments.api.CommentCollectionConfiguration;
import com.adobe.cq.social.commons.comments.listing.CommentSocialComponentListProviderManager;
import com.adobe.cq.social.commons.moderation.impl.FlagReason;
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;

public class CustomComment extends AbstractComment<CommentCollectionConfiguration> implements Comment<CommentCollectionConfiguration> {
    
    
    /**
* Construct a comment for the specified resource and client utilities.
* @param resource the specified resource
* @param clientUtils the client utilities instance
* @param commentListProviderManager list manager to use for listing content
* @throws RepositoryException if an error occurs
*/
    public CustomComment(final Resource resource, final ClientUtilities clientUtils,
        final CommentSocialComponentListProviderManager commentListProviderManager) throws RepositoryException{
        super(resource, clientUtils, commentListProviderManager);
    }
    
    /**
* Constructor of a comment.
* @param resource the specified {@link com.adobe.cq.social.commons.Comment}
* @param clientUtils the client utilities instance
* @param queryInfo the query info.
* @param commentListProviderManager list manager to use for listing content
* @throws RepositoryException if an error occurs
*/
    public CustomComment(final Resource resource, final ClientUtilities clientUtils,
        final QueryRequestInfo queryInfo, final CommentSocialComponentListProviderManager commentListProviderManager)
        throws RepositoryException {
        super(resource, clientUtils, queryInfo, commentListProviderManager);
    }

    /* (non-Javadoc)
* Example on how you can remove data from the HTTP API or Handlebars template context for a Comment.
* Simply return a null or empty if you wish to hide a piece of data.
* @see com.adobe.cq.social.commons.comments.api.Comment#getAuthor()
*/
    @Override
    @JsonIgnore
    public User getAuthor() {
        return null;
    }

    /**
* This is an example of how you can add data to the HTTP API and Handlebars templates context for a Comment.
* @return returns the authorID of the user who created this comment.
*/
    public String getAuthorId() {
        return this.getAuthor().getUserId();
    }

}

CustomCommentFactory class

The CustomCommentFactory class extends the default CommentSocialComponentFactory. This makes it possible to perform required changes for customization and to register the custom component with the system to be used for all comment resources. Note that the getPriority method returns a value greater than 0, this ensures that your custom component takes priority over other out-of-the-box implementations.

This class uses the following Apache Felix SCR annotations to create the OSGi component:

  • @Component - defines the class as a component
  • @Service - defines the service interface that is provided by the component
  • @Reference - injects a class member into the service 

These Apache Felix SCR annotations are required in order to create an AEM service based on the Java logic located in the CustomCommentFactory interface. For information about Apache Felix SCR annotations, see http://felix.apache.org/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.html.

A class member named commentListProviderManager of type CommentSocialComponentListProviderManager is injected into this service. This managed instance is used to return a CustomComment instance, as shown in this code example.

@Override
public SocialComponent getSocialComponent(final Resource resource) {
try {
    return new CustomComment(resource,     this.getClientUtilities(resource.getResourceResolver()),commentListProviderManager);
} catch (RepositoryException e) {
    return null;
}
}

The following Java code represents the CustomCommentFactory class.  

 

package com.adobe.cq.social.custom.comment;

import javax.jcr.RepositoryException;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.resource.Resource;

import com.adobe.cq.social.commons.client.api.ClientUtilities;
import com.adobe.cq.social.commons.client.api.QueryRequestInfo;
import com.adobe.cq.social.commons.client.api.SocialComponent;
import com.adobe.cq.social.commons.client.api.SocialComponentFactory;
import com.adobe.cq.social.commons.comments.api.Comment;
import com.adobe.cq.social.commons.comments.api.CommentSocialComponentFactory;
import com.adobe.cq.social.commons.comments.listing.CommentSocialComponentListProviderManager;

/**
* CustomCommentFactory extends the default CommentSocialComponentFactory to leverage the default comment social
* component implementation. This makes it possible to only make changes needed for customization without having to
* implement all the APIs specified by {@link Comment}.
*/
@Component(name = "Custom Comment Social Component Factory")
@Service
public class CustomCommentFactory extends CommentSocialComponentFactory implements SocialComponentFactory {
    
    @Reference
    private CommentSocialComponentListProviderManager commentListProviderManager;

    @Override
    public SocialComponent getSocialComponent(final Resource resource) {
        try {
            return new CustomComment(resource, this.getClientUtilities(resource.getResourceResolver()),commentListProviderManager);
        } catch (RepositoryException e) {
            return null;
        }
    }

    @Override
    public SocialComponent getSocialComponent(final Resource resource, final SlingHttpServletRequest request) {
        try {
            return new CustomComment(resource, this.getClientUtilities(request),this.getQueryRequestInfo(request),commentListProviderManager);
        } catch (RepositoryException e) {
            return null;
        }
    }
    
    @Override
    public SocialComponent getSocialComponent(Resource resource, ClientUtilities clientUtils, QueryRequestInfo listInfo) {
        try {
            return new CustomComment(resource, clientUtils, listInfo,commentListProviderManager);
        } catch (RepositoryException e) {
            return null;
        }
    }


    /*
* (non-Javadoc)
* @see com.adobe.cq.social.commons.client.api.AbstractSocialComponentFactory#getPriority() Set the priority to a
* number greater than 0 to override the default SocialComponentFactory for comments.
*/
    @Override
    public int getPriority() {
        return 10;
    }

}

Note:

Notice that there is another class in the com.adobe.cq package named SimpleDSComponent. To create the custom comment component, you do not have to further modify this class. However, it has to be part of the build, so don't delete this class. This class contains methods, such as activate, that are invoked by the OSGi service container. You can add application logic to these methods. For example, you can add logging application logic to the activate method that is called when the OSGi bundle is placed into an active state.

Modify the Maven POM file 

Modify the POM file visible from the Eclipse IDE, as shown in the following illustration.

POM2

Notice that this POM file contains required dependencies such as org.apache.felix.scr and org.apache.felix.scr.annotations in the dependencies section. Copy the following XML code to your POM file.

<?xml version="1.0" encoding="UTF-8"?>
<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/maven-v4_0_0.xsd ">
    <modelVersion>4.0.0</modelVersion>
    <!-- ====================================================================== -->
    <!-- P A R E N T P R O J E C T D E S C R I P T I O N -->
    <!-- ====================================================================== -->
    <parent>
        <groupId>com.adobe.cq.social.custom.comment</groupId>
        <artifactId>soco</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <!-- ====================================================================== -->
    <!-- P R O J E C T D E S C R I P T I O N -->
    <!-- ====================================================================== -->

    <artifactId>soco-bundle</artifactId>
    <packaging>bundle</packaging>
    <name>soco training Bundle</name>

    <!-- ====================================================================== -->
    <!-- B U I L D D E F I N I T I O N -->
    <!-- ====================================================================== -->
    <build>

        <plugins>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-scr-plugin</artifactId>
                <executions>
                    <execution>
                        <id>generate-scr-descriptor</id>
                        <goals>
                            <goal>scr</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <extensions>true</extensions>
                <configuration>
                    <instructions>
                        <Bundle-SymbolicName>com.adobe.cq.social.custom.comment.soco-bundle</Bundle-SymbolicName>
                    </instructions>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.sling</groupId>
                <artifactId>maven-sling-plugin</artifactId>
                <configuration>
                    <slingUrl>http://${crx.host}:${crx.port}/apps/soco/install</slingUrl>
                    <usePut>true</usePut>
                </configuration>
            </plugin>
        </plugins>
    </build>

    <dependencies>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>2.2.2</version>
        </dependency>
        <dependency>
            <groupId>org.apache.sling</groupId>
            <artifactId>org.apache.sling.api</artifactId>
            <version>2.4.2</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>com.adobe.cq.social</groupId>
            <artifactId>cq-social-ugcbase</artifactId>
            <version>1.1.34</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>com.adobe.cq.social</groupId>
            <artifactId>cq-social-commons</artifactId>
            <version>1.4.145</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>com.adobe.cq.social</groupId>
            <artifactId>cq-social-forum</artifactId>
            <version>1.3.80</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>com.adobe.granite</groupId>
            <artifactId>com.adobe.granite.activitystreams</artifactId>
            <version>0.0.8</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>com.adobe.granite</groupId>
            <artifactId>com.adobe.granite.security.user</artifactId>
            <version>0.0.14</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>com.adobe.granite</groupId>
            <artifactId>com.adobe.granite.comments</artifactId>
            <version>1.0.2</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>biz.aQute</groupId>
            <artifactId>bndlib</artifactId>
            <version>1.43.0</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>com.adobe.granite</groupId>
            <artifactId>com.adobe.granite.xssprotection</artifactId>
            <version>5.5.8</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
            <version>2.4</version>
        </dependency>
        <dependency>
            <groupId>javax.jcr</groupId>
            <artifactId>jcr</artifactId>
            <version>2.0</version>
        </dependency>
        <dependency>
                <groupId>org.apache.felix</groupId>
                <artifactId>org.apache.felix.scr.annotations</artifactId>
                <version>1.9.4</version>
                <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>com.day.cq.wcm</groupId>
            <artifactId>cq-wcm-webservice-support</artifactId>
            <version>5.6.4</version>
            <scope>provided</scope>
        </dependency>
 <dependency>
	<groupId>com.adobe.aem</groupId>
	<artifactId>aem-api</artifactId>
	<version>6.0.0.1</version>
	<scope>provided</scope>
</dependency>

    </dependencies>

<repositories>
        <repository>
            <id>adobe</id>
            <name>Adobe Public Repository</name>
            <url>http://repo.adobe.com/nexus/content/groups/public/</url>
            <layout>default</layout>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>adobe</id>
            <name>Adobe Public Repository</name>
            <url>http://repo.adobe.com/nexus/content/groups/public/</url>
            <layout>default</layout>
        </pluginRepository>
    </pluginRepositories>
</project>

Build the OSGi bundle using Maven

To build the OSGi component by using Maven, perform these steps:

  1. Open the command prompt and go to the C:\AdobeCQ\soco folder.
  2. Run the following maven command: mvn clean install.
  3. The OSGi component can be found in the following folder: C:\AdobeCQ\soco\bundle\target. The file name of the OSGi component is soco-bundle-1.0-SNAPSHOT.jar.

Deploy the bundle to Experience Manager

Once you deploy the OSGi bundle, the functionality that is located in the custom comment section is used. (this is shown later in this development article). After you deploy the OSGi bundle, you will be able to see it in the Apache Felix Web Conole. In the following illustration, notice that details about the OSGi bundle are displayed. For example, noice that exported packages is com.adobe.cq.social.custom.comment.

OSGiComment

Deploy the OSGi bundle that contains custom comment component to Experience Manager by performing these steps:

  1. Login to Apache Felix Web Console at http://server:port/system/console/bundles (default admin user = admin with password= admin).
  2. Click the Bundles tab, sort the bundle list by Id, and note the Id of the last bundle.
  3. Click the Install/Update button.
  4. Browse to the bundle JAR file you just built using Maven. (C:\AdobeCQ\soco\bundle\target).
  5. Click Install.
  6. Click the Refresh Packages button.
  7. Check the bundle with the highest Id.
  8. Click Active.
  9. Your new bundle should now be listed with the status Active.
  10. If the status is not Active, check the CQ error.log for exceptions. 

View the AEM custom social component results

After you deploy the custom social component, you can view its results. The default AEM social comment component produces this JSON.

{

   "id": "/content/community-components/en/comments/jcr:content/content/comments",

   "properties": {

      "jcr:created": "2013-12-06T12:28:13.834-05:00",

      "jcr:createdBy": "admin",

      "jcr:lastModified": "2013-12-06T12:28:13.834-05:00",

      "jcr:primaryType": "nt:unstructured",

      "jcr:lastModifiedBy": "admin"

   },

   "lastModified": 1386350893834,

   "created": 1386350893834,

   "pageInfo": {

      "basePageURL": "/content/community-components/en/comments",

      "pageSize": 10,

      "selectedIndex": null,

      "selectedPage": 1,

      "currentIndex": 0,

      "nextPageURL": "/content/community-components/en/comments/_jcr_content/content/comments.social.1.10.json",

      "previousPageURL": "/content/community-components/en/comments/_jcr_content/content/comments.social.0.10.json",

      "previousSuffix": "0.10",

      "urlpattern": "/content/community-components/en/comments/_jcr_content/content/comments.social.${startIndex}.10.json",

      "totalPages": 1,

      "nextSuffix": "1.10"

   },

   "configuration": {

      "pageSize": 10,

      "isVotingAllowed": false,

      "isAttachmentAllowed": false,

      "isCustomFlagReasonAllowed": false,

      "isRTEEnabled": false

   },

   "totalSize": 1,

   "items": [

      {

         "id": "/content/usergenerated/content/community-components/en/comments/jcr:content/comments/1Bucket/s3px-hello_lam",

         "properties": {

            "positive": "0",

            "negative": "0",

            "url": "",

            "added": "2014-05-16T15:46:01.325-04:00",

            "sentiment": "3",

            "approved": "true"

         },

         "author": {

            "id": "/social/authors/admin",

            "name": "Administrator",

            "profileUrl": "/.html",

            "largeAvatarUrl": "/etc/designs/default/images/social/avatar.png",

            "numberOfPosts": 3,

            "avatarUrl": "/etc/designs/default/images/social/avatar.png",

            "resourceType": "social/commons/components/author",

            "url": "/social/authors/admin.social.json"

         },

         "created": 1400269561325,

         "message": "Hello Lam",

         "resourceType": "social/commons/components/hbs/comments/comment",

         "canEdit": true,

         "canDelete": true,

         "configuration": {

            "pageSize": 10,

            "isVotingAllowed": false,

            "isAttachmentAllowed": false,

            "isCustomFlagReasonAllowed": false,

            "isRTEEnabled": false

         },

         "moderatorActions": {

            "useFlagReasonList": true,

            "canClose": false,

            "canAllow": false,

            "canFlag": false,

            "canDeny": false

         },

         "moderatorStatus": {

            "isFlagged": false,

            "isApproved": true,

            "isSpam": false

         },

         "useFlagReasons": false,

         "pageInfo": {

            "basePageURL": "/content/community-components/en/comments",

            "pageSize": 10,

            "selectedIndex": null,

            "selectedPage": 0,

            "currentIndex": 0,

            "nextPageURL": "/content/usergenerated/content/community-components/en/comments/jcr:content/comments/1Bucket/s3px-hello_lam.social.0.10.json",

            "previousPageURL": "/content/usergenerated/content/community-components/en/comments/jcr:content/comments/1Bucket/s3px-hello_lam.social.0.10.json",

            "previousSuffix": "0.10",

            "urlpattern": "/content/usergenerated/content/community-components/en/comments/jcr:content/comments/1Bucket/s3px-hello_lam.social.${startIndex}.10.json",

            "totalPages": 0,

            "nextSuffix": "0.10"

         },

         "parent": "/content/community-components/en/comments/_jcr_content/content/comments.social.json",

         "topLevel": true,

         "parentId": "/content/community-components/en/comments/jcr:content/content/comments",

         "totalSize": 0,

         "approved": true,

         "canTranslate": false,

         "userModerator": true,

         "canReply": false,

         "url": "/content/usergenerated/content/community-components/en/comments/jcr:content/comments/1Bucket/s3px-hello_lam.social.json",

         "isVisible": true,

         "isClosed": false,

         "isFlaggedByUser": false

      }

   ],

   "taggingAllowed": false,

   "resourceType": "social/commons/components/hbs/comments",

   "url": "/content/community-components/en/comments/_jcr_content/content/comments.social.json"

}

The JSON produced by the custom comment component produces the same JSON; however, it removes the following author section.  

"author": {
             "id": "/social/authors/admin",
             "name": "Administrator",
             "profileUrl": "/.html",
             "largeAvatarUrl": "/etc/designs/default/images/social/avatar.png",
             "numberOfPosts": 3,
             "avatarUrl": "/etc/designs/default/images/social/avatar.png",
             "resourceType": "social/commons/components/author",
             "url": "/social/authors/admin.social.json"
  }

The author section is removed due to the application logic applied to the CustomComment class. The getAuthor method returns null. To view JSON data, enter the following URL into a web browser:

http://localhost:4502/content/community-components/en/comments/jcr:content/content/comments.social.json

To see the JSON code generated by the default social component, then place the OSGi bundle created in this development article into a non-active state and enter the above URL.

To view the default AEM page that uses the comment compoennt, enter the following URL into a web browser:

http://localhost:4502/content/community-components/en/comments.html

 

Note:

You can see an illustration of an AEM page that uses the comment component at the beginning of this article.

See Also

Congratulations, you have just created your first AEM custom social component by using the AEM Social Component framework Java API. Please refer to the AEM community page for more articles that discuss how to build AEM services/applications.

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy