Article summary

Summary

Discusses how to create a custom AEM 6.2 ecommerce provider using the commerce provider APIs. Also discusses how to use the Experience Manager Urber 6.2 JAR.

A special thank you to Lokesh BS, community member of the year for 2015, for contributing code towards this community article. A special thank you to community members Ranta Kumar Kotla for testing this Community Article to ensure it works.

Digital Marketing Solution(s) Adobe Experience Manager (Adobe CQ)
Audience
Developer (beginner - intermediate)
Required Skills
JCR nodes, Java, HTML
Tested On Adobe Experience Manager 6.2
Video Aug 2016 Version of Ask the AEM Community Experts

Introduction

You can use the Adobe Experience Manager (AEM) 6.2 API to create a custom eCommerce provider. A custom eCommerce provider lets you create eCommerce components such as an AEM shopping cart component to use within an AEM online retail site and provides functionality such as:

  • provides an overview of selected items
  • links to the individual product pages
  • updates to quantity
  • removal of the item

A shopping cart component lets visitors perform tasks such as purchase items, as shown in the following illustration.

Client
An AEM site using a custom ecommerce provider

This development article guides you through building an AEM custom commerce provider that uses the AEM Commerce API (this API belong to the com.adobe.cq.commerce.api package). A shopping cart component uses a commerce provider to obtain product data. Included in the custom commerce provider developed in this article is an OSGi bundle that exposes operations that the Geometrix Outdoors web application invokes. By following along with this article, you learn how to setup, develop, and configure an AEM custom commerce provider. 

Note:

For more information about the AEM eCommerce API, see Package com.adobe.cq.commerce.api.

Setup Maven in your development environment

You can use Maven to build an OSGi bundle that contains a Sling Servlet. Maven manages required JAR files that a Java project needs in its class path. Instead of searching the Internet trying to find and download third-party JAR files to include in your project’s class path, Maven manages these dependencies for you.

You can download Maven 3 from the following URL:

http://maven.apache.org/download.html

After you download and extract Maven, create an environment variable named M3_HOME. Assign the Maven install location to this environment variable. For example:

C:\Programs\Apache\apache-maven-3.0.4

Set up a system environment variable to reference Maven. To test whether you properly setup Maven, enter the following Maven command into a command prompt:

%M3_HOME%\bin\mvn -version

This command provides Maven and Java install details and resembles the following message:

Default locale: en_US, platform encoding: Cp1252
OS name: "windows 7", version: "6.1", arch: "amd64", family: "windows"

Note:

It is recommended that you use Maven 3.0.3 or greater. For more information about setting up Maven and the Home variable, see: Maven in 5 Minutes.

Next, copy the Maven configuration file named settings.xml from [install location]\apache-maven-3.0.4\conf\ to your user profile. For example, C:\Users\scottm\.m2\.

You have to configure your settings.xml file to use Adobe’s public repository. For information, see Adobe Public Maven Repository at http://repo.adobe.com/.

The following XML code represents a settings.xml file that you can use.

<?xml version="1.0" encoding="UTF-8"?>
 
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at
 
    http://www.apache.org/licenses/LICENSE-2.0
 
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->
 
<!--
 | This is the configuration file for Maven. It can be specified at two levels:
 |
 |  1. User Level. This settings.xml file provides configuration for a single user, 
 |                 and is normally provided in ${user.home}/.m2/settings.xml.
 |
 |                 NOTE: This location can be overridden with the CLI option:
 |
 |                 -s /path/to/user/settings.xml
 |
 |  2. Global Level. This settings.xml file provides configuration for all Maven
 |                 users on a machine (assuming they're all using the same Maven
 |                 installation). It's normally provided in 
 |                 ${maven.home}/conf/settings.xml.
 |
 |                 NOTE: This location can be overridden with the CLI option:
 |
 |                 -gs /path/to/global/settings.xml
 |
 | The sections in this sample file are intended to give you a running start at
 | getting the most out of your Maven installation. Where appropriate, the default
 | values (values used when the setting is not specified) are provided.
 |
 |-->
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
  <!-- localRepository
   | The path to the local repository maven will use to store artifacts.
   |
   | Default: ~/.m2/repository
  <localRepository>/path/to/local/repo</localRepository>
  -->
 
  <!-- interactiveMode
   | This will determine whether maven prompts you when it needs input. If set to false,
   | maven will use a sensible default value, perhaps based on some other setting, for
   | the parameter in question.
   |
   | Default: true
  <interactiveMode>true</interactiveMode>
  -->
 
  <!-- offline
   | Determines whether maven should attempt to connect to the network when executing a build.
   | This will have an effect on artifact downloads, artifact deployment, and others.
   |
   | Default: false
  <offline>false</offline>
  -->
 
  <!-- pluginGroups
   | This is a list of additional group identifiers that will be searched when resolving plugins by their prefix, i.e.
   | when invoking a command line like "mvn prefix:goal". Maven will automatically add the group identifiers
   | "org.apache.maven.plugins" and "org.codehaus.mojo" if these are not already contained in the list.
   |-->
  <pluginGroups>
    <!-- pluginGroup
     | Specifies a further group identifier to use for plugin lookup.
    <pluginGroup>com.your.plugins</pluginGroup>
    -->
  </pluginGroups>
 
  <!-- proxies
   | This is a list of proxies which can be used on this machine to connect to the network.
   | Unless otherwise specified (by system property or command-line switch), the first proxy
   | specification in this list marked as active will be used.
   |-->
  <proxies>
    <!-- proxy
     | Specification for one proxy, to be used in connecting to the network.
     |
    <proxy>
      <id>optional</id>
      <active>true</active>
      <protocol>http</protocol>
      <username>proxyuser</username>
      <password>proxypass</password>
      <host>proxy.host.net</host>
      <port>80</port>
      <nonProxyHosts>local.net|some.host.com</nonProxyHosts>
    </proxy>
    -->
  </proxies>
 
  <!-- servers
   | This is a list of authentication profiles, keyed by the server-id used within the system.
   | Authentication profiles can be used whenever maven must make a connection to a remote server.
   |-->
  <servers>
    <!-- server
     | Specifies the authentication information to use when connecting to a particular server, identified by
     | a unique name within the system (referred to by the 'id' attribute below).
     | 
     | NOTE: You should either specify username/password OR privateKey/passphrase, since these pairings are 
     |       used together.
     |
    <server>
      <id>deploymentRepo</id>
      <username>repouser</username>
      <password>repopwd</password>
    </server>
    -->
     
    <!-- Another sample, using keys to authenticate.
    <server>
      <id>siteServer</id>
      <privateKey>/path/to/private/key</privateKey>
      <passphrase>optional; leave empty if not used.</passphrase>
    </server>
    -->
  </servers>
 
  <!-- mirrors
   | This is a list of mirrors to be used in downloading artifacts from remote repositories.
   | 
   | It works like this: a POM may declare a repository to use in resolving certain artifacts.
   | However, this repository may have problems with heavy traffic at times, so people have mirrored
   | it to several places.
   |
   | That repository definition will have a unique id, so we can create a mirror reference for that
   | repository, to be used as an alternate download site. The mirror site will be the preferred 
   | server for that repository.
   |-->
  <mirrors>
    <!-- mirror
     | Specifies a repository mirror site to use instead of a given repository. The repository that
     | this mirror serves has an ID that matches the mirrorOf element of this mirror. IDs are used
     | for inheritance and direct lookup purposes, and must be unique across the set of mirrors.
     |
    <mirror>
      <id>mirrorId</id>
      <mirrorOf>repositoryId</mirrorOf>
      <name>Human Readable Name for this Mirror.</name>
      <url>http://my.repository.com/repo/path</url>
    </mirror>
     -->
  </mirrors>
   
  <!-- profiles
   | This is a list of profiles which can be activated in a variety of ways, and which can modify
   | the build process. Profiles provided in the settings.xml are intended to provide local machine-
   | specific paths and repository locations which allow the build to work in the local environment.
   |
   | For example, if you have an integration testing plugin - like cactus - that needs to know where
   | your Tomcat instance is installed, you can provide a variable here such that the variable is 
   | dereferenced during the build process to configure the cactus plugin.
   |
   | As noted above, profiles can be activated in a variety of ways. One way - the activeProfiles
   | section of this document (settings.xml) - will be discussed later. Another way essentially
   | relies on the detection of a system property, either matching a particular value for the property,
   | or merely testing its existence. Profiles can also be activated by JDK version prefix, where a 
   | value of '1.4' might activate a profile when the build is executed on a JDK version of '1.4.2_07'.
   | Finally, the list of active profiles can be specified directly from the command line.
   |
   | NOTE: For profiles defined in the settings.xml, you are restricted to specifying only artifact
   |       repositories, plugin repositories, and free-form properties to be used as configuration
   |       variables for plugins in the POM.
   |
   |-->
  <profiles>
    <!-- profile
     | Specifies a set of introductions to the build process, to be activated using one or more of the
     | mechanisms described above. For inheritance purposes, and to activate profiles via <activatedProfiles/>
     | or the command line, profiles have to have an ID that is unique.
     |
     | An encouraged best practice for profile identification is to use a consistent naming convention
     | for profiles, such as 'env-dev', 'env-test', 'env-production', 'user-jdcasey', 'user-brett', etc.
     | This will make it more intuitive to understand what the set of introduced profiles is attempting
     | to accomplish, particularly when you only have a list of profile id's for debug.
     |
     | This profile example uses the JDK version to trigger activation, and provides a JDK-specific repo.
    <profile>
      <id>jdk-1.4</id>
 
      <activation>
        <jdk>1.4</jdk>
      </activation>
 
      <repositories>
        <repository>
          <id>jdk14</id>
          <name>Repository for JDK 1.4 builds</name>
          <url>http://www.myhost.com/maven/jdk14</url>
          <layout>default</layout>
          <snapshotPolicy>always</snapshotPolicy>
        </repository>
      </repositories>
    </profile>
    -->
 
    <!--
     | Here is another profile, activated by the system property 'target-env' with a value of 'dev',
     | which provides a specific path to the Tomcat instance. To use this, your plugin configuration
     | might hypothetically look like:
     |
     | ...
     | <plugin>
     |   <groupId>org.myco.myplugins</groupId>
     |   <artifactId>myplugin</artifactId>
     |   
     |   <configuration>
     |     <tomcatLocation>${tomcatPath}</tomcatLocation>
     |   </configuration>
     | </plugin>
     | ...
     |
     | NOTE: If you just wanted to inject this configuration whenever someone set 'target-env' to
     |       anything, you could just leave off the <value/> inside the activation-property.
     |
    <profile>
      <id>env-dev</id>
 
      <activation>
        <property>
          <name>target-env</name>
          <value>dev</value>
        </property>
      </activation>
 
      <properties>
        <tomcatPath>/path/to/tomcat/instance</tomcatPath>
      </properties>
    </profile>
    -->
   
 
<profile>
 
                <id>adobe-public</id>
 
                <activation>
 
                    <activeByDefault>true</activeByDefault>
 
                </activation>
 
                <repositories>
 
                  <repository>
 
                    <id>adobe</id>
 
                    <name>Nexus Proxy Repository</name>
 
                    <url>http://repo.adobe.com/nexus/content/groups/public/</url>
 
                    <layout>default</layout>
 
                  </repository>
 
                </repositories>
 
                <pluginRepositories>
 
                  <pluginRepository>
 
                    <id>adobe</id>
 
                    <name>Nexus Proxy Repository</name>
 
                    <url>http://repo.adobe.com/nexus/content/groups/public/</url>
 
                    <layout>default</layout>
 
                  </pluginRepository>
 
                </pluginRepositories>
 
            </profile>
 
</profiles>
 
  <!-- activeProfiles
   | List of profiles that are active for all builds.
   |
  <activeProfiles>
    <activeProfile>alwaysActiveProfile</activeProfile>
    <activeProfile>anotherAlwaysActiveProfile</activeProfile>
  </activeProfiles>
  -->
</settings>

Note:

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

Create an AEM Maven 10 archetype project

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

files
Maven Archetype 10 generated files

The following list describes the Archetype 10 project arguments:

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

To create an 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 - ecomm62
  • artifactId - ecomm62
  • version - 1.0-SNAPSHOT
  • package -  org.test.commerceexample
  • appsFolderName - ecomm62
  • artifactName - ecomm62
  • componentGroupName - ecomm62
  • contentFolderName - ecomm62
  • cssId - ecomm62
  • packageGroup -ecomm62
  • siteName - ecomm62

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 ecomm62 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 ecommerce provider myHTL62.core. Create a package named org.test.commerceexample.core.commerce and place all Java files discussed in this article in this package. 

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. 

SimpleDSComponent file

Add a new class to the com.adobe.training package named SimpleDSComponent. This class inherits from the Runnable class, contains @Component and @Service annotations, and exposes these methods:

  • run – invoked when the service is started. 
  • activate – invoked when the service is activated. 
  • deactivate – invoked when the service is deactived.

The following Java code represents the SimpleDSComponent class.

package org.test.commerceexample.core.commerce;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Service;
import org.osgi.framework.BundleContext;
import org.osgi.service.component.ComponentContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
 * A basic DS Component
 */
@Component(metatype=true)
@Service
public class SimpleDSComponent implements Runnable {
     
    private Logger logger = LoggerFactory.getLogger(this.getClass());
    private BundleContext bundleContext;
     
    public void run() {
        logger.info("Running...");
    }
     
    protected void activate(ComponentContext ctx) {
        this.bundleContext = ctx.getBundleContext();
    }
    protected void deactivate(ComponentContext ctx) {
        this.bundleContext = null;
    }
}

TrainingCommerceServiceFactory file

The TrainingCommerceServiceFactory class is the service factory for the custom commerce provider. You use this service factory to create a CommerceService instance, which is the main class when using the AEM commerce API. For example, you can invoke the CommerceService.getProduct method to get a product instance. For information, see CommerceService.

The following code represents the TrainingCommerceServiceFactory Java file.

package org.test.commerceexample.core.commerce;

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

import com.adobe.cq.commerce.api.CommerceService;
import com.adobe.cq.commerce.api.CommerceServiceFactory;
import com.adobe.cq.commerce.common.AbstractJcrCommerceServiceFactory;
 
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;
 
/**
 * A simple new (for training) implementation for the {@link CommerceServiceFactory} interface.
 */
@Component(metatype = true, label = "Adobe CQ Commerce Factory for Training")
@Service
@Properties(value = {
        @Property(name = "service.description", value = "Factory for training commerce service"),
        @Property(name = "commerceProvider", value = "training")
})
 
public class TrainingCommerceServiceFactory extends AbstractJcrCommerceServiceFactory implements CommerceServiceFactory {
 
    /**
     * Create a new <code>TrainingCommerceServiceImpl</code>.
     */
    public CommerceService getCommerceService(Resource res) {
        return new TrainingCommerceServiceImpl(getServiceContext(), res);
    }
 
}

Notice this class uses a @Property annotation that specifies the commerce provider name:

@Property(name = "commerceProvider", value = "training")

This property is important because you use it to inform AEM to use this custom commerce provider (this is shown later in this development article).
The getCommerceService method creates a CommerceService instance that is used by the custom commerce provider.

TrainingCommerceServiceImpl file

The following file represents the TrainingCommerceServiceImpl class.

package org.test.commerceexample.core.commerce;

import java.util.List;

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.adobe.cq.commerce.api.CommerceException;
import com.adobe.cq.commerce.api.CommerceQuery;
import com.adobe.cq.commerce.api.CommerceResult;
import com.adobe.cq.commerce.api.CommerceService;
import com.adobe.cq.commerce.api.CommerceSession;
import com.adobe.cq.commerce.api.PaymentMethod;
import com.adobe.cq.commerce.api.Product;
import com.adobe.cq.commerce.api.ShippingMethod;
import com.adobe.cq.commerce.api.promotion.Voucher;
import com.adobe.cq.commerce.common.AbstractJcrCommerceService;
import com.adobe.cq.commerce.common.AbstractJcrProduct;
import com.adobe.cq.commerce.common.ServiceContext;
 
public class TrainingCommerceServiceImpl extends AbstractJcrCommerceService implements CommerceService {
	private final Logger log = LoggerFactory.getLogger(TrainingCommerceServiceImpl.class);
	
    private Resource resource;
   // private ResourceResolver resolver;
     
    public TrainingCommerceServiceImpl(ServiceContext services, Resource res) {
        super(services,res);
        log.info("TrainingCommerceServiceImpl : Resource : "+ res);
        this.resource = res;
       // this.resolver = res.getResourceResolver();
    }
 
    public CommerceSession login(SlingHttpServletRequest request,
            SlingHttpServletResponse response) throws CommerceException {
    	log.info("TrainingCommerceServiceImpl login : Resources : "+ resource);
        return new TrainingCommerceSessionImpl(this, request, response, resource);
    }
 
    public Product getProduct(final String path) throws CommerceException {
        Resource resource = this.resolver.getResource(path);
        if (resource != null && resource.isResourceType(AbstractJcrProduct.RESOURCE_TYPE_PRODUCT)) {
            return new TrainingProductImpl(resource);
        }
        return null;
    }
    
    
    public List<String> getCountries() throws CommerceException {
        // TODO Auto-generated method stub
        return null;
    }
 
    public List<String> getCreditCardTypes() throws CommerceException {
        // TODO Auto-generated method stub
        return null;
    }
 
    public Voucher getVoucher(String arg0) throws CommerceException {
        // TODO Auto-generated method stub
        return null;
    }
 
    public CommerceResult search(CommerceQuery arg0) throws CommerceException {
        // TODO Auto-generated method stub
        return null;
    }

	@Override
	public List<String> getOrderPredicates() throws CommerceException {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public boolean isAvailable(String serviceType)
	  {
	    if ("commerce-service".equals(serviceType)) {
	      return true;
	    }
	    return false;
	  }
	
	public List<ShippingMethod> getAvailableShippingMethods()
		    throws CommerceException
		  {
		    return enumerateMethods("/etc/commerce/shipping-methods/geometrixx-outdoors", ShippingMethod.class);
		  }
		  
	  public List<PaymentMethod> getAvailablePaymentMethods()
	    throws CommerceException
	  {
	    return enumerateMethods("/etc/commerce/payment-methods/geometrixx-outdoors", PaymentMethod.class);
	  }
     
}

TrainingCommerceSessionImpl file

The following file represents the TrainingCommerceSessionImpl file.

package org.test.commerceexample.core.commerce;

import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;

import com.adobe.cq.commerce.api.CommerceException;
import com.adobe.cq.commerce.common.AbstractJcrCommerceService;
import com.adobe.cq.commerce.common.AbstractJcrCommerceSession;
import com.adobe.cq.commerce.common.promotion.AbstractJcrVoucher;
 
public class TrainingCommerceSessionImpl extends AbstractJcrCommerceSession {
     
    protected SlingHttpServletRequest request;
    protected SlingHttpServletResponse response;
    protected Resource resource;
    protected ResourceResolver resolver;
    protected AbstractJcrCommerceService commerceService;
     
    protected List<CartEntry> cart = new ArrayList<CartEntry>();
   // protected List<AbstractJcrVoucher> vouchers = new ArrayList<AbstractJcrVoucher>();
    protected List<String> activePromotions = new ArrayList<String>();
 
    public TrainingCommerceSessionImpl(
            AbstractJcrCommerceService commerceService,
            SlingHttpServletRequest request, SlingHttpServletResponse response,
            Resource resource) throws CommerceException {
        super(commerceService, request, response, resource);
        
        this.PN_UNIT_PRICE="price";
     /*
         this.request = request;
         this.response = response;
         this.resource = resource;
         this.resolver = resource.getResourceResolver();
         this.commerceService = commerceService;*/
         
    }
    
    protected BigDecimal getShipping(String method)
    {
      String[][] shippingCosts = { { "/etc/commerce/shipping-methods/geometrixx-outdoors/ground", "10.00" }, { "/etc/commerce/shipping-methods/geometrixx-outdoors/three-day", "20.00" }, { "/etc/commerce/shipping-methods/geometrixx-outdoors/two-day", "25.00" }, { "/etc/commerce/shipping-methods/geometrixx-outdoors/overnight", "40.00" } };
      for (String[] entry : shippingCosts) {
        if (entry[0].equals(method)) {
          return new BigDecimal(entry[1]);
        }
      }
      return BigDecimal.ZERO;
    }
}

TrainingProductImpl file

The following Java code represents the TrainingProductImpl class. Notice the getSKU method. When AEM is configured to use this custom commerce provider, you will see the return value of this method displayed witin the Geometrix Outdoors web application (this is shown later in this development article).

package org.test.commerceexample.core.commerce;

import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
 
import com.adobe.cq.commerce.common.AbstractJcrProduct;
import com.day.cq.wcm.api.Page;
import com.day.cq.wcm.api.PageManager;
 
public class TrainingProductImpl extends AbstractJcrProduct {
    public static final String PN_IDENTIFIER = "identifier";
    public static final String PN_PRICE = "price";
 
    protected final ResourceResolver resourceResolver;
    protected final PageManager pageManager;
    protected final Page productPage;
    protected String brand = null;
 
    public TrainingProductImpl(Resource resource) {
        super(resource);
 
        resourceResolver = resource.getResourceResolver();
        pageManager = resourceResolver.adaptTo(PageManager.class);
        productPage = pageManager.getContainingPage(resource);
        /*this.pageManager = ((PageManager)this.resourceResolver.adaptTo(PageManager.class));
        this.productPage = this.pageManager.getContainingPage(resource);*/
    }
 
    public String getSKU() {
        // TODO Auto-generated method stub
        return "Ask the Expert Demo Product";
    }
}

Modify the Maven POM file

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

<dependency>
               <groupId>com.adobe.aem</groupId>
               <artifactId>uber-jar</artifactId>
               <version>6.2.0</version>
               <!-- for AEM6.1 use this version     : <version>6.1.0</version> -->
               <!-- for AEM6.1 SP1 use this version : <version>6.1.0-SP1-B0001</version> -->
               <!-- for AEM6.1 SP2 use this version : <version>6.1.0-SP2</version> -->
               <!-- for AEM6.2 use this version     : <version>6.2.0</version> -->
               <classifier>obfuscated-apis</classifier>
               <scope>provided</scope>
           </dependency>
            
           <dependency>
               <groupId>org.apache.geronimo.specs</groupId>
               <artifactId>geronimo-atinject_1.0_spec</artifactId>
               <version>1.0</version>
               <scope>provided</scope>
           </dependency>

Note:

At the time when this artilce was written, there was an issue getting the uber-jar-6.2.0-apis.jar using Maven. You need to ensure this JAR file is located in the Maven repository. Download this file here. Then place the JAR file in this Maven repository location: .m2\repository\com\adobe\aem\uber-jar\6.2.0.

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

ParentPOM
Parent POM

Add the dependency shown above to the Parent POM file. Next, modify the POM file located at C:\AdobeCQ\ecomm62\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>ecomm62</groupId>
        <artifactId>ecomm62</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <artifactId>ecomm62.core</artifactId>
    <packaging>bundle</packaging>
    <name>ecomm62 - Core</name>
    <description>Core bundle for ecomm62</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>
                            org.test.commerceexample.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/ecomm62/install to exist!!          -->
                            <!--    This is typically the case when ui.apps is deployed first                -->
                            <!--    Otherwise, create /apps/ecomm62/install manually (CRXDE|Lite)  -->
                            <slingUrlSuffix>/apps/ecomm62/install/</slingUrlSuffix>
                            <failOnError>true</failOnError>
                        </configuration>
                    </plugin>
                </plugins>
            </build>
        </profile>
    </profiles>
    <dependencies>
        <!-- OSGi Dependencies -->
            
        <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>uber-jar</artifactId>
            <classifier>obfuscated-apis</classifier>
        </dependency>
 
        <dependency>
            <groupId>org.apache.geronimo.specs</groupId>
            <artifactId>geronimo-atinject_1.0_spec</artifactId>
        </dependency>
        
        <dependency>
            <groupId>org.apache.felix</groupId>
            <artifactId>org.apache.felix.scr</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.felix</groupId>
            <artifactId>org.apache.felix.scr.annotations</artifactId>
        </dependency>
        <dependency>
            <groupId>biz.aQute</groupId>
            <artifactId>bndlib</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.compendium</artifactId>
        </dependency>
        <!-- Other Dependencies -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
        </dependency>
        <dependency>
            <groupId>javax.jcr</groupId>
            <artifactId>jcr</artifactId>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
        </dependency>
        <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>aem-api</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.sling</groupId>
            <artifactId>org.apache.sling.models.api</artifactId>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mockito</groupId>
            <artifactId>mockito-all</artifactId>
        </dependency>
        <dependency>
            <groupId>junit-addons</groupId>
            <artifactId>junit-addons</artifactId>
        </dependency>
         <dependency>
            <groupId>commons-collections</groupId>
            <artifactId>commons-collections</artifactId>
            <version>3.2.1</version>
        </dependency>
        
        
    </dependencies>
</project>

Build the OSGi bundle using Maven

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

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

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

Viewing the OSGi bundle that is part of the custom commerce package

You can view the OSGi bundle in the Apache Felix Web Console.

OSGi
Apache Felix Web Conole displaying the custom commerce OSGI bundle

View the custom commerce OSGi bundle 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. Under the OSGI menu, select Bundles.
  3. Sort the bundle list by Id, and note the Id of the last bundle.
  4. Your new bundle should now be listed with the status Active. If the status is not Active, check the CQ error.log for exceptions.

Configure AEM to use the custom commerce provider

Configure Experience Manager to use the custom commerce provider instead of the geomatrix implementation. To perform this task, modify the cq:commerceProvider property that belongs to the following node:

/content/geometrixx-outdoors/en/jcr:content

Set this property to training. This value corresponds to the Property annotation value that you defined in the TrainingCommerceServiceFactory class:

@Property(name = "commerceProvider", value = "training")

Once you modify the cq:commerceProvider property, you can view the results of the custom commerce provider. For example, consider the getSKU method defined in the TrainingProductImpl class:

 public String getSKU() {
        // TODO Auto-generated method stub
        return "Ask the Expert Demo Product";
    }

You can see the the return value of the getSKU method by viewing a product page (for example, http://localhost:4502/editor.html/content/geometrixx-outdoors/en/seasonal/summer/equipment/abidjan-water.html), as shown in the following illustration.

Client2
A geometrix product page displaying a return value of the custom commerce provider

See also

Congratulations, you have just created a custom AEM ecommerce provider by using the ecommerce API. Please refer to the AEM community page for other articles that discuss how to build AEM services/applications.

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

Legal Notices   |   Online Privacy Policy