Instalar artefactos de terceros: no disponible en el repositorio público de Maven

El paquete o paquete lo proporciona un equipo interno o un proveedor de terceros y no está disponible en el repositorio Maven público.

El archivo jar Java™ no es un paquete OSGi y puede que esté o no disponible en el repositorio Maven público.

Necesita una función que aún no se haya lanzado en la última versión del paquete de terceros disponible en el repositorio público de Maven. Ha decidido instalar la versión de RELEASE o SNAPSHOT creada localmente.

Configuración del entorno de desarrollo local de AEM o del entorno de desarrollo rápido (RDE).

El proyecto WKND de AEM para agregar el paquete, jar o paquete de terceros y comprobar los cambios.

Configure el entorno de desarrollo local de AEM 6.X o AEM as a Cloud Service (AEMCS) o el entorno RDE.

Clonar e implementar el proyecto WKND de AEM.

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

Compruebe que las páginas del sitio WKND se representan correctamente.

Descargue y extraiga el archivo my-example-bundle.zip.

En el módulo all del proyecto WKND de AEM, cree la estructura de directorios all/src/main/content/jcr_root/apps/wknd-vendor-packages/container/install. El directorio /all/src/main/content existe, solamente necesita crear los directorios jcr_root/apps/wknd-vendor-packages/container/install.

Copie el archivo my-example-bundle-1.0-SNAPSHOT.jar del directorio target extraído al directorio all/src/main/content/jcr_root/apps/wknd-vendor-packages/container/install anterior.

En el módulo core del proyecto WKND de AEM, cree el servlet Sling SayHello.java en 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());
        }
}

En el archivo raíz pom.xml del proyecto WKND de AEM, agregue my-example-bundle como dependencia.

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

Aquí:

• El ámbito system indica que no se debe buscar la dependencia en el repositorio Maven público.
• systemPath es la ruta al archivo my-example-bundle en el módulo all del proyecto WKND de AEM.
• ${maven.multiModuleProjectDirectory} es una propiedad de Maven que señala al directorio raíz del proyecto de varios módulos.

En el archivo core/pom.xml del módulo core del proyecto WKND de AEM, agregue my-example-bundle como dependencia.

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

Cree e implemente el proyecto WKND de AEM con el siguiente comando:

$ mvn clean install -PautoInstallPackage

Compruebe que el servlet SayHello funciona según lo esperado teniendo acceso a la dirección URL http://localhost:4502/bin/sayhello en el explorador.

Confirme los cambios anteriores en el repositorio del proyecto WKND de AEM. A continuación, compruebe los cambios en el entorno de RDE o AEM ejecutando la canalización de Cloud Manager.

Copie el paquete OSGi en el directorio jcr_root/apps/<PROJECT-NAME>-vendor-packages/container/install del módulo all. Este paso es necesario para empaquetar e implementar el paquete en la instancia de AEM.

Actualice los archivos pom.xml del módulo principal y raíz para agregar el paquete OSGi como dependencia con el ámbito system y systemPath que apuntan al archivo del paquete. Este paso es necesario para compilar el proyecto.

Descargue y extraiga el archivo my-example-jar.zip.

En el módulo all del proyecto WKND de AEM, cree la estructura de directorios all/resource/jar.

Copie el archivo my-example-jar-1.0-SNAPSHOT.jar del directorio target extraído al directorio all/resource/jar anterior.

En el módulo core del proyecto WKND de AEM, cree el servlet Sling SayHello.java en 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());
    }
}

En el archivo raíz pom.xml del proyecto WKND de AEM, agregue my-example-jar como dependencia.

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

Aquí:

• El ámbito system indica que no se debe buscar la dependencia en el repositorio Maven público.
• systemPath es la ruta al archivo my-example-jar en el módulo all del proyecto WKND de AEM.
• ${maven.multiModuleProjectDirectory} es una propiedad de Maven que señala al directorio raíz del proyecto de varios módulos.

Realice dos cambios en el archivo core/pom.xml del módulo core del proyecto WKND de AEM:

• Agregue my-example-jar como dependencia.

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

• Actualice la configuración de bnd-maven-plugin para incluir my-example-jar en el paquete OSGi (aem-guides-wknd.core) que se está creando.

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

Cree e implemente el proyecto WKND de AEM con el siguiente comando:

$ mvn clean install -PautoInstallPackage

Compruebe que el servlet SayHello funciona según lo esperado teniendo acceso a la dirección URL http://localhost:4502/bin/sayhello en el explorador.

Confirme los cambios anteriores en el repositorio del proyecto WKND de AEM. A continuación, compruebe los cambios en el entorno de RDE o AEM ejecutando la canalización de Cloud Manager.

Copie el JAR de Java en el directorio resource/jar del módulo all.

Actualice los archivos pom.xml del módulo principal y raíz para agregar el JAR de Java como dependencia con el ámbito system y systemPath que apuntan al archivo JAR.

Comente o elimine la dependencia de la versión ACS AEM Commons del archivo POM. Consulte Agregar ACS AEM Commons a su proyecto AEM Maven para identificar la dependencia.

Clone la rama master del repositorio ACS AEM Commons en su equipo local.

Cree la versión ACS AEM Commons SNAPSHOT con el siguiente comando:

$mvn clean install

El paquete generado localmente se encuentra en all/target, hay dos archivos .zip, el que termina con -cloud está diseñado para AEM as a Cloud Service y el otro es para AEM 6.X.

En el módulo all del proyecto WKND de AEM, cree la estructura de directorios all/src/main/content/jcr_root/apps/wknd-vendor-packages/container/install. El directorio /all/src/main/content existe, solamente necesita crear los directorios jcr_root/apps/wknd-vendor-packages/container/install.

Copie el archivo del paquete creado localmente (.zip) en el directorio /all/src/main/content/jcr_root/apps/mysite-vendor-packages/container/install.

Cree e implemente el proyecto WKND de AEM con el siguiente comando:

$ mvn clean install -PautoInstallPackage

Compruebe el paquete ACS AEM Commons instalado:

• Administrador de paquetes CRX en http://localhost:4502/crx/packmgr/index.jsp

  

• La consola OSGi en http://localhost:4502/system/console/bundles

  

Confirme los cambios anteriores en el repositorio del proyecto WKND de AEM. A continuación, compruebe los cambios en el entorno de RDE o AEM ejecutando la canalización de Cloud Manager.