Konfigurieren von OSGi

OSGi ist ein wesentlicher Bestandteil der Technologien von Adobe Experience Manager (AEM). OSGi wird zur Steuerung der AEM-Bundles und ihrer Konfiguration verwendet.

OSGi bietet standardisierte Grundbausteine – kleine, wiederverwendbare, gemeinsame genutzte Komponenten. Diese Komponenten können zu einem Programm zusammengefügt und bereitgestellt werden".

Dies ermöglicht die einfache Verwaltung von Bundles, da diese einzeln angehalten, installiert und gestartet werden können. Die gegenseitigen Abhängigkeiten werden automatisch verwaltet. Jede OSGi-Komponente (siehe OSGi-Spezifikation) ist in einem der Bundles enthalten.

Für die Festlegung der Konfigurationseinstellungen derartiger Bundles haben Sie folgende Möglichkeiten:

Jede dieser Methoden kann verwendet werden, es gibt aber leichte Unterschiede vor allem in Bezug auf Ausführungsmodi:

  • Adobe CQ Web-Konsole

    • Die Web-Konsole ist die Standard-Benutzeroberfläche für die OSGi-Konfiguration. In dieser Benutzeroberfläche können Sie die unterschiedlichen Eigenschaften bearbeiten, indem Sie aus vordefinierten Listen einen Wert auswählen.

      Dies ist die einfachste Methode.

    • Alle über die Web-Konsole durchgeführten Konfigurationen werden unmittelbar auf die aktuelle Instanz angewendet, und zwar unabhängig davon, welcher Ausführungsmodus gerade aktiv ist oder wie dieser zu einem späteren Zeitpunkt geändert werden könnte.

  • Konfigurationsdateien

    • Enthalten die in der Web-Konsole definierten Einstellungen
    • Können in Inhaltspakete zur Verwendung in anderen Instanzen eingeschlossen werden.
  • Inhaltsknoten (sling:osgiConfig) im Repository

    • Dies erfordert die manuelle Konfiguration mithilfe von CRXDE Lite.
    • Aufgrund der Namenskonventionen der sling:OsgiConfig-Knoten können Sie die Konfiguration an einen bestimmten Ausführungsmodus knüpfen. Sie können sogar Konfigurationen für mehrere Ausführungsmodi im selben Repository speichern.
    • Alle Konfigurationen werden sofort angewendet (abhängig vom Ausführungsmodus).

Unabhängig von der verwendeten Konfigurationsmethode bieten die Konfigurationen Folgendes:

  • Sie gewährleisten, dass das Kopieren oder Replizieren von Inhalten im Repository identische Konfigurationen erzeugt.
  • Sie ermöglichen es Ihnen, Konfigurationen entweder zur Verbesserung der Sicherheit oder für Aktualisierungen an das FileVault- oder Subversion-Tool zu übermitteln.
  • Sie können in Paketen gespeichert werden, die zur Einrichtung anderer Instanzen verwendet werden können.
  • Sie ermöglichen es Ihnen, mithilfe von Skripts Konfigurations-Rollouts zur Verteilung der Konfigurationsdetails durchzuführen.
HINWEIS

Details wichtiger Einstellungen werden unter OSGi-Konfigurationseinstellungen aufgelistet.

OSGi-Konfiguration mit der Web-Konsole

Die Web-Konsole in AEM bietet eine standardisierte Benutzeroberfläche für die Konfiguration der Bundles. Die Registerkarte Konfiguration dient zur Konfiguration der OSGi-Bundles und bildet deshalb den zugrunde liegenden Mechanismus für die Konfiguration der AEM-Systemparameter.

Alle Änderungen werden unverzüglich auf die entsprechende OSGi-Konfiguration angewendet. Es ist kein Neustart erforderlich.

HINWEIS

In der Web-Konsole durchgeführte Änderungen werden im Repository als Konfigurationsdateien gespeichert. Diese können in Inhaltspakete eingefügt und für weitere Installationen erneut verwendet werden.

HINWEIS

In der Web-Konsole beziehen sich alle Beschreibungen mit Standardeinstellungen auf Sling-Standardwerte.

Adobe Experience Manager verfügt über eigene Standardwerte. Deshalb können die eingestellten Standardwerte von den in der Konsole dokumentierten abweichen.

Um eine Konfiguration mit der Web-Konsole zu aktualisieren, gehen Sie folgendermaßen vor:

  1. Öffnen Sie die Registerkarte Konfiguration in der Web-Konsole, indem Sie einen dieser Schritte ausführen:

    • Öffnen Sie die Web-Konsole über den Link im Menü Tool > Vorgänge. Nach der Anmeldung in der Konsole können Sie dieses Dropdown-Menü verwenden:

      OSGi >

    • Die direkte URL, zum Beispiel:

      http://localhost:4502/system/console/configMgr
      Eine Liste wird angezeigt.

  2. Wählen Sie das Bundle aus, das Sie konfigurieren möchten, indem Sie eine dieser Optionen auswählen:

    • Klicken Sie auf das Symbol Bearbeiten für dieses Bundle.
    • Klicken Sie auf den Namen des Bundles.
  3. Ein Dialogfeld wird geöffnet. Hier können Sie nach Bedarf Änderungen vornehmen. Beispielsweise können Sie für die Protokollebene INFO festlegen:

    chlimage_1-140

    HINWEIS

    Aktualisierungen werden im Repository als Konfigurationsdateien gespeichert. Um diese zu einem späteren Zeitpunkt zu finden (z. B. um sie in einem Inhaltspaket in einer anderen Instanz einzuschließen), sollten Sie sich die persistente Identität ( PID) notieren.

  4. Klicken Sie auf Speichern.

    Ihre Änderungen werden unmittelbar auf die relevante OSGi-Konfiguration des aktuellen Systems angewendet. Es ist kein Neustart erforderlich.

    HINWEIS

    Sie können jetzt die damit verbundenen Konfigurationsdateien suchen, um sie beispielsweise in ein Inhaltspaket zur Verwendung in einer anderen Instanz einzuschließen.

OSGi-Konfiguration mit Konfigurationsdateien

Mit der Web-Konsole durchgeführte Konfigurationsänderungen werden im Repository als Konfigurationsdateien ( .config) hier gespeichert:

/apps

Diese können in Inhaltspaketen eingeschlossen und in anderen Instanzen wiederverwendet werden.

HINWEIS

Das Format der Konfigurationsdateien ist sehr spezifisch. Weitere Informationen finden Sie in der Sling Apache-Dokumentation.

Aus diesem Grund ist es empfehlenswert, die Erstellung und Wartung der Konfigurationsdatei in der Web-Konsole durchzuführen.

Die Web-Konsole zeigt nicht an, wo im Repository Ihre Änderungen gespeichert wurden, sie können aber einfach gefunden werden:

  1. Erstellen Sie die Konfigurationsdatei, indem Sie eine Änderung in der Web-Konsole vornehmen.

  2. Öffnen Sie CRXDE Lite.

  3. Wählen Sie im Menü Tools die Option Abfrage … aus.

  4. Führen Sie eine Abfrage vom Typ SQL durch, um nach der PID der Konfiguration zu suchen, die Sie aktualisiert haben.

    Beispiel: Apache Felix OSGi Management Console hat den Persistent Identifier (PID):

    org.apache.felix.webconsole.internal.servlet.OsgiManager

    Die SQL-Abfrage könnte also folgendermaßen lauten:

    select * from nt:base where jcr:path like '/apps/%' and contains(*, 'org.apache.felix.webconsole.internal.servlet.OsgiManager')
    
  5. Der Knoten der Konfigurationsdatei wird angezeigt.

    Für das oben genannte Beispiel:

    /apps/system/config/org.apache.felix.webconsole.internal.servlet.OsgiManager.config

    VORSICHT

    Sie können diese Datei öffnen, um sich Ihre Änderungen anzusehen, doch um Schreibfehler zu vermeiden, wird empfohlen, die tatsächlichen Änderungen in der Konsole vorzunehmen.

  6. Sie können jetzt ein Inhaltspaket erstellen, das diesen Knoten enthält, und es nach Bedarf in Ihren anderen Instanzen verwenden.

OSGi-Konfiguration im Repository

Neben der Verwendung der Web-Konsole ist die Definition der Konfigurationsdetails auch im Repository möglich. Damit können Sie die unterschiedlichen Ausführungsmodi einfach konfigurieren.

Diese Konfigurationen werden vorgenommen, indem sling:OsgiConfig-Knoten im Repository erstellt werden, auf die das System verweist. Diese Knoten bilden die OSGi-Konfigurationen ab und stellen für sie eine Benutzeroberfläche bereit. Um die Konfigurationsdaten zu aktualisieren, aktualisieren Sie die Knoteneigenschaften.

Wenn Sie die Konfigurationsdaten im Repository ändern, werden die Änderungen sofort auf die entsprechende OSGi-Konfiguration angewendet, so als ob die Änderungen in der Web-Konsole vorgenommen worden wären, einschließlich der entsprechenden Validierungs- und Konsistenzprüfungen. Dies gilt auch für das Kopieren einer Konfiguration von /libs/ nach /apps/.

Da derselbe Konfigurationsparameter an mehreren Orten gespeichert werden kann, geht das System folgendermaßen vor:

  • nach allen Knoten des Typs sling:OsgiConfig sucht.
  • Es filtert nach dem Dienstnamen;
  • Es filtert nach dem Ausführungsmodus.

Hinzufügen einer neuen Konfiguration zum Repository

Informationen, die Sie dafür benötigen

Um eine neue Konfiguration zum Repository hinzuzufügen, benötigen Sie folgende Informationen:

  1. Die Persistente Identität (PID) des Services.

    Referenzieren Sie das Feld Konfigurationen in der Web-Konsole. Der Name wird in Klammern hinter dem Bundle-Namen angezeigt (oder in den Konfigurationsinformationen am unteren Seitenrand).

    Erstellen Sie beispielsweise einen Knoten com.day.cq.wcm.core.impl.VersionManagerImpl. zum Konfigurieren von AEM WCM-Versions-Manager.

    chlimage_1-141

  2. Ob ein bestimmter Ausführungsmodus erforderlich ist. Erstellen Sie den Ordner:

    • config – für alle Ausführungsmodi
    • config.author – für die Autorenumgebung
    • config.publish – für die Veröffentlichungsumgebung
    • config.<run-mode> – soweit erforderlich
  3. Ob eine Konfiguration oder eine Werkskonfiguration nötig ist.

  4. Die einzelnen Parameter, die konfiguriert werden müssen, einschließlich etwaiger vorhandener Parameterdefinitionen, die neu erstellt werden müssen.

    Referenzieren Sie das einzelne Parameterfeld in der Web-Konsole. Der Name wird für jeden Parameter in Klammern angezeigt.

    Erstellen Sie beispielsweise eine Eigenschaft
    versionmanager.createVersionOnActivation, um Version bei Aktivierung erstellen zu konfigurieren.

    chlimage_1-142

  5. Gibt es bereits eine Konfiguration in /libs? Um alle Konfigurationsknoten in Ihrer Instanz aufzulisten, senden Sie über das Abfrage-Tool in CRXDE Lite die folgende SQL-Abfrage:

    select * from sling:OsgiConfig

    Wenn dies der Fall ist, kann diese Konfiguration nach /apps/<yourProject>/ kopiert und dann am neuen Ort angepasst werden.

Erstellen der Konfiguration im Repository

Um die neue Konfiguration zum Repository hinzuzufügen, gehen Sie folgendermaßen vor:

  1. Navigieren Sie mit CRXDE Lite zu:

    /apps/<yourProject>

  2. Wenn der Ordner noch nicht vorhanden ist, erstellen Sie den config-Ordner ( sling:Folder):

    • config – anwendbar auf alle Ausführungsmodi
    • config.<run-mode> – für einen bestimmten Ausführungsmodus
  3. Erstellen Sie unter diesem Ordner einen Knoten:

    • Typ: sling:OsgiConfig

    • Name: die persistente Identität (PID),

      Für den AEM WCM-Versions-Manager verwenden Sie z. B. com.day.cq.wcm.core.impl.VersionManagerImpl

    HINWEIS

    Wenn Sie eine Werkskonfiguration durchführen, hängen Sie an den Namen -<identifier> an.

    Wie in: org.apache.sling.commons.log.LogManager.factory.config-<identifier>

    Wobei <identifier> durch einen freien Text ersetzt wird, den Sie eingeben (müssen), um die Instanz zu identifizieren (diese Information darf nicht weggelassen werden); Beispiel:

    org.apache.sling.commons.log.LogManager.factory.config-MINE

  4. Erstellen Sie für jeden Parameter, den Sie konfigurieren möchten, eine Eigenschaft auf diesem Knoten:

    • Name: der Parametername, wie er in der Web-Konsole gezeigt wird. Der Name erscheint in Klammern am Ende der Feldbeschreibung. Für Create Version on Activation verwenden sie z. B. versionmanager.createVersionOnActivation
    • Typ: entsprechend
    • Wert: nach Bedarf

    Sie müssen nur Eigenschaften für die Parameter erstellen, die Sie konfigurieren möchten. Die anderen übernehmen die Standardwerte von AEM.

  5. Speichern Sie alle Änderungen.

    Die Änderungen werden angewendet, wenn der Knoten durch den Neustart des Dienstes aktualisiert wird (ebenso wie die in der Web-Konsole vorgenommenen Änderungen).

VORSICHT

Sie dürfen keinerlei Änderungen im Pfad /libs vornehmen.

VORSICHT

Der vollständige Pfad einer Konfiguration muss korrekt sein, damit er beim Start gelesen werden kann.

Konfigurationsdetails

Auflösungsreihenfolge beim Start

Die folgende Reihenfolge wird verwendet:

  1. Repository-Knoten unter /apps/*/config..., entweder vom Typ sling:OsgiConfig oder mit Eigenschaftsdateien.

  2. Repository-Knoten vom Typ sling:OsgiConfig unter /libs/*/config.... (vorgefertigte Definitionen).

  3. Alle .config-Dateien aus <*cq-installation-dir*>/crx-quickstart/launchpad/config/.... im lokalen Dateisystem.

Dies bedeutet, dass eine generische Konfiguration in /libs durch eine projektspezifische Konfiguration in /apps maskiert werden kann.

Auflösungsreihenfolge während der Laufzeit

Konfigurationsänderungen, die während der Laufzeit des Systems vorgenommen werden, lösen einen neuen Ladevorgang mit der geänderten Konfiguration aus.

Anschließend wird die folgende Reihenfolge angewendet:

  1. Die Änderung einer Konfiguration in der Web-Konsole wird sofort angewendet, da sie während der Laufzeit Vorrang hat.
  2. Die Änderung einer Konfiguration in /apps tritt sofort in Kraft.
  3. Die Änderung einer Konfiguration in /libs tritt sofort in Kraft, außer sie wird durch eine Konfiguration in /apps maskiert.

Auflösung mehrerer Ausführungsmodi

Für Ausführungsmodus-spezifische Konfigurationen können mehrere Ausführungsmodi kombiniert werden. Beispielsweise können Sie Konfigurationsordner vom folgenden Typ erstellen:

/apps/*/config.<runmode1>.<runmode2>/

Konfigurationen in derartigen Ordnern werden angewendet, wenn alle Ausführungsmodi mit einem beim Start definierten Ausführungsmodus übereinstimmen.

Beispiel: Wenn eine Instanz mit den Ausführungsmodi author,dev,emea gestartet wurde, werden die Konfigurationsknoten in /apps/*/config.emea, /apps/*/config.author.dev/ und /apps/*/config.author.emea.dev/ angewendet, während die Konfigurationsknoten in /apps/*/config.author.asean/ und /config/author.dev.emea.noldap/ nicht angewendet werden.

Wenn mehrere Konfigurationen für dieselbe PID anwendbar sind, wird die Konfiguration mit der höchsten Anzahl an passenden Ausführungsmodi angewendet.

Wenn beispielsweise eine Instanz mit den Ausführungsmodi gestartet wurde author,dev,emea, und beide /apps/*/config.author/ und /apps/*/config.emea.author/ Konfiguration für
com.day.cq.wcm.core.impl.VersionManagerImpl, die Konfiguration in /apps/*/config.emea.author/ angewendet werden.

Die Granularität dieser Regel liegt auf PID-Ebene.
Es ist nicht möglich, für dieselbe PID einige Eigenschaften in /apps/*/config.author/ und spezifischere in /apps/*/config.emea.author/ zu definieren.
Die Konfiguration mit der höchsten Anzahl von übereinstimmenden Ausführungsmodi tritt für die gesamte PID in Kraft.

Standardkonfigurationen

In der folgenden Liste finden Sie eine kleine Auswahl an verfügbaren Konfigurationen (in einer Standardinstallation) im Repository:

  • Autor – AEM WCM-Filter:

    libs/wcm/core/config.author/com.day.cq.wcm.core.WCMRequestFilter

  • Veröffentlichung – AEM WCM-Filter:

    libs/wcm/core/config.publish/com.day.cq.wcm.core.WCMRequestFilter

  • Veröffentlichung – AEM WCM-Seitenstatistiken:

    libs/wcm/core/config.publish/com.day.cq.wcm.core.stats.PageViewStatistics

HINWEIS

Da diese Konfigurationen in /libs gespeichert sind, dürfen sie nicht direkt bearbeitet werden, sondern müssen vor der Anpassung in Ihren Anwendungsbereich (/apps) kopiert werden.

Um alle Konfigurationsknoten in Ihrer Instanz aufzulisten, senden Sie über die Abfrage-Funktion in CRXDE Lite die folgende SQL-Abfrage:

select * from sling:OsgiConfig

Persistenz von Konfigurationen

  • Wenn Sie eine Konfiguration über die Web-Konsole ändern, wird sie (normalerweise) über folgenden Pfad in das Repository geschrieben:

    /apps/{somewhere}

    • Das standardmäßige {somewhere} ist system/config, sodass die Konfiguration in diesen Pfad geschrieben wird:

      /apps/system/config

    • Wenn Sie jedoch eine Konfiguration bearbeiten, die ursprünglich von einem anderen Ort im Repository stammte, zum Beispiel:

      /libs/foo/config/someconfig

      dann wird die aktualisierte Konfiguration unter dem ursprünglichen Speicherort geschrieben. Beispiel:

      /apps/foo/config/someconfig

  • Einstellungen, die vom admin geändert werden, werden in *.config-Dateien gespeichert, und zwar unter:

       /crx-quickstart/launchpad/config
    
    • Dies ist der private Datenbereich der OSGi-Konfigurationsverwaltung. Er enthält alle Konfigurationsdetails, die durch admin spezifiziert wurden, und zwar unabhängig davon, wie sie in das System gelangt sind.

    • Dies ist ein Implementierungsdetail; Sie dürfen dieses Verzeichnis nie direkt bearbeiten.

    • Es ist jedoch hilfreich, den Speicherort dieser Konfigurationsdateien zu kennen, damit Sie Kopien zur Sicherung und/oder mehrere Installationen erstellen können:

      • Apache Felix OSGi-Management Console

        ../crx/org/apache/felix/webconsole/internal/servlet/OsgiManager.config

      • CRX Sling Client Repository

        ../com/day/crx/sling/client/impl/CRXSlingClientRepository/<pid-nr>.config

VORSICHT

Die Ordner oder Dateien an diesem Speicherort dürfen Sie niemals bearbeiten:

/crx-quickstart/launchpad/config

Auf dieser Seite