DocumentazioneAEM 6.5Guida utente

Configurazione di OSGi configuring-osgi

Last update: Sun Jul 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Creato per:

  • Amministratore

OSGi è un elemento fondamentale nello stack tecnologico di Adobe Experience Manager (AEM). Viene utilizzato per controllare i bundle compositi dell'AEM e la loro configurazione.

OSGi "fornisce le primitive standardizzate che consentono di creare applicazioni a partire da componenti di piccole dimensioni, riutilizzabili e collaborativi. Questi componenti possono essere composti in un'applicazione e distribuiti".

In questo modo è possibile gestire facilmente i bundle che possono essere arrestati, installati e avviati singolarmente. Le interdipendenze vengono gestite automaticamente. Ogni componente OSGi (vedi la specifica OSGi) è contenuto in uno dei vari bundle.

Puoi gestire le impostazioni di configurazione per tali bundle:

Entrambi i metodi possono essere utilizzati anche se ci sono sottili differenze, principalmente in relazione a Modalità di esecuzione:

  • Console web di Adobe CQ

    • La console web è l’interfaccia standard per la configurazione OSGi. Fornisce un’interfaccia utente per la modifica delle varie proprietà, dove è possibile selezionare i valori possibili dagli elenchi predefiniti.

      In quanto tale, è il metodo più semplice da utilizzare.

    • Tutte le configurazioni effettuate con la console web vengono applicate immediatamente e sono applicabili all’istanza corrente, indipendentemente dalla modalità di esecuzione corrente o da eventuali modifiche successive.

  • file di configurazione

    • Contengono le impostazioni definite nella console web.
    • Può essere incluso nei pacchetti di contenuti per l’utilizzo in altre istanze.

  • content-nodes (sling:osgiConfig) nell’archivio

    • Richiede la configurazione manuale con CRXDE Lite.
    • A causa delle convenzioni di denominazione dei nodi sling:OsgiConfig, è possibile collegare la configurazione a una modalità di esecuzione specifica. Puoi anche salvare le configurazioni per più di una modalità di esecuzione nello stesso archivio.
    • Tutte le configurazioni appropriate vengono applicate immediatamente (a seconda della modalità di esecuzione).

Indipendentemente dal metodo utilizzato, tutti i metodi di configurazione seguenti:

  • Assicurarsi che la copia o la replica del contenuto dell'archivio ricrei configurazioni identiche.
  • Consente di estrarre le configurazioni in FileVault o Subversion per motivi di sicurezza o per ulteriori aggiornamenti.
  • Possono essere salvate in pacchetti da utilizzare per la configurazione di altre istanze.
  • Consente di eseguire i rollout di configurazione utilizzando script per propagare i dettagli di configurazione.
NOTE
I dettagli di alcune impostazioni importanti sono elencati in Impostazioni di configurazione OSGi.

Configurazione OSGi con la console web osgi-configuration-with-the-web-console

La console Web in AEM fornisce un'interfaccia standardizzata per la configurazione dei bundle. La scheda Configurazione viene utilizzata per la configurazione dei bundle OSGi ed è pertanto il meccanismo sottostante per la configurazione dei parametri di sistema AEM.

Tutte le modifiche apportate vengono immediatamente applicate alla configurazione OSGi pertinente, non è necessario riavviare il sistema.

NOTE
Le modifiche apportate nella console Web vengono salvate nel repository come file di configurazione. Questi file possono essere inclusi nei pacchetti di contenuti per essere riutilizzati in ulteriori installazioni.
NOTE
Nella console Web, tutte le descrizioni che menzionano le impostazioni predefinite si riferiscono alle impostazioni predefinite di Sling.
Adobe Experience Manager dispone di proprie impostazioni predefinite; pertanto, le impostazioni predefinite impostate potrebbero essere diverse da quelle documentate nella console.

Per aggiornare una configurazione con la console web:

  1. Accedere alla scheda Configurazione della console Web:

    • Apertura della console Web dal collegamento nel menu Strumento > Operazioni. Dopo l’accesso alla console, puoi utilizzare il menu a discesa di:

      OSGi >

    • L’URL diretto; ad esempio:

      http://localhost:4502/system/console/configMgr

    Viene visualizzato un elenco.

  2. Seleziona il bundle da configurare effettuando una delle seguenti operazioni:

    • clic sull'icona Modifica per il bundle
    • clic su Nome del bundle

  3. Viene visualizzata una finestra di dialogo. Qui puoi modificare in base alle esigenze. Ad esempio, impostare Log Level su INFO:

    chlimage_1-140

    note note
    NOTE
    Gli aggiornamenti vengono salvati nel repository come file di configurazione. Per individuare successivamente questi file da includere in un pacchetto di contenuti per l'utilizzo in un'altra istanza, ad esempio, prendere nota dell'identità persistente ( PID).

  4. Fai clic su Salva.

    Le modifiche vengono immediatamente applicate alla configurazione OSGi pertinente del sistema in esecuzione, non è necessario riavviare il sistema.

    note note
    NOTE
    È ora possibile individuare i file di configurazione correlati. Ad esempio, per includere in un pacchetto di contenuti per l’utilizzo in un’altra istanza.

Configurazione OSGi con file di configurazione osgi-configuration-with-configuration-files

Le modifiche apportate alla configurazione tramite la console Web vengono mantenute nel repository come file di configurazione ( .config) in:

/apps

Questi file possono essere inclusi nei pacchetti di contenuti e riutilizzati in altre istanze.

NOTE
Il formato dei file di configurazione è specifico. Consulta la documentazione di Sling Apache per:
Per questo motivo, si consiglia di creare e gestire il file di configurazione apportando modifiche effettive nella console web.

La console Web non mostra alcuna indicazione sulla posizione in cui sono state salvate le modifiche nell’archivio, ma è possibile individuarle facilmente:

  1. Crea il file di configurazione apportando una modifica iniziale nella console Web.

  2. Apri CRXDE Lite.

  3. Nel menu Strumenti, selezionare Query ….

  4. Per cercare il PID della configurazione aggiornata, inviare una query di Tipo SQL.

    Ad esempio, Apache Felix OSGi Management Console ha l'identità persistente (PID) di:

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

    Pertanto, la query SQL potrebbe essere:

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

  5. Viene visualizzato il nodo del file di configurazione.

    Per l’esempio precedente:

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

    note caution
    CAUTION
    Puoi aprire questo file per visualizzare le modifiche, ma per evitare errori di digitazione si consiglia di apportare modifiche effettive con la console.

  6. Ora puoi creare un pacchetto di contenuti contenente questo nodo e utilizzarlo come richiesto sulle altre istanze.

Configurazione OSGi nell’archivio osgi-configuration-in-the-repository

Oltre a utilizzare la console web, puoi anche definire i dettagli di configurazione nell’archivio. In questo modo è possibile configurare facilmente le diverse modalità di esecuzione.

Queste configurazioni vengono effettuate creando sling:OsgiConfig nodi nell'archivio a cui il sistema può fare riferimento. Questi nodi rispecchiano le configurazioni OSGi e a essi viene creata un’interfaccia utente. Per aggiornare i dati di configurazione, devi aggiornare le proprietà del nodo.

Se modifichi i dati di configurazione nell’archivio, le modifiche vengono immediatamente applicate alla configurazione OSGi pertinente. È come se le modifiche fossero state apportate utilizzando la console Web, con i controlli di convalida e coerenza appropriati. Questo flusso di lavoro si applica anche all'azione di copia di una configurazione da /libs/ a /apps/.

Poiché lo stesso parametro di configurazione si trova in più posizioni, il sistema:

  • cerca tutti i nodi di tipo sling:OsgiConfig
  • filtri in base al nome del servizio
  • filtri in base alla modalità di esecuzione
NOTE
Leggi anche come definire una configurazione basata su repository solo per un'istanza specifica.

Aggiunta di una nuova configurazione all’archivio adding-a-new-configuration-to-the-repository

Cosa è necessario sapere what-you-need-to-know

Per aggiungere una configurazione all’archivio, è necessario conoscere quanto segue:

  1. Identità persistente (PID) del servizio.

    Fai riferimento al campo Configurazioni nella console Web. Il nome viene visualizzato tra parentesi dopo il nome del bundle (o in Informazioni di configurazione nella parte inferiore della pagina).

    Ad esempio, creare un nodo com.day.cq.wcm.core.impl.VersionManagerImpl. per configurare Gestione versioni WCM AEM.

    chlimage_1-141

  2. È richiesta una modalità di esecuzione specifica? Crea la cartella:

    • config - per tutte le modalità di esecuzione
    • config.author - per l'ambiente di authoring
    • config.publish - per l'ambiente di pubblicazione
    • config.<run-mode> - come appropriato

  3. È necessaria una configurazione o una configurazione factory?

  4. I singoli parametri da configurare, comprese le definizioni di parametri esistenti che devono essere ricreati.

    Fai riferimento al singolo campo dei parametri nella console Web. Il nome viene visualizzato tra parentesi per ciascun parametro.

    Ad esempio, crea una proprietà
    versionmanager.createVersionOnActivation per configurare Crea versione su attivazione.

    chlimage_1-142

  5. Esiste una configurazione in /libs? Per elencare tutte le configurazioni nell'istanza, utilizzare lo strumento Query in CRXDE Lite per inviare la seguente query SQL:

    select * from sling:OsgiConfig

    In tal caso, è possibile copiare la configurazione in /apps/<yourProject>/ e quindi personalizzarla nel nuovo percorso.

Creazione della configurazione nel repository creating-the-configuration-in-the-repository

Per aggiungere effettivamente la nuova configurazione all’archivio:

  1. Utilizza CRXDE Lite per passare a:

    /apps/<yourProject>

  2. Se non esiste, creare la cartella config ( sling:Folder):

    • config - applicabile a tutte le modalità di esecuzione
    • config.<run-mode> - specifico per una particolare modalità di esecuzione

  3. In questa cartella, crea un nodo:

    • Tipo: sling:OsgiConfig

    • Nome: identità persistente (PID);

      ad esempio, per AEM WCM Version Manager utilizzare com.day.cq.wcm.core.impl.VersionManagerImpl

    note note
    NOTE
    Quando si crea una configurazione di fabbrica, aggiungere -<identifier> al nome.
    Come in: org.apache.sling.commons.log.LogManager.factory.config-<identifier>
    Dove <identifier> è sostituito da testo libero che è necessario immettere per identificare l'istanza (non è possibile omettere queste informazioni); ad esempio:
    org.apache.sling.commons.log.LogManager.factory.config-MINE

  4. Per ogni parametro da configurare, crea una proprietà su questo nodo:

    • Nome: il nome del parametro come mostrato nella console Web; il nome viene visualizzato tra parentesi alla fine della descrizione del campo. Ad esempio, per Create Version on Activation utilizzare versionmanager.createVersionOnActivation
    • Tipo: a seconda dei casi.
    • Valore: come richiesto.

    È necessario creare solo le proprietà per i parametri che si desidera configurare, mentre per gli altri parametri vengono comunque utilizzati i valori predefiniti impostati dall'AEM.

  5. Salva tutte le modifiche.

    Le modifiche vengono applicate quando il nodo viene aggiornato riavviando il servizio (come con le modifiche apportate nella console Web).

CAUTION
Non modificare nulla nel percorso /libs.
CAUTION
Il percorso completo di una configurazione deve essere corretto per essere letto all'avvio.

Dettagli configurazione configuration-details

Ordine di risoluzione all'avvio resolution-order-at-startup

Viene utilizzato il seguente ordine di precedenza:

  1. Nodi dell'archivio in /apps/*/config....con tipo sling:OsgiConfig o file di proprietà.

  2. Nodi dell'archivio con tipo sling:OsgiConfig in /libs/*/config.... (definizioni predefinite).

  3. Qualsiasi file .config da <*cq-installation-dir*>/crx-quickstart/launchpad/config/.... sul file system locale.

Una configurazione generica in /libs può essere mascherata da una configurazione specifica del progetto in /apps.

Ordine di risoluzione in fase di esecuzione resolution-order-at-runtime

Le modifiche apportate alla configurazione durante l'esecuzione del sistema attivano un ricaricamento con la configurazione modificata.

Si applica quindi il seguente ordine di precedenza:

  1. La modifica di una configurazione nella console web ha effetto immediato in quanto ha la precedenza in fase di esecuzione.
  2. La modifica di una configurazione in /apps ha effetto immediato.
  3. La modifica di una configurazione in /libs ha effetto immediato, a meno che non sia mascherata da una configurazione in /apps.

Risoluzione di più modalità di esecuzione resolution-of-multiple-run-modes

Per le configurazioni specifiche della modalità di esecuzione, è possibile combinare più modalità di esecuzione. Ad esempio, puoi creare cartelle di configurazione con lo stile seguente:

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

Le configurazioni in tali cartelle vengono applicate se tutte le modalità di esecuzione corrispondono a una modalità di esecuzione definita all'avvio.

Ad esempio, se un'istanza è stata avviata con le modalità di esecuzione author,dev,emea, vengono applicati i nodi di configurazione in /apps/*/config.emea, /apps/*/config.author.dev/ e /apps/*/config.author.emea.dev/, mentre i nodi di configurazione in /apps/*/config.author.asean/ e /config/author.dev.emea.noldap/ non vengono applicati.

Se sono applicabili più configurazioni per lo stesso PID, viene applicata la configurazione con il maggior numero di modalità di esecuzione corrispondenti.

Ad esempio, se un'istanza è stata avviata con le modalità di esecuzione author,dev,emea e sia /apps/*/config.author/ che /apps/*/config.emea.author/ definiscono una configurazione per
com.day.cq.wcm.core.impl.VersionManagerImpl, la configurazione in /apps/*/config.emea.author/ è applicata.

La granularità di questa regola è a livello PID.
Impossibile definire alcune proprietà per lo stesso PID in /apps/*/config.author/ e altre più specifiche in /apps/*/config.emea.author/ per lo stesso PID.
La configurazione con il maggior numero di modalità di esecuzione corrispondenti è valida per l’intero PID.

Configurazioni standard standard-configurations

L’elenco seguente mostra una piccola selezione delle configurazioni disponibili (in un’installazione standard) nell’archivio:

  • Autore - Filtro WCM AEM:

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

  • Publish - Filtro WCM AEM:

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

  • Statistiche pagina WCM Publish - AEM:

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

NOTE
Poiché queste configurazioni risiedono in /libs, non devono essere modificate direttamente, ma copiate nell'area dell'applicazione ( /apps) prima della personalizzazione.

Per elencare tutti i nodi di configurazione nell'istanza, utilizzare la funzionalità Query in CRXDE Lite per inviare la seguente query SQL:

select * from sling:OsgiConfig

Persistenza della configurazione configuration-persistence

  • Se modifichi una configurazione tramite la console web, questa viene (in genere) scritta nell’archivio in:

    /apps/{somewhere}

    • Per impostazione predefinita {somewhere} è system/config, quindi la configurazione viene scritta in

      /apps/system/config

    • Tuttavia, se stai modificando una configurazione che proviene inizialmente da un’altra posizione nell’archivio, ad esempio:

      /libs/foo/config/someconfig

      La configurazione aggiornata viene quindi scritta nella posizione originale; ad esempio:

      /apps/foo/config/someconfig

  • Le impostazioni modificate da admin vengono salvate in *.config file in:

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

    • Quest'area è costituita dai dati privati dell'amministratore della configurazione OSGi e contiene tutti i dettagli di configurazione specificati da admin, indipendentemente da come sono stati immessi nel sistema.

    • Quest’area è un dettaglio di implementazione e non devi mai modificare direttamente questa directory.

    • Tuttavia, è utile conoscere la posizione di questi file di configurazione in modo che possano essere eseguite copie per il backup, più installazioni o entrambe:

      • Console di gestione Apache Felix OSGi

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

      • Archivio client CRX Sling

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

CAUTION
Non modificare mai le cartelle o i file in:
/crx-quickstart/launchpad/config
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2