DokumentationAEM 6.4Användarhandbok om distribution

Konfigurerar OSGi configuring-osgi

Last update: Thu May 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Skapat för:

  • Developer
CAUTION
AEM 6.4 har nått slutet på den utökade supporten och denna dokumentation är inte längre uppdaterad. Mer information finns i teknisk supportperiod. Hitta de versioner som stöds här.

OSGi är en grundläggande del i Adobe Experience Manager (AEM) teknikstack. Det används för att styra de sammansatta AEM och deras konfiguration.

OSGi "innehåller standardmallar som gör det möjligt att konstruera program utifrån små, återanvändbara och samverkansbaserade komponenter. Dessa komponenter kan sammanställas i ett program och distribueras".

Detta gör det enkelt att hantera paket när de kan stoppas, installeras och startas individuellt. De inbördes beroendena hanteras automatiskt. Varje OSGi-komponent (se OSGi-specifikation) finns i ett av de olika paketen.

Du kan hantera konfigurationsinställningarna för sådana paket genom att antingen:

Båda metoderna kan användas trots att det finns små skillnader, främst i relation till Körningslägen:

  • Adobe CQ webbkonsol

    • Webbkonsolen är standardgränssnittet för OSGi-konfiguration. Det innehåller ett användargränssnitt för redigering av de olika egenskaperna, där möjliga värden kan väljas från fördefinierade listor.

      Det är därför den enklaste metoden.

    • Alla konfigurationer som görs med webbkonsolen tillämpas omedelbart och tillämpas på den aktuella instansen, oavsett aktuellt körningsläge eller eventuella efterföljande ändringar av körningsläget.

  • konfigurationsfiler

    • Innehåller inställningar som är definierade i webbkonsolen.
    • Kan inkluderas i innehållspaket för användning i andra instanser.

  • content-nodes (sling:osgiConfig) i databasen

    • Detta kräver manuell konfiguration med CRXDE Lite.
    • På grund av namngivningskonventionerna för sling:OsgiConfig -noder kan du koppla konfigurationen till en viss körningsläge. Du kan även spara konfigurationer för mer än ett körningsläge i samma databas.
    • Alla lämpliga konfigurationer används omedelbart (beroende på körningsläget).

Alla dessa konfigurationsmetoder, oavsett vilken metod du använder:

  • Kontrollera att identiska konfigurationer återskapas när du kopierar eller replikerar databasinnehållet.
  • Gör att du kan checka ut konfigurationer till FileVault eller Subversion; antingen för säkerhetsuppdateringar eller ytterligare uppdateringar.
  • Kan sparas i paket som kan användas när du konfigurerar andra instanser.
  • Gör att du kan utföra konfigurationsimplementeringar med skript för att föreslå konfigurationsinformation.
NOTE
Information om vissa viktiga inställningar finns i listan under Konfigurationsinställningar för OSGi.

OSGi-konfiguration med webbkonsolen osgi-configuration-with-the-web-console

The Webbkonsol i AEM tillhandahåller ett standardiserat gränssnitt för att konfigurera paketen. The Konfiguration -fliken används för att konfigurera OSGi-paket och är därför den underliggande mekanismen för att konfigurera AEM systemparametrar.

Alla ändringar som görs tillämpas omedelbart på den aktuella OSGi-konfigurationen, ingen omstart krävs.

NOTE
Ändringar som görs i webbkonsolen sparas i databasen som konfigurationsfiler. Dessa kan ingå i innehållspaket för återanvändning i ytterligare installationer.
NOTE
På webbkonsolen finns beskrivningar som anger standardinställningar för Sling.
Adobe Experience Manager har sina egna standardinställningar, så standarduppsättningen kan skilja sig från dem som finns dokumenterade på konsolen.

Så här uppdaterar du en konfiguration med webbkonsolen:

  1. Öppna Konfiguration fliken Web Console av antingen:

    • Öppna webbkonsolen från länken på panelen Verktyg -> Åtgärder -menyn. När du har loggat in på konsolen kan du använda den nedrullningsbara menyn i:

      OSGi >

    • Den direkta URL:en. till exempel:

      http://localhost:4502/system/console/configMgr
      En lista visas.

  2. Välj det paket som du vill konfigurera genom att antingen:

    • klicka på Redigera ikon för paketet
    • klicka på Namn i paketet

  3. En dialogruta öppnas. Här kan du redigera efter behov; till exempel anger du Loggnivå till INFO:

    chlimage_1-140

    note note
    NOTE
    Uppdateringar sparas i databasen som konfigurationsfiler. Om du vill hitta dessa efteråt (t.ex. ta med i ett innehållspaket för användning i en annan instans) bör du göra en anteckning om den beständiga identiteten ( PID).

  4. Klicka Spara.

    Ändringarna tillämpas omedelbart på den aktuella OSGi-konfigurationen för det system som körs, ingen omstart krävs.

    note note
    NOTE
    Du kan nu hitta den relaterade konfigurationsfil(er); om du till exempel vill inkludera i ett innehållspaket som ska användas på en annan instans.

OSGi-konfiguration med konfigurationsfiler osgi-configuration-with-configuration-files

Konfigurationsändringar som görs med webbkonsolen sparas i databasen som konfigurationsfiler ( .config) under:

/apps

Dessa kan inkluderas i innehållspaket och återanvändas i andra instanser.

NOTE
Konfigurationsfilernas format är mycket specifikt - se Sling Apache-dokumentation för fullständig information.
Därför rekommenderar vi att du skapar och underhåller konfigurationsfilen genom att göra faktiska ändringar i webbkonsolen.

Webbkonsolen visar ingen indikation på var i databasen dina ändringar har sparats, men de är enkla att hitta:

  1. Skapa konfigurationsfilen genom att göra en första ändring i webbkonsolen.

  2. Öppna CRXDE Lite.

  3. I verktyg menyval Fråga … .

  4. Skicka en fråga om Typ SQL om du vill söka efter PID för konfigurationen som du har uppdaterat.

    Till exempel: Apache Felix OSGi Management Console har den beständiga identiteten (PID) för:

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

    Så SQL-frågan kan vara:

    code language-shell 
    select * from nt:base where jcr:path like '/apps/%' and contains(*, 'org.apache.felix.webconsole.internal.servlet.OsgiManager')

  5. Konfigurationsfilsnoden visas.

    I exemplet ovan:

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

    note caution
    CAUTION
    Du kan öppna den här filen om du vill visa ändringarna, men för att undvika att skriva fel bör du göra faktiska ändringar i konsolen.

  6. Du kan nu skapa ett innehållspaket som innehåller den här noden och använda det som behövs på dina andra instanser.

OSGi-konfiguration i databasen osgi-configuration-in-the-repository

Förutom att använda webbkonsolen kan du även definiera konfigurationsinformation i databasen. På så sätt kan du enkelt konfigurera olika körningslägen.

Dessa konfigurationer skapas genom att skapa sling:OsgiConfig noder i databasen som systemet ska referera till. Dessa noder speglar OSGi-konfigurationerna och utgör ett användargränssnitt för dem. Om du vill uppdatera konfigurationsdata uppdaterar du nodegenskaperna.

Om du ändrar konfigurationsdata i databasen tillämpas ändringarna omedelbart på den aktuella OSGi-konfigurationen som om ändringarna gjorts med webbkonsolen, med lämplig validering och konsekvenskontroll. Detta gäller även kopiering av en konfiguration från /libs/ till /apps/.

Eftersom samma konfigurationsparameter kan finnas på flera platser, kan systemet:

  • söker efter alla noder av typen sling:OsgiConfig
  • filter efter tjänstnamn
  • filter enligt körningsläge
NOTE
Läs även definiera en databasbaserad konfiguration för en viss instans.

Lägga till en ny konfiguration i databasen adding-a-new-configuration-to-the-repository

Vad du behöver veta what-you-need-to-know

Om du vill lägga till en ny konfiguration i databasen måste du känna till följande:

  1. The Beständig identitet (PID) för tjänsten.

    Referera till Konfigurationer i webbkonsolen. Namnet visas inom parentes efter paketnamnet (eller i Konfigurationsinformation längst ned på sidan).

    Skapa till exempel en nod com.day.cq.wcm.core.impl.VersionManagerImpl. för att konfigurera AEM WCM Version Manager.

    chlimage_1-141

  2. Om ett specifikt körningsläge krävs. Skapa mappen:

    • config - för alla körningslägen
    • config.author - för redigeringsmiljön
    • config.publish - för publiceringsmiljön
    • config.<run-mode> - i förekommande fall

  3. Om Konfiguration eller Fabrikskonfiguration är nödvändigt.

  4. De enskilda parametrar som ska konfigureras. inklusive befintliga parameterdefinitioner som behöver återskapas.

    Referera till det enskilda parameterfältet i webbkonsolen. Namnet visas inom hakparenteser för varje parameter.

    Skapa till exempel en egenskap
    versionmanager.createVersionOnActivation för att konfigurera Skapa version vid aktivering.

    chlimage_1-142

  5. Finns det redan en konfiguration i /libs? Om du vill visa alla konfigurationer i din instans använder du Fråga i CRXDE Lite för att skicka följande SQL-fråga:

    select * from sling:OsgiConfig

    I så fall kan den här konfigurationen kopieras till /apps/<yourProject>/och sedan anpassats på den nya platsen.

Skapa konfigurationen i databasen creating-the-configuration-in-the-repository

Så här lägger du till den nya konfigurationen i databasen:

  1. Använd CRXDE Lite för att navigera till:

    /apps/<yourProject>

  2. Om den inte redan finns skapar du config mapp ( sling:Folder):

    • config - gäller för alla körlägen
    • config.<run-mode> - specifikt för ett visst körläge

  3. Skapa en nod under den här mappen:

    • Typ: sling:OsgiConfig

    • Namn: Den beständiga identiteten (PID).

      till exempel AEM WCM Version Manager använder com.day.cq.wcm.core.impl.VersionManagerImpl

    note note
    NOTE
    När du skapar ett fabrikskonfiguration som tillägg -<identifier> till namnet.
    Som i: org.apache.sling.commons.log.LogManager.factory.config-<identifier>
    Plats <identifier> ersätts med fritext som du (måste) anger för att identifiera förekomsten (du kan inte utelämna denna information), till exempel:
    org.apache.sling.commons.log.LogManager.factory.config-MINE

  4. Skapa en egenskap på den här noden för varje parameter som du vill konfigurera:

    • Namn: parameternamnet som visas i webbkonsolen, namnet visas inom parentes i slutet av fältbeskrivningen. Till exempel Create Version on Activation use versionmanager.createVersionOnActivation
    • Typ: i tillämpliga fall.
    • Värde: efter behov.

    Du behöver bara skapa egenskaper för de parametrar som du vill konfigurera, medan andra fortfarande använder standardvärdena som de har angetts av AEM.

  5. Spara alla ändringar.

    Ändringarna tillämpas så snart noden uppdateras genom att tjänsten startas om (som med ändringarna i webbkonsolen).

CAUTION
Du får inte ändra något i /libs bana.
CAUTION
Den fullständiga sökvägen till en konfiguration måste vara korrekt för att den ska kunna läsas vid start.

Konfigurationsinformation configuration-details

Upplösningsordning vid start resolution-order-at-startup

Följande prioritetsordning används:

  1. Databasnoder under /apps/*/config...antingen med text sling:OsgiConfig eller egenskapsfiler.

  2. Databasnoder med typ sling:OsgiConfig under /libs/*/config.... (färdiga definitioner).

  3. Alla .config filer från <*cq-installation-dir*>/crx-quickstart/launchpad/config/.... i det lokala filsystemet.

Detta innebär en allmän konfiguration i /libs kan maskeras av en projektspecifik konfiguration i /apps.

Upplösningsordning vid körning resolution-order-at-runtime

Konfigurationsändringar som görs medan systemet körs utlöser en omladdning med den ändrade konfigurationen.

Sedan gäller följande prioritetsordning:

  1. När du ändrar en konfiguration i webbkonsolen börjar det gälla direkt när det gäller körning.
  2. Ändra en konfiguration i /apps träder i kraft omedelbart.
  3. Ändra en konfiguration i /libs börjar gälla omedelbart, såvida det inte maskeras av en konfiguration i /apps.

Upplösning för flera körningslägen resolution-of-multiple-run-modes

För körningslägesspecifika konfigurationer kan flera körningslägen kombineras. Du kan till exempel skapa konfigurationsmappar med följande format:

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

Konfigurationer i sådana mappar används om alla körningslägen matchar ett körningsläge som har definierats vid start.

Om en instans till exempel startades med körningslägena author,dev,emea, konfigurationsnoder i /apps/*/config.emea, /apps/*/config.author.dev/ och /apps/*/config.author.emea.dev/ kommer att tillämpas medan konfigurationsnoder i /apps/*/config.author.asean/ och /config/author.dev.emea.noldap/ kommer inte att tillämpas.

Om flera konfigurationer för samma PID kan användas, används konfigurationen med det högsta antalet matchande körningslägen.

Om en instans till exempel startades med körningslägena author,dev,emeaoch både /apps/*/config.author/ och /apps/*/config.emea.author/ definiera en konfiguration för
com.day.cq.wcm.core.impl.VersionManagerImpl, konfigurationen i /apps/*/config.emea.author/ kommer att tillämpas.

Regelns granularitet är på PID-nivå.
Du kan inte definiera vissa egenskaper för samma PID i /apps/*/config.author/ och mer specifika /apps/*/config.emea.author/ för samma PID.
Konfigurationen med det högsta antalet matchande körningslägen gäller för hela PID.

Standardkonfigurationer standard-configurations

I följande lista visas ett litet urval av de konfigurationer som är tillgängliga (i en standardinstallation) i databasen:

  • Författare - AEM WCM-filter:

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

  • Publicera - AEM WCM-filter:

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

  • Publicera - AEM WCM-sidstatistik:

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

NOTE
När dessa konfigurationer finns i /libs de får inte redigeras direkt, utan kopieras till programområdet ( /apps) före anpassning.

Om du vill visa alla konfigurationsnoder i din instans använder du Fråga i CRXDE Lite för att skicka följande SQL-fråga:

select * from sling:OsgiConfig

Konfigurationsbeständighet configuration-persistence

  • Om du ändrar en konfiguration via webbkonsolen skrivs den (vanligtvis) in i databasen på:

    /apps/{somewhere}

    • Som standard {somewhere} är system/config så att konfigurationen skrivs till

      /apps/system/config

    • Om du redigerar en konfiguration som ursprungligen kom från en annan plats i databasen: till exempel:

      /libs/foo/config/someconfig

      Den uppdaterade konfigurationen skrivs sedan under den ursprungliga platsen. till exempel:

      /apps/foo/config/someconfig

  • Inställningar som ändrats av admin sparas i *.config filer under:

    code language-none 
       /crx-quickstart/launchpad/config

    • Detta är det privata dataområdet för OSGi-konfigurationsadministratören och innehåller all konfigurationsinformation som anges av admin, oavsett hur de gick in i systemet.

    • Detta är en implementeringsdetalj och du får aldrig redigera den här katalogen direkt.

    • Det är emellertid praktiskt att veta var dessa konfigurationsfiler finns så att kopior kan tas för säkerhetskopiering och/eller flera installationer:

      • 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

CAUTION
Du måste aldrig redigera mapparna eller filerna under:
/crx-quickstart/launchpad/config
recommendation-more-help
6a71a83d-c2e0-4ce7-a6aa-899aa3885b56