Install third party artifacts - not available in the public Maven repository

The bundle or package is provided by an internal team or third-party vendor and is not available in the public Maven repository.

The Java™ jar file is not an OSGi bundle and may or may not be available in the public Maven repository.

You need a feature that is not yet released in the latest version of the third-party package available in the public Maven repository. You decided to install the locally built RELEASE or SNAPSHOT version.

The local AEM development environment or Rapid Development Environment(RDE) set-up.

The AEM WKND project to add the third-party bundle or jar or package and verify the changes.

Set up the AEM 6.X or AEM as a Cloud Service (AEMCS) local development environment or RDE environment.

Clone and deploy the AEM WKND project.

$ git clone git@github.com:adobe/aem-guides-wknd.git
$ cd aem-guides-wknd
$ mvn clean install -PautoInstallPackage

Verify the WKND site pages render correctly.

Download and extract the my-example-bundle.zip file.

In the AEM WKND project’s all module, create the all/src/main/content/jcr_root/apps/wknd-vendor-packages/container/install directory structure. The /all/src/main/content directory exists, you only need to create the jcr_root/apps/wknd-vendor-packages/container/install directories.

Copy the my-example-bundle-1.0-SNAPSHOT.jar file from the extracted target directory to the above all/src/main/content/jcr_root/apps/wknd-vendor-packages/container/install directory.

In the AEM WKND project’s core module, create the SayHello.java Sling servlet @ core/src/main/java/com/adobe/aem/guides/wknd/core/servlet.

package com.adobe.aem.guides.wknd.core.servlet;

import java.io.IOException;

import javax.servlet.Servlet;
import javax.servlet.ServletException;

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.HttpConstants;
import org.apache.sling.api.servlets.ServletResolverConstants;
import org.apache.sling.api.servlets.SlingSafeMethodsServlet;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import com.example.services.HelloWorldService;

@Component(service = Servlet.class, property = {
    ServletResolverConstants.SLING_SERVLET_PATHS + "=/bin/sayhello",
    ServletResolverConstants.SLING_SERVLET_METHODS + "=" + HttpConstants.METHOD_GET
})
public class SayHello extends SlingSafeMethodsServlet {

        private static final long serialVersionUID = 1L;

        // Injecting the HelloWorldService from the `my-example-bundle` bundle
        @Reference
        private HelloWorldService helloWorldService;

        @Override
        protected void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response) throws ServletException, IOException {
            // Invoking the HelloWorldService's `sayHello` method
            response.getWriter().write("My-Example-Bundle service says: " + helloWorldService.sayHello());
        }
}

In the AEM WKND project’s root pom.xml file, add the my-example-bundle as a dependency.

...
<!-- My Example Bundle -->
<dependency>
    <groupId>com.example</groupId>
    <artifactId>my-example-bundle</artifactId>
    <version>1.0-SNAPSHOT</version>
    <scope>system</scope>
    <systemPath>${maven.multiModuleProjectDirectory}/all/src/main/content/jcr_root/apps/wknd-vendor-packages/container/install/my-example-bundle-1.0-SNAPSHOT.jar</systemPath>
</dependency>
...

Here:

• The system scope indicates that the dependency should not be looked up in the public Maven repository.
• The systemPath is the path to the my-example-bundle file in the AEM WKND project’s all module.
• The ${maven.multiModuleProjectDirectory} is a Maven property that points to the root directory of the multi-module project.

In the AEM WKND project’s core module’s core/pom.xml file, add the my-example-bundle as a dependency.

...
<!-- My Example Bundle -->
<dependency>
    <groupId>com.example</groupId>
    <artifactId>my-example-bundle</artifactId>
</dependency>
...

Build and deploy the AEM WKND project using the following command:

$ mvn clean install -PautoInstallPackage

Verify the SayHello servlet works as expected by accessing the URL http://localhost:4502/bin/sayhello in the browser.

Commit above changes to the AEM WKND project’s repository. Then verify the changes in the RDE or AEM environment by running the Cloud Manager pipeline.

Copy the OSGi bundle to the all module’s jcr_root/apps/<PROJECT-NAME>-vendor-packages/container/install directory. This step is necessary to package and deploy the bundle to the AEM instance.

Update the root and core module’s pom.xml files to add the OSGi bundle as a dependency with the system scope and systemPath pointing to the bundle file. This step is necessary to compile the project.

Download and extract the my-example-jar.zip file.

In the AEM WKND project’s all module, create the all/resource/jar directory structure.

Copy the my-example-jar-1.0-SNAPSHOT.jar file from the extracted target directory to the above all/resource/jar directory.

In the AEM WKND project’s core module, create the SayHello.java Sling servlet @ core/src/main/java/com/adobe/aem/guides/wknd/core/servlet.

package com.adobe.aem.guides.wknd.core.servlet;

import java.io.IOException;

import javax.servlet.Servlet;
import javax.servlet.ServletException;

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.HttpConstants;
import org.apache.sling.api.servlets.ServletResolverConstants;
import org.apache.sling.api.servlets.SlingSafeMethodsServlet;
import org.osgi.service.component.annotations.Component;

import com.my.example.MyHelloWorldService;

@Component(service = Servlet.class, property = {
        ServletResolverConstants.SLING_SERVLET_PATHS + "=/bin/sayhello",
        ServletResolverConstants.SLING_SERVLET_METHODS + "=" + HttpConstants.METHOD_GET
})
public class SayHello extends SlingSafeMethodsServlet {

    private static final long serialVersionUID = 1L;

    @Override
    protected void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response)
            throws ServletException, IOException {

        // Creating an instance of MyHelloWorldService
        MyHelloWorldService myHelloWorldService = new MyHelloWorldService();

        // Invoking the MyHelloWorldService's `sayHello` method
        response.getWriter().write("My-Example-JAR service says: " + myHelloWorldService.sayHello());
    }
}

In the AEM WKND project’s root pom.xml file, add the my-example-jar as a dependency.

...
<!-- My Example JAR -->
<dependency>
    <groupId>com.my.example</groupId>
    <artifactId>my-example-jar</artifactId>
    <version>1.0-SNAPSHOT</version>
    <scope>system</scope>
    <systemPath>${maven.multiModuleProjectDirectory}/all/resource/jar/my-example-jar-1.0-SNAPSHOT.jar</systemPath>
</dependency>
...

Here:

• The system scope indicates that the dependency should not be looked up in the public Maven repository.
• The systemPath is the path to the my-example-jar file in the AEM WKND project’s all module.
• The ${maven.multiModuleProjectDirectory} is a Maven property that points to the root directory of the multi-module project.

In the AEM WKND project’s core module’s core/pom.xml file, make two changes:

• Add the my-example-jar as a dependency.

  ...
  <!-- My Example JAR -->
  <dependency>
      <groupId>com.my.example</groupId>
      <artifactId>my-example-jar</artifactId>
  </dependency>
  ...
  

• Update bnd-maven-plugin configuration to include the my-example-jar into the OSGi bundle (aem-guides-wknd.core) that is being built.

  ...
  <plugin>
      <groupId>biz.aQute.bnd</groupId>
      <artifactId>bnd-maven-plugin</artifactId>
      <executions>
          <execution>
              <id>bnd-process</id>
              <goals>
                  <goal>bnd-process</goal>
              </goals>
              <configuration>
                  <bnd><![CDATA[
              Import-Package: javax.annotation;version=0.0.0,*
              <!-- Include the 3rd party jar as inline resource-->
              -includeresource: \
              lib/my-example-jar.jar=my-example-jar-1.0-SNAPSHOT.jar;lib:=true
                      ]]></bnd>
              </configuration>
          </execution>
      </executions>
  </plugin>
  ...
  

Build and deploy the AEM WKND project using the following command:

$ mvn clean install -PautoInstallPackage

Verify the SayHello servlet works as expected by accessing the URL http://localhost:4502/bin/sayhello in the browser.

Commit above changes to the AEM WKND project’s repository. Then verify the changes in the RDE or AEM environment by running the Cloud Manager pipeline.

Copy the Java jar to the all module’s resource/jar directory.

Update the root and core module’s pom.xml files to add the Java jar as a dependency with the system scope and systemPath pointing to the jar file.

Comment or remove the ACS AEM Commons release dependency from the POM file. Refer the Add ACS AEM Commons to your AEM Maven project to identify the dependency.

Clone the master branch of the ACS AEM Commons repository to your local machine.

Build the ACS AEM Commons SNAPSHOT version using the following command:

$mvn clean install

The locally built package is located @ all/target, there are two .zip files, the one ending with -cloud is meant for AEM as a Cloud Service and the other one is for AEM 6.X.

In the AEM WKND project’s all module, create the all/src/main/content/jcr_root/apps/wknd-vendor-packages/container/install directory structure. The /all/src/main/content directory exists, you only need to create the jcr_root/apps/wknd-vendor-packages/container/install directories.

Copy the locally built package (.zip) file to the /all/src/main/content/jcr_root/apps/mysite-vendor-packages/container/install directory.

Build and deploy the AEM WKND project using the following command:

$ mvn clean install -PautoInstallPackage

Verify the installed ACS AEM Commons package:

• CRX Package Manager @ http://localhost:4502/crx/packmgr/index.jsp

  

• The OSGi console @ http://localhost:4502/system/console/bundles

  

Commit above changes to the AEM WKND project’s repository. Then verify the changes in the RDE or AEM environment by running the Cloud Manager pipeline.