Configurazione di OSGi

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

OSGi "fornisce le primitive standardizzate che consentono di costruire applicazioni da componenti piccoli, riutilizzabili e collaborativi. Questi componenti possono essere composti in un'applicazione e distribuiti".

Questo consente una facile gestione dei bundle in quanto possono essere arrestati, installati, avviati individualmente. 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:

• utilizzando la console Web Adobe CQ
• utilizzo di file di configurazione
• configurazione di nodi-contenuto ( sling:OsgiConfig) nell'archivio

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

• Console web Adobe CQ

  • La Web Console è l’interfaccia standard per la configurazione OSGi. Offre un’interfaccia utente per la modifica delle varie proprietà, dove è possibile selezionare valori da elenchi predefiniti.

    Pertanto è il metodo più semplice da utilizzare.

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

• file di configurazione

  • Contiene le impostazioni definite nella console Web.
  • Può essere incluso nei pacchetti di contenuti da utilizzare su altre istanze.

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

  • È necessaria una configurazione manuale tramite CRXDE Lite.
  • A causa delle convenzioni di denominazione dei nodi sling:OsgiConfig, puoi collegare la configurazione a una specifica modalità di esecuzione. 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).

A prescindere dal metodo utilizzato, tutti i seguenti metodi di configurazione:

• Assicurati che la copia o la replica del contenuto del repository ricrea configurazioni identiche.
• Consentire il check-out delle configurazioni su FileVault o Subversion; per la sicurezza o per ulteriori aggiornamenti.
• Può essere salvato in pacchetti da utilizzare durante la configurazione di altre istanze.
• Consente di eseguire rollout di configurazione utilizzando gli script per proporre i dettagli di configurazione.

Configurazione OSGi con la console Web

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

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

Per aggiornare una configurazione con la console Web:

1. Accedi alla scheda Configurazione della console Web tramite:

   • Aprite la console Web dal collegamento nel menu Strumento -> Operazioni. Dopo aver effettuato l’accesso alla console è possibile utilizzare il menu a discesa di:

     OSGi >

   • URL diretto; ad esempio:

     http://localhost:4502/system/console/configMgr
     Verrà visualizzato un elenco.

2. Seleziona il bundle da configurare tramite:

   • facendo clic sull'icona Modifica per quel bundle
   • cliccando sul Nome del bundle

3. Viene aperta una finestra di dialogo. Consente di modificare le impostazioni desiderate. ad esempio, impostare Log Level su INFO:

   

   NOTA

   Gli aggiornamenti vengono salvati nell'archivio come file di configurazione. Per individuarli successivamente (ad esempio per includere in un pacchetto di contenuti da utilizzare su un’altra istanza) è necessario annotare l’identità persistente ( PID).

4. Fai clic su Salva.

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

   NOTA

   È ora possibile individuare i file di configurazione correlati; ad esempio, da includere in un pacchetto di contenuti da utilizzare su un’altra istanza.

Configurazione OSGi con file di configurazione

Le modifiche di configurazione effettuate tramite la Console web vengono mantenute nell’archivio come file di configurazione ( .config) in:

/apps

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

La console Web non mostra alcuna indicazione di dove nell’archivio sono state salvate le modifiche, ma queste possono essere facilmente posizionate:

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

2. Apri CRXDE Lite.

3. Nel menu Strumenti seleziona Query … .

4. Invia una query di Tipo SQL per cercare il PID della configurazione che hai aggiornato.

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

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

   La query SQL potrebbe quindi essere:

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

5. Verrà visualizzato il nodo del file di configurazione.

   Per l'esempio precedente:

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

   ATTENZIONE

   Puoi aprire questo file per visualizzare le modifiche, ma per evitare errori di digitazione è consigliabile apportare modifiche effettive con la console.

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

Configurazione OSGi nell'archivio

Oltre a utilizzare la console web, puoi anche definire i dettagli di configurazione nell’archivio. Questo consente di configurare facilmente le diverse modalità di esecuzione.

Queste configurazioni vengono effettuate creando nodi sling:OsgiConfig nell'archivio a cui fare riferimento per il sistema. Questi nodi riflettono le configurazioni OSGi e formano un’interfaccia utente per tali configurazioni. Per aggiornare i dati di configurazione si aggiornano 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 vale anche per l’azione di copia di una configurazione da /libs/ a /apps/.

Poiché lo stesso parametro di configurazione può essere individuato in diverse posizioni, il sistema:

• cerca tutti i nodi di tipo sling:OsgiConfig
• filtra in base al nome del servizio
• filtra in base alla modalità di esecuzione

Aggiunta di una nuova configurazione al repository

Cosa devi sapere

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

1. L’ 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 verso il fondo della pagina).

   Ad esempio, crea un nodo com.day.cq.wcm.core.impl.VersionManagerImpl. per configurare AEM WCM Version Manager.

   

2. Se è richiesta una specifica modalità di esecuzione. 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> - se del caso

3. Se è necessario un Configurazione o Configurazione di fabbrica.

4. i singoli parametri da configurare; incluse le definizioni di parametri esistenti che dovranno essere ricreati.

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

   Ad esempio, creare una proprietà
   versionmanager.createVersionOnActivation per configurare Crea versione su Activation.

   

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

   select * from sling:OsgiConfig

   In tal caso, questa configurazione può essere copiata in /apps/<yourProject>/, quindi personalizzata nella nuova posizione.

Creazione della configurazione nell'archivio

Per aggiungere effettivamente la nuova configurazione all’archivio:

1. Utilizza CRXDE Lite per passare a:

   /apps/<yourProject>

2. Se non esiste già, crea la cartella config ( sling:Folder):

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

3. Sotto questa cartella crea un nodo:

   • Tipo: sling:OsgiConfig

   • Nome: l'identità persistente (PID);

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

   NOTA

   Quando si crea una configurazione di fabbrica, aggiungere -<identifier> al nome.

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

   Dove <identifier> viene sostituito da testo libero che è necessario immettere per identificare l'istanza (non è possibile omettere tali 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 utilizza versionmanager.createVersionOnActivation
   • Tipo: se del caso.
   • Valore: se necessario.

   È sufficiente creare le proprietà per i parametri che si desidera configurare. Gli altri avranno comunque i valori predefiniti impostati da AEM.

5. Salva tutte le modifiche.

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

Dettagli di configurazione

Ordine di risoluzione all'avvio

Viene utilizzato il seguente ordine di precedenza:

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

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

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

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

Ordine di risoluzione in 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 avrà effetto immediato in quanto ha la precedenza in fase di esecuzione.
2. La modifica di una configurazione in /apps avrà effetto immediato.
3. La modifica di una configurazione in /libs avrà effetto immediato, a meno che non sia mascherata da una configurazione in /apps.

Risoluzione di più modalità di esecuzione

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

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

Le configurazioni in tali cartelle verranno 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, verranno 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 verranno applicati.

Se sono applicabili più configurazioni per lo stesso PID, viene applicata la configurazione con il numero più alto 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/ verrà applicata.

La granularità di questa regola è a livello di PID.
Non è possibile definire alcune proprietà per lo stesso PID in /apps/*/config.author/ e altre specifiche in /apps/*/config.emea.author/ per lo stesso PID.
La configurazione con il maggior numero di modalità di esecuzione corrispondenti sarà efficace per l'intero PID.

Configurazioni standard

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

• Autore - AEM filtro WCM:

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

• Pubblica - AEM filtro WCM:

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

• Pubblica - AEM statistiche pagina WCM:

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

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

select * from sling:OsgiConfig

Persistenza di configurazione

• Se modifichi una configurazione tramite la console Web, in genere viene scritta nell’archivio all’indirizzo:

  /apps/{somewhere}

  • Per impostazione predefinita {somewhere} è system/config in modo che la configurazione venga scritta in

    /apps/system/config

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

    /libs/foo/config/someconfig

    Quindi la configurazione aggiornata viene scritta nella posizione originale; ad esempio:

    /apps/foo/config/someconfig

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

     /crx-quickstart/launchpad/config
  

  • Si tratta dell’area dati privata dell’amministratore di configurazione OSGi e contiene tutti i dettagli di configurazione specificati da admin, indipendentemente da come sono entrati nel sistema.

  • Si tratta di un dettaglio dell’implementazione e non devi mai modificare direttamente questa directory.

  • Tuttavia, è utile conoscere la posizione di questi file di configurazione in modo che le copie possano essere prese per il backup e/o installazione multipla:

    • 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