DocumentationAEM 6.5Guide de l’utilisateur

Configurer OSGi configuring-osgi

Last update: Tue Apr 30 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Créé pour :

  • Administration

Le framework OSGi est un élément fondamental de la pile technologique d’Adobe Experience Manager (AEM). Il est utilisé pour contrôler les lots composites d’AEM et leur configuration.

OSGi «  fournit les primitives normalisées qui permettent de créer des applications à partir de petits composants réutilisables et collaboratifs. Ces composants peuvent être créés dans une application et déployés  ».

Cela permet de gérer facilement les lots puisqu’ils peuvent être arrêtés, installés et démarrés individuellement. Les interdépendances sont gérées automatiquement. Chaque composant OSGi (consultez Spécification OSGi) est contenu dans l’un des différents lots.

Vous pouvez gérer les paramètres de configuration de ces lots en :

L’une ou l’autre des méthodes peut être utilisée bien qu’il existe des différences subtiles, principalement en relation avec les modes d’exécution :

  • Console Web Adobe CQ

    • La console web est l’interface standard pour la configuration d’OSGi. Elle fournit une interface utilisateur permettant la modification des différentes propriétés, dans laquelle les valeurs possibles peuvent être sélectionnées à partir de listes prédéfinies.

      De ce fait, il s’agit de la méthode la plus simple à utiliser.

    • Toutes les configurations effectuées avec la console Web sont appliquées immédiatement et s’appliquent à l’instance en cours, quel que soit le mode d’exécution en cours ou toute modification ultérieure du mode d’exécution.

  • fichiers de configuration

    • Ils contiennent les paramètres définis dans la console web.
    • Ils peuvent être inclus dans des packages de contenu pour une utilisation sur d’autres instances.

  • content-nodes (sling:osgiConfig) du référentiel

    • Ils nécessitent une configuration manuelle à l’aide de CRXDE Lite.
    • En raison des conventions de nommage des nœuds sling:OsgiConfig, vous pouvez lier la configuration à un mode d’exécution spécifique. Vous pouvez même enregistrer des configurations pour plusieurs modes d’exécution dans le même référentiel.
    • Toutes les configurations appropriées sont appliquées immédiatement (selon le mode d’exécution).

Quelle que soit la méthode utilisée, toutes ces méthodes de configuration :

  • garantissent que la copie ou la réplication du contenu du référentiel recrée des configurations identiques ;
  • vous permettent d’extraire des configurations vers FileVault ou Subversion, soit pour des raisons de sécurité, soit pour d’autres mises à jour ;
  • peuvent être enregistrées dans des packages à utiliser lors de la configuration d’autres instances ;
  • vous permettent d’effectuer des déploiements de configuration à l’aide de scripts pour propager les détails de configuration.
NOTE
Les détails de certains paramètres importants sont répertoriés dans les paramètres de la configuration OSGi.

Configuration d’OSGi à l’aide de la console web osgi-configuration-with-the-web-console

La console web dans AEM fournit une interface normalisée pour la configuration des lots. L’onglet Configuration est utilisé pour configurer les lots OSGi. Il s’agit donc du mécanisme sous-jacent pour configurer les paramètres système d’AEM.

Toutes les modifications apportées sont immédiatement appliquées à la configuration d’OSGi appropriée. Aucun redémarrage n’est nécessaire.

NOTE
Les modifications apportées dans la console Web sont enregistrées dans le référentiel sous la forme de fichiers de configuration. Ces fichiers peuvent être inclus dans des packages de contenu pour réutilisation dans d’autres installations.
NOTE
Dans la console web, toute description qui mentionne les paramètres par défaut est liée aux valeurs par défaut de Sling.
Adobe Experience Manager possède ses propres paramètres par défaut, les paramètres par défaut peuvent donc différer de ceux documentés dans la console.

Pour mettre à jour une configuration avec la console web :

  1. Accédez à l’onglet Configuration de la console web en effectuant l’une des opérations suivantes :

    • Ouvrez la console web à partir du lien du menu Outil > Opérations. Après votre connexion à la console, vous pouvez utiliser le menu déroulant :

      OSGi >

    • L’URL directe ; par exemple :

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

    Une liste s’affiche.

  2. Sélectionnez le lot que vous souhaitez configurer en :

    • cliquant sur l’icône Modifier pour ce lot ;
    • cliquant sur le nom du lot.

  3. Une boîte de dialogue s’affiche. Vous pouvez y apporter des modifications selon vos besoins. Par exemple, définissez le Niveau de journalisation sur INFO :

    chlimage_1-140

    note note
    NOTE
    Les mises à jour sont enregistrées dans le référentiel sous la forme de fichiers de configuration. Pour localiser ces fichiers par la suite (par exemple, pour les inclure dans un package de contenu pour une utilisation dans une autre instance), vous devez prendre note de l’identité persistante (PID).

  4. Cliquez sur Enregistrer.

    Les modifications sont immédiatement appliquées à la configuration OSGi correspondante du système en cours d’exécution. Aucun redémarrage n’est requis.

    note note
    NOTE
    Vous pouvez désormais localiser les fichiers de configuration associés. Par exemple, pour inclure dans un package de contenu pour une utilisation sur une autre instance.

Configuration OSGi avec les fichiers de configuration osgi-configuration-with-configuration-files

Les modifications de configuration effectuées à l’aide de la console Web sont conservées dans le référentiel en tant que fichiers de configuration (.config) sous :

/apps

Ces fichiers peuvent être inclus dans des packages de contenu et réutilisés dans d’autres instances.

NOTE
Le format des fichiers de configuration est très spécifique. Consultez la documentation de Sling Apache pour :
Pour cette raison, il est recommandé de créer et de gérer le fichier de configuration en apportant des modifications réelles dans la console web.

La console web n’indique pas où, dans le référentiel, vos modifications ont été enregistrées, mais elles peuvent être facilement localisées :

  1. Créez le fichier de configuration en effectuant une modification initiale dans la console web.

  2. Ouvrez CRXDE Lite.

  3. Dans le menu Outils, sélectionnez Requête….

  4. Pour rechercher le PID de la configuration que vous avez mise à jour, envoyez une requête de Type SQL.

    Par exemple, la console de gestion Apache Felix OSGi possède l’identité persistante (PID) :

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

    La requête SQL peut donc être :

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

  5. Le nœud du fichier de configuration s’affiche.

    Pour l’exemple ci-dessus :

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

    note caution
    CAUTION
    Vous pouvez ouvrir ce fichier pour afficher vos modifications, mais pour éviter les erreurs de saisie, il est recommandé d’effectuer les modifications avec la console.

  6. Vous pouvez désormais créer un package de contenu, comprenant ce nœud, et l’utiliser selon vos besoins sur vos autres instances.

Configuration d’OSGi dans le référentiel osgi-configuration-in-the-repository

Outre l’utilisation de la console web, vous pouvez également définir des détails de configuration dans le référentiel. Cela vous permet de configurer facilement les différents modes d’exécution.

Vous réalisez ces configurations en créant des nœuds sling:OsgiConfig dans le référentiel à titre de références dans le système. Ces nœuds reflètent les configurations OSGi, et une interface utilisateur leur est associée. Pour mettre à jour les données de configuration, mettez à jour les propriétés du nœud.

Si vous modifiez les données de configuration dans le référentiel, les modifications sont immédiatement appliquées à la configuration d’OSGi correspondante. C’est comme si les modifications avaient été effectuées à l’aide de la console web, avec la validation et les contrôles de cohérence appropriés. Ce workflow s’applique également à l’action de copie d’une configuration à partir de /libs/ vers /apps/.

Comme le même paramètre de configuration peut être situé à plusieurs endroits, le système :

  • recherche tous les nœuds de type sling:OsgiConfig ;
  • filtre selon le nom du service ;
  • filtre selon le mode d’exécution.
NOTE
Lisez également comment définir une configuration basée sur un référentiel pour une instance spécifique uniquement.

Ajouter une nouvelle configuration au référentiel adding-a-new-configuration-to-the-repository

Ce que vous devez savoir : what-you-need-to-know

Pour ajouter une configuration au référentiel, vous devez connaître les informations suivantes :

  1. L’identité persistante (PID) du service.

    Référencez le champ Configurations dans la console Web. Le nom est indiqué entre parenthèses après le nom du lot (ou dans les Informations de configuration vers le bas de la page).

    Par exemple, créez un nœud com.day.cq.wcm.core.impl.VersionManagerImpl. pour configurer le Gestionnaire de versions de gestion de contenu Web d’AEM.

    chlimage_1-141

  2. Un mode d’exécution spécifique est-il obligatoire ? Créez le dossier :

    • config : pour tous les modes d’exécution.
    • config.author : pour l’environnement de création
    • config.publish : pour l’environnement de publication
    • config.<run-mode> - En fonction des besoins

  3. Une Configuration ou une Configuration d’usine est-elle requise ?

  4. Les paramètres à configurer individuellement, y compris les définitions de paramètres existantes qui doivent être recréées.

    Référencez le champ des paramètres individuels dans la console Web. Le nom s’affiche entre parenthèses pour chaque paramètre.

    Par exemple, créez une propriété
    versionmanager.createVersionOnActivation pour configurer Créer une version lors de l’activation.

    chlimage_1-142

  5. Une configuration existe-t-elle déjà dans /libs ? Pour répertorier toutes les configurations de votre instance, utilisez l’outil Requête de CRXDE Lite pour envoyer la requête SQL suivante :

    select * from sling:OsgiConfig

    Si tel est le cas, cette configuration peut être copiée vers /apps/<yourProject>/, puis personnalisé dans le nouvel emplacement.

Créer la configuration dans le référentiel creating-the-configuration-in-the-repository

Pour ajouter réellement la nouvelle configuration au référentiel :

  1. Utilisez CRXDE Lite pour accéder à :

    /apps/<yourProject>

  2. S’il n’existe pas déjà, créez le dossier config (sling:Folder) :

    • config : applicable à tous les modes d’exécution
    • config.<run-mode> : spécifique à un mode d’exécution

  3. Sous ce dossier; créez un nœud :

    • Type : sling:OsgiConfig

    • Nom : l’identité persistante (PID) ;

      par exemple, pour le Gestionnaire de versions de gestion de contenu web d’AEM, utilisez com.day.cq.wcm.core.impl.VersionManagerImpl.

    note note
    NOTE
    Lors de la configuration d’usine, ajoutez -<identifier> au nom.
    Comme dans : org.apache.sling.commons.log.LogManager.factory.config-<identifier>
    Où <identifier> est remplacé par du texte libre que vous devez entrer pour l’instance (vous ne pouvez pas omettre cette information) ; par exemple :
    org.apache.sling.commons.log.LogManager.factory.config-MINE

  4. Pour chaque paramètre à configurer, créez une propriété sur ce nœud :

    • Nom : le nom du paramètre, comme indiqué dans la console web ; le nom est indiqué entre parenthèses à la fin de la description du champ. Par exemple, pour Create Version on Activation, utilisez versionmanager.createVersionOnActivation.
    • Type : selon les cas.
    • Valeur : selon les besoins.

    Vous ne devez créer des propriétés que pour les paramètres que vous souhaitez configurer, les autres paramètres conservant les valeurs par défaut définies par AEM.

  5. Enregistrez toutes les modifications.

    Les modifications sont appliquées lorsque le nœud est mis à jour en redémarrant le service (comme pour les modifications effectuées dans la console web).

CAUTION
Ne modifiez rien dans le chemin d’accès /libs.
CAUTION
Le chemin d’accès complet d’une configuration doit être correct pour être lu au démarrage.

Détails de la configuration configuration-details

Ordre de résolution au démarrage resolution-order-at-startup

L’ordre de priorité suivant est utilisé :

  1. Nœuds de référentiel sous /apps/*/config..., que ce soit avec le type sling:OsgiConfig ou les fichiers de propriété.

  2. Nœuds de référentiel avec le type sling:OsgiConfig sous /libs/*/config.... (définitions prêtes à l’emploi).

  3. Tout fichier .config provenant de <*cq-installation-dir*>/crx-quickstart/launchpad/config/.... sur le système de fichiers local.

Une configuration générique dans /libs peut être masquée par une configuration spécifique au projet dans /apps.

Ordre de résolution à l’exécution resolution-order-at-runtime

Les modifications de configuration effectuées pendant l’exécution du système déclenchent un rechargement avec la configuration modifiée.

L’ordre de priorité suivant s’applique :

  1. La modification d’une configuration dans la console web prend effet immédiatement, car elle est prioritaire au moment de l’exécution.
  2. La modification d’une configuration dans /apps prend effet immédiatement.
  3. La modification d’une configuration dans /libs prend effet immédiatement, à moins qu’elle ne soit masquée par une configuration dans /apps.

Résolution de plusieurs modes d’exécution resolution-of-multiple-run-modes

Pour les configurations spécifiques au mode d’exécution, plusieurs modes d’exécution peuvent être combinés. Vous pouvez par exemple créer des dossiers de configuration dans le style suivant :

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

Les configurations de ces dossiers sont appliquées si tous les modes d’exécution correspondent à un mode d’exécution défini au démarrage.

Par exemple, si une instance a été démarrée avec les modes d’exécution author,dev,emea, les nœuds de configuration dans /apps/*/config.emea, /apps/*/config.author.dev/ et /apps/*/config.author.emea.dev/ sont appliqués, tandis que les nœuds d’application dans /apps/*/config.author.asean/ et /config/author.dev.emea.noldap/ ne sont pas appliqués.

Si plusieurs configurations correspondant au même PID sont applicables, la configuration comportant le nombre le plus élevé de modes d’exécution correspondants est appliquée.

Par exemple, si une instance a été démarrée avec les modes d’exécution author,dev,emea, et que /apps/*/config.author/ et /apps/*/config.emea.author/ définissent une configuration pour com.day.cq.wcm.core.impl.VersionManagerImpl, la configuration dans /apps/*/config.emea.author/ est appliquée.

La granularité de cette règle se trouve au niveau du PID.
Vous ne pouvez pas définir certaines propriétés pour le même PID dans /apps/*/config.author/ et des propriétés plus spécifiques dans /apps/*/config.emea.author/ pour le même PID.
La configuration comportant le nombre le plus élevé de modes d’exécution correspondants est effective pour tout le PID.

Configurations standard standard-configurations

La liste suivante présente une petite sélection des configurations disponibles (dans une installation standard) dans le référentiel :

  • Auteur - Filtre de gestion de contenu Web d’AEM :

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

  • Publication - Filtre de gestion de contenu Web d’AEM :

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

  • Publication - Statistiques de page de gestion de contenu Web d’AEM :

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

NOTE
Comme ces configurations se trouvent dans /libs, elles ne doivent pas être modifiées directement, mais copiées dans votre zone d’application (/apps) avant d’être personnalisées.

Pour répertorier tous les nœuds de configuration de votre instance, utilisez la fonctionnalité Requête de CRXDE Lite pour envoyer la requête SQL suivante :

select * from sling:OsgiConfig

Persistance de la configuration configuration-persistence

  • Si vous modifiez une configuration par l’intermédiaire de la console Web, elle est (généralement) enregistrée dans le référentiel :

    /apps/{somewhere}

    • Par défaut, {somewhere} est system/config, la configuration est donc enregistrée sur

      /apps/system/config

    • Cependant, si vous modifiez une configuration qui provient initialement d’un autre emplacement du référentiel : par exemple :

      /libs/foo/config/someconfig

      La configuration mise à jour est ensuite enregistrée à l’emplacement d’origine ; par exemple :

      /apps/foo/config/someconfig

  • Les paramètres modifiés par admin sont enregistrés dans les fichiers *.config sous :

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

    • Cette zone correspond aux données privée de l’administration de la configuration OSGi et contient tous les détails de la configuration spécifiés par admin, quel que soit leur mode d’entrée dans le système.

    • Cette zone est un détail d’implémentation et vous ne devez jamais modifier directement ce répertoire.

    • Toutefois, il est utile de connaître l’emplacement de ces fichiers de configuration afin que des copies puissent être utilisées pour une sauvegarde, plusieurs installations, ou les deux :

      • Console de gestion OSGi Apache Felix

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

      • Référentiel client CRX Sling

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

CAUTION
Vous ne devez jamais modifier les dossiers ou fichiers sous :
/crx-quickstart/launchpad/config
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2