Installieren von Drittanbieter-Artefakten – nicht im öffentlichen Maven-Repository verfügbar

Das Paket mit den AEM WCM-Kernkomponenten wird in der Datei pom.xml des des WKND-Projekts als Abhängigkeit hinzugefügt. Hier wird der Umfang provided verwendet, da das Paket „AEM WCM-Kernkomponenten“ von der AEM Runtime bereitgestellt wird. Wenn das Paket nicht von der AEM Runtime bereitgestellt wird, verwenden Sie den Umfang compile, der den Standardumfang darstellt.

Das Paket WKND Shared wird in der Datei pom.xml des WKND-Projekts als Abhängigkeit hinzugefügt.

Das Bundle oder Paket wird von einem internen Team oder Drittanbieter bereitgestellt und ist nicht im öffentlichen Maven-Repository verfügbar.

Die Java™-JAR-Datei ist kein OSGi-Bundle und möglicherweise nicht im öffentlichen Maven-Repository verfügbar.

Sie benötigen eine Funktion, die noch nicht in der neuesten Version des Drittanbieter-Pakets veröffentlicht ist, das im öffentlichen Maven-Repository verfügbar ist. Sie haben beschlossen, die lokal erstellte Version von RELEASE oder SNAPSHOT zu installieren.

Die lokale AEM-Entwicklungsumgebung oder das Setup einer schnellen Entwicklungsumgebung (Rapid Development Environment, RDE).

Das AEM WKND-Projekt , um das Drittanbieter-Paket oder die JAR oder das Paket hinzuzufügen und die Änderungen zu überprüfen.

Richten Sie die lokale Entwicklungsumgebung oder RDE-Umgebung für AEM 6.X oder AEM as a Cloud Service (AEMCS) ein.

Klonen Sie das AEM-WKND-Projekt und stellen Sie es bereit.

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

Überprüfen Sie, ob die WKND-Site-Seiten korrekt gerendert werden.

Laden Sie die Datei my-example-bundle.zip herunter und extrahieren Sie sie.

Erstellen Sie im all-Modul des AEM-WKND-Projekts die Verzeichnisstruktur all/src/main/content/jcr_root/apps/wknd-vendor-packages/container/install. Das Verzeichnis /all/src/main/content ist vorhanden. Sie müssen nur die Verzeichnisse jcr_root/apps/wknd-vendor-packages/container/install erstellen.

Kopieren Sie die Datei my-example-bundle-1.0-SNAPSHOT.jar aus dem extrahierten Verzeichnis target in das obige Verzeichnis all/src/main/content/jcr_root/apps/wknd-vendor-packages/container/install.

Erstellen Sie im core-Modul des AEM-WKND-Projekts das Sling-Servlet SayHello.java unter 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());
        }
}

Fügen Sie in derpom.xml-Stammdatei des AEM-WKND-Projekts das my-example-bundle als Abhängigkeit hinzu.

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

Hierbei gilt:

• Der system-Bereich gibt an, dass die Abhängigkeit nicht im öffentlichen Maven-Repository nachgeschlagen werden sollte.
• systemPath ist der Pfad zur Datei my-example-bundle im all-Modul des AEM-WKND-Projekts.
• ${maven.multiModuleProjectDirectory} ist eine Maven-Eigenschaft, die auf das Stammverzeichnis des Multi-Modul-Projekts verweist.

Fügen Sie in der Datei core/pom.xml des core-Moduls des AEM-WKND-Projekts das my-example-bundle als Abhängigkeit hinzu.

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

Verwenden Sie den folgenden Befehl, um das AEM-WKND-Projekt zu erstellen und bereitzustellen:

$ mvn clean install -PautoInstallPackage

Stellen Sie sicher, dass das SayHello-Servlet wie erwartet funktioniert, indem Sie auf die URL http://localhost:4502/bin/sayhello im Browser zugreifen.

Übergeben Sie die oben genannten Änderungen an das Repository des AEM-WKND-Projekts. Überprüfen Sie dann die Änderungen in der RDE- oder AEM-Umgebung, indem Sie die Cloud Manager-Pipeline ausführen.

Kopieren Sie das OSGi-Bundle in das Verzeichnis jcr_root/apps/<PROJECT-NAME>-vendor-packages/container/install des all-Moduls. Dieser Schritt ist erforderlich, um das Bundle zu verpacken und in der AEM-Instanz bereitzustellen.

Aktualisieren Sie die pom.xml-Dateien von Stamm und Kernmodul, um das OSGi-Bundle als Abhängigkeit mit dem Bereich system und dem auf die Bundle-Datei verweisenden systemPath hinzuzufügen. Dieser Schritt ist erforderlich, um das Projekt zu kompilieren.

Laden Sie die Datei my-example-jar.zip herunter und extrahieren Sie sie.

Erstellen Sie im all-Modul des AEM-WKND-Projekts die Verzeichnisstruktur all/resource/jar.

Kopieren Sie die Datei my-example-jar-1.0-SNAPSHOT.jar aus dem extrahierten Verzeichnis target in das obige Verzeichnis all/resource/jar.

Erstellen Sie im core-Modul des AEMWKND-Projekts das SayHello.java-Sling-Servlet unter 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());
    }
}

Fügen Sie in derpom.xml-Stammdatei des AEM-WKND-Projekts die Datei my-example-jar als Abhängigkeit hinzu.

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

Hierbei gilt:

• Der system-Bereich gibt an, dass die Abhängigkeit nicht im öffentlichen Maven-Repository nachgeschlagen werden sollte.
• systemPath ist der Pfad zur Datei my-example-jar im all-Modul des AEM-WKND-Projekts.
• ${maven.multiModuleProjectDirectory} ist eine Maven-Eigenschaft, die auf das Stammverzeichnis des Multi-Modul-Projekts verweist.

Nehmen Sie in der Datei core/pom.xml im core-Modul des AEM-WKND-Projekts zwei Änderungen vor:

• Fügen Sie die Datei my-example-jar als Abhängigkeit hinzu.

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

• Aktualisieren Sie die bnd-maven-plugin-Konfiguration, um die Datei my-example-jar in das OSGi-Bundle (aem-guides-wknd.core) einzuschließen, das erstellt wird.

  code language-xml

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

Verwenden Sie den folgenden Befehl, um das AEM-WKND-Projekt zu erstellen und bereitzustellen:

$ mvn clean install -PautoInstallPackage

Stellen Sie sicher, dass das SayHello-Servlet wie erwartet funktioniert, indem Sie auf die URL http://localhost:4502/bin/sayhello im Browser zugreifen.

Übergeben Sie die oben genannten Änderungen an das Repository des AEM-WKND-Projekts. Überprüfen Sie dann die Änderungen in der RDE- oder AEM-Umgebung, indem Sie die Cloud Manager-Pipeline ausführen.

Kopieren Sie die Java-JAR-Datei in das Verzeichnis resource/jar des all-Moduls.

Aktualisieren Sie die pom.xml-Dateien von Stamm und Kernmodul, um die Java-JAR-Datei als Abhängigkeit mit dem Bereich system und dem auf die JAR-Datei verweisenden systemPath hinzuzufügen.

Kommentieren oder entfernen Sie die ACS AEM Commons-Release-Abhängigkeit aus der POM-Datei. Informationen zur Identifizierung der Abhängigkeit finden Sie unter Hinzufügen von ACS AEM Commons zu Ihrem AEM Maven-Projekt.

Klonen Sie die master-Verzweigung des ACS AEM Commons-Repositorys auf Ihren lokalen Computer.

Erstellen Sie die ACS AEM Commons-SNAPSHOT-Version mit dem folgenden Befehl:

$mvn clean install

Das lokal erstellte Paket befindet sich unter all/target. Es gibt zwei ZIP-Dateien. Die Datei, die auf -cloud endet, ist für AEM as a Cloud Service bestimmt, die andere für AEM 6.X.

Erstellen Sie im all-Modul des AEM-WKND-Projekts die Verzeichnisstruktur all/src/main/content/jcr_root/apps/wknd-vendor-packages/container/install. Das Verzeichnis /all/src/main/content ist vorhanden. Sie müssen nur die Verzeichnisse jcr_root/apps/wknd-vendor-packages/container/install erstellen.

Kopieren Sie die lokal erstellte Paketdatei (.zip) in das Verzeichnis /all/src/main/content/jcr_root/apps/mysite-vendor-packages/container/install.

Verwenden Sie den folgenden Befehl, um das AEM-WKND-Projekt zu erstellen und bereitzustellen:

$ mvn clean install -PautoInstallPackage

Überprüfen Sie das installierte ACS AEM Commons-Paket:

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

  

• OSGi-Konsole unter http://localhost:4502/system/console/bundles

  

Übergeben Sie die oben genannten Änderungen an das Repository des AEM-WKND-Projekts. Überprüfen Sie dann die Änderungen in der RDE- oder AEM-Umgebung, indem Sie die Cloud Manager-Pipeline ausführen.