Vous consultez actuellement l'aide de la version:

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 construire 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 une gestion conviviale des lots car ils peuvent être arrêtés, installés, démarrés individuellement. Les interdépendances sont gérées automatiquement. Chaque composant OSGi (voir la 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 :

Remarque :

L’utilisation de la console web Adobe CQ est la méthode recommandée pour apporter des modifications.

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 OSGi. Elle fournit une interface utilisateur, permettant de modifier les différentes propriétés, dans laquelle vous pouvez sélectionner des valeurs à 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
    • Contiennent les paramètres définis dans la console web.
    • Peuvent être inclus dans des modules de contenu pour une utilisation dans d’autres instances.
  • content-nodes (sling:osgiConfig) du référentiel
    • Nécessite une configuration manuelle à l’aide de CRXDE Lite.
    • En raison des conventions de dénomination 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 (en fonction du 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 ;
  • permettent d’extraire des configurations de FileVault ou Subversion à des fins de sécurité ou d’autres mises à jour ;
  • peuvent être enregistrées dans des modules à utiliser lors de la configuration d’autres instances ;
  • permettent d’effectuer des déploiements de configuration à l’aide de scripts afin de propager les détails de la configuration.

Remarque :

Les détails de certains paramètres importants sont répertoriés dans les paramètres de la configuration OSGi.

Configuration OSGi avec la console web

La console web d’AEM fournit une interface normalisée pour la configuration des lots. L’onglet Configuration est utilisé pour la configuration des lots OSGi et constitue, par conséquent, le mécanisme sous-jacent de la configuration des paramètres système d’AEM.

Toute modification apportée est immédiatement appliquée à la configuration OSGi concernée. Aucun redémarrage n’est requis.

Remarque :

Les modifications apportées dans la console web sont enregistrées dans le référentiel sous la forme de fichiers de configuration. Ceux-ci peuvent être inclus dans les modules de contenu pour être réutilisés dans d’autres installations.

Remarque :

Sur la console web, toutes les descriptions qui mentionnent les paramètres par défaut sont relatives aux paramètres Sling par défaut.

Adobe Experience Manager possède ses propres paramètres par défaut et le jeu de paramètres par défaut peut 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 :

    • Ouvrant la console web à partir du lien du menu Outil -> Opérations. Après vous être connecté à la console, vous pouvez utiliser le menu déroulant :
          OSGi >
    • Utilisant 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 correspondant à ce lot ;
    • cliquant sur le Nom du lot.
  3. Une boîte de dialogue s’ouvre. Dans cette dernière, vous pouvez apporter les modifications appropriées, par exemple, définir le Niveau de journal sur INFO :

    chlimage_1

    Remarque :

    Les mises à jour sont enregistrées dans le référentiel sous la forme de fichiers de configuration. Pour les localiser par la suite (par exemple, pour les inclure dans un module 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.

    Remarque :

    Vous pouvez maintenant localiser le(s) fichier(s) de configuration associé(s), à inclure, par exemple, dans un module de contenu pour une utilisation dans une autre instance.

Configuration OSGi avec les fichiers de configuration

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 modules de contenu et réutilisés dans d’autres instances.

Remarque :

Le format des fichiers de configuration est très spécifique. Pour plus d’informations, voir la documentation de Sling Apache

Pour cette raison, il est recommandé de créer et de mettre à jour le fichier de configuration en effectuant des modifications réelles dans la console web.

La console web n’indique pas à quel emplacement les modifications ont été enregistrées dans le référentiel, 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. Envoyez une requête de Type SQL afin de rechercher le PID de la configuration que vous avez mise à jour.

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

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

    Ainsi, la requête SQL pourrait être :

    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

    Attention :

    Vous pouvez ouvrir ce fichier pour afficher les modifications, mais, pour éviter les erreurs de frappe, il est recommandé d’apporter les modifications dans la console.

  6. Vous pouvez maintenant créer un module de contenu comportant ce nœud et l’utiliser comme requis dans vos autres instances.

Configuration OSGi dans le référentiel

Outre l’utilisation de la console web, vous pouvez également définir des détails de la configuration dans le référentiel. Vous pouvez ainsi 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 forment une interface utilisateur permettant d’y accéder. 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 OSGi appropriée, comme si les modifications avaient été effectuées à l’aide de la console web, avec les vérifications de validation et de cohérence adéquates. Cela 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.

Ajout d’une nouvelle configuration au référentiel

Ce que vous devez savoir

Pour ajouter une nouvelle configuration au référentiel, vous devez connaître ou savoir ce qui suit :

  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 la gestion de contenu web AEM

    chlimage_1
  2. Si un mode d’exécution spécifique est requis. 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> : selon les besoins
  3. Si une Configuration ou une Configuration d’usine est requise.

  4. Les paramètres individuels à configurer y compris les définitions de paramètres existantes qui devront ê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
  5. Une configuration existe-t-elle déjà dans /libs ? Pour répertorier toutes les configurations dans votre instance, utilisez l’outil Requête de CRXDE Lite pour envoyer la requête SQL suivante :
       select * from sling:OsgiConfig
    Dans ce cas, cette configuration peut être copiée dans /apps/<votreProjet>/, puis personnalisée dans le nouvel emplacement.

Création de la configuration dans le référentiel

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

  1. Utilisez CRXDE Lite pour accéder à :

     /apps/<votreProjet>

  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 : identité persistante (PID) ;
      par exemple pour le gestionnaire de versions (Version Manager) de la gestion de contenu web AEM, utilisez com.day.cq.wcm.core.impl.VersionManagerImpl

    Remarque :

    Lors de la configuration d’usine, ajoutez -<identifiant> au nom.

    Comme suit : org.apache.sling.commons.log.LogManager.factory.config-<identifiant>

    <identifiant> est remplacé par du texte libre que vous devez entrer pour identifier 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 que vous souhaitez configurer, créez une propriété sur ce nœud :

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

    Il vous suffit de créer des propriétés pour les paramètres que vous voulez configurer. Les autres prendront toujours les valeurs par défaut définies par AEM.

  5. Enregistrez toutes les modifications.

    Les modifications sont appliquées dès que le nœud est mis à jour en redémarrant le service (comme avec les modifications apportées dans la console web).

Attention :

Vous ne devez rien modifier dans le chemin /libs.

Attention :

Le chemin complet d’une configuration doit être correct pour être lu au démarrage.

Détails de la configuration

Séquence de résolution au démarrage

L’ordre de priorité suivant est utilisé :

  1. Nœuds de référentiel sous /apps/*/config....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.

Cela signifie qu’une configuration générique dans /libs peut être masquée par la configuration spécifique à un projet dans /apps.

Séquence de résolution lors de l’exécution

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

Puis, l’ordre de priorité suivant s’applique :

  1. La modification d’une configuration dans la console web prend effet immédiatement car elle a priorité lors 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

Pour les configurations spécifiques au mode d’exécution, plusieurs modes d’exécution peuvent être combinés. Par exemple, vous pouvez 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 de /apps/*/config.emea, /apps/*/config.author.dev/ et /apps/*/config.author.emea.dev/ sont appliqués, alors que les nœuds de configuration de /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 de /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

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

Remarque :

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

  • Si vous modifiez une configuration par l’intermédiaire la console web, elle est (généralement) enregistrée dans le référentiel selon le chemin :
    /apps/{quelque part}
    • Par défaut, {quelque part} est system/config. La configuration est donc enregistrée dans
      /apps/system/config
    • Toutefois, si vous modifiez une configuration qui provient initialement d’un autre emplacement dans le référentiel, par exemple :
      /libs/foo/config/someconfig
      Alors, la configuration mise à jour est écrite sous 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 :
    /crx-quickstart/launchpad/config
    • Il s’agit de la zone de données privée de l’administrateur de la configuration OSGi qui 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.
    • Il s’agit d’un détail d’implémentation et vous ne devez jamais modifier ce répertoire directement.
    • Cependant, il est utile de connaître l’emplacement de ces fichiers de configuration afin que vous puissiez en effectuer des copies à des fins de sauvegarde et/ou d’installation multiple :
      • Console de gestion Apache Felix OSGi
        ../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

Attention :

Vous ne devez jamais modifier les dossiers ou fichiers sous :

    /crx-quickstart/launchpad/config

Ce produit est distribué sous licence Creative Commons Attribution - Pas d’utilisation commerciale - Partage à l’identique 3.0 non transposé  Les publications Twitter™ et Facebook ne sont pas couvertes par les dispositions Creative Commons.

Mentions légales   |   Politique de confidentialité en ligne