Le plug-in Maven Content Package d’Adobe permet d’intégrer les tâches de déploiement et de gestion de modules dans vos projets Maven.
Le déploiement des modules construits sur AEM est effectué par le plug-in Maven Content Package d’Adobe et permet l’automatisation des tâches normalement exécutées à l’aide du Gestionnaire de modules d’AEM :
Ce document décrit comment utiliser Maven pour gérer ces tâches. Cependant, il est également important de comprendre comment les projets AEM et leurs modules sont structurés.
La création de packages incombe désormais au plug-in Maven Apache Jackrabbit FileVault.
content-package-maven-plugin
ne prend plus en charge les packages à partir de la version 1.0.2.AEM as a Cloud Service adhère aux bonnes pratiques les plus récentes en matière de gestion de modules et de structure de projet, telles qu’elles sont implémentées par le dernier archétype de projet AEM.
Pour plus d’informations, consultez l’article Structure de projet AEM dans les documentations AEM as a Cloud Service et Archétype de projet AEM. Les deux implémentations sont entièrement prises en charge pour AEM 6.5.
Le plug-in est disponible à partir du référentiel Maven central.
Pour utiliser le module externe Content Package Maven, ajoutez l’élément plugin suivant dans l’élément build du fichier POM :
<plugin>
<groupId>com.day.jcr.vault</groupId>
<artifactId>content-package-maven-plugin</artifactId>
<version>1.0.4</version>
<configuration>
<!-- parameters and values common to all goals, as required -->
</configuration>
</plugin>
Pour que Maven puisse télécharger le module externe, utilisez le profil fourni dans la section Obtention du module externe Content Package Maven de cette page.
Les objectifs et les paramètres d’objectif fournis par le plug-in Content Package sont décrits dans les sections qui suivent. Les paramètres qui sont décrits dans la section Paramètres communs peuvent être utilisés pour la plupart des objectifs. Les paramètres qui s’appliquent à un objectif sont décrits dans la section consacrée à l’objectif en question.
Le préfixe du plug-in est content-package
. Utilisez ce préfixe pour exécuter un objectif à partir de la ligne de commande, comme illustré ci-après.
mvn content-package:build
Sauf indication contraire, les objectifs et les paramètres du plug-in utilisent le préfixe vault
, comme illustré ci-après.
mvn content-package:install -Dvault.targetURL="https://192.168.1.100:4502/crx/packmgr/service.jsp"
Les objectifs qui utilisent des proxys pour AEM ont recours à la première configuration de proxy valide dans les paramètres Maven. Si aucune configuration de proxy n’est trouvée, aucun proxy n’est utilisé. Reportez-vous au paramètre useProxy
dans la section Paramètres communs.
Les paramètres contenus dans le tableau ci-après sont communs à tous les objectifs, sauf si une note indique le contraire dans la colonne Objectifs.
Nom | Type | Requis | Valeur par défaut | Description | Objectifs |
---|---|---|---|---|---|
failOnError |
boolean |
Non | false |
La valeur true entraîne l’échec de la compilation lorsqu’une erreur se produit. La valeur false entraîne la création à ignorer l’erreur. |
Tous les objectifs, à l’exception de package |
name |
String |
build : Oui, install : Non, rm : Oui |
build : Pas de valeur par défaut, install : Valeur de la propriété artifactId du projet Maven |
Nom du module sur lequel exécuter une action | Tous les objectifs, à l’exception de ls |
password |
String |
Oui | admin |
Mot de passe utilisé pour l’authentification avec AEM | Tous les objectifs, à l’exception de package |
serverId |
String |
Non | ID du serveur à partir duquel récupérer le nom d’utilisateur et le mot de passe pour l’authentification | Tous les objectifs, à l’exception de package |
|
targetURL |
String |
Oui | http://localhost:4502/crx/packmgr/service.jsp |
URL de l’API du service HTTP du gestionnaire de modules AEM | Tous les objectifs, à l’exception de package |
timeout |
int |
Non | 5 |
Délai de connexion, exprimé en secondes, pour communiquer avec le service du gestionnaire de modules | Tous les objectifs, à l’exception de package |
useProxy |
boolean |
Non | true |
La valeur true entraîne l’utilisation par Maven de la première configuration de proxy active trouvée en réponse aux requêtes de proxy au gestionnaire de modules. |
Tous les objectifs, à l’exception de package |
userId |
String |
Oui | admin |
Nom d’utilisateur à authentifier avec AEM | Tous les objectifs, à l’exception de package |
verbose |
boolean |
Non | false |
Active ou désactive la journalisation documentée | Tous les objectifs, à l’exception de package |
Crée un module de contenu déjà défini sur une instance AEM.
Il n’est pas nécessaire que l’objectif soit exécuté dans un projet Maven.
Tous les paramètres de l’objectif de build sont décrits dans la section Paramètres communs.
Installe un module dans le référentiel. L’exécution de cet objectif ne nécessite pas de projet Maven. L’objectif est lié à la phase install
du cycle de vie de compilation Maven.
En plus des paramètres suivants, consultez les descriptions de la section Paramètres communs.
Nom | Type | Requis | Valeur par défaut | Description |
---|---|---|---|---|
artifact |
String |
Non | Valeur de la propriété artifactId du projet Maven |
Chaîne au format groupId:artifactId:version[:packaging] |
artifactId |
String |
Non | Aucune | ID de l’artefact à installer. |
groupId |
String |
Non | Aucune | groupId de l’artefact à installer |
install |
boolean |
Non | true |
Détermine si le module doit être décompressé automatiquement lorsqu’il est chargé |
localRepository |
org.apache.maven.artifact.repository.ArtifactRepository |
Non | Valeur de la variable système localRepository |
Référentiel Maven local qui ne peut pas appliquer la configuration du plug-in car la propriété système est toujours utilisée |
packageFile |
java.io.File |
Non | artefact principal défini pour le projet Maven | Nom du fichier de module à installer |
packaging |
String |
Non | zip |
Type de groupement de l’artefact à installer. |
pomRemoteRepositories |
java.util.List |
Oui | Valeur de la propriété remoteArtifactRepositories définie pour le projet Maven |
Cette valeur ne peut pas appliquer la configuration du plug-in et doit être spécifiée dans le projet. |
project |
org.apache.maven.project.MavenProject |
Oui | Projet pour lequel le plug-in est configuré | Le projet Maven implicite, car il contient la configuration du plug-in |
repositoryId (POM), repoID (ligne de commande) |
String |
Non | temp |
ID du référentiel duquel est récupéré l’artefact |
repositoryUrl (POM), repoURL (ligne de commande) |
String |
Non | Aucune | URL du référentiel duquel est récupéré l’artefact |
version | Chaîne | Non | Aucune | Version de l’artefact à installer |
Répertorie les modules déployés dans le Gestionnaire de modules.
Tous les paramètres de l’objectif sont décrits dans la section Paramètres communs.
Supprime un module du Gestionnaire de modules.
Tous les paramètres de l’objectif rm sont décrits dans la section Paramètres communs.
Désinstalle un module. Le module reste sur le serveur avec l’état désinstallé.
Tous les paramètres de l’objectif uninstall sont décrits dans la section Paramètres communs.
Crée un module de contenu. La configuration par défaut de l’objectif du module comprend le contenu du répertoire dans lequel les fichiers compilés sont enregistrés. L’exécution de l’objectif du module requiert que la phase de création de la compilation soit terminée. L’objectif est lié à la phase de module du cycle de vie de compilation Maven.
Outre les paramètres suivants, consultez la description du paramètre name
dans la section Paramètres communs.
Nom | Type | Requis | Valeur par défaut | Description |
---|---|---|---|---|
archive |
org.apache.maven.archiver.MavenArchiveConfiguration |
Non | Aucune | Configuration d’archive à utiliser |
builtContentDirectory |
java.io.File |
Oui | Valeur du répertoire de sortie de la compilation Maven | Répertoire qui comporte le contenu à inclure dans le module |
dependencies |
java.util.List |
Non | Aucune | |
embeddedTarget |
java.lang.String |
Non | Aucune | |
embeddeds |
java.util.List |
Non | Aucune | |
failOnMissingEmbed |
boolean |
Oui | false |
La valeur true entraîne l’échec de la compilation lorsqu’un artefact incorporé n’est pas trouvé dans les dépendances du projet. La valeur false entraîne l’absence de prise en compte de l’erreur par la création. |
filterSource |
java.io.File |
Non | Aucune | Ce paramètre définit un fichier qui spécifie la source du filtre de l’espace de travail. Les filtres spécifiés dans le fichier de configuration et injectés via les incorporations ou les sous-modules sont fusionnés avec le contenu du fichier. |
filters |
com.day.jcr.vault.maven.pack.impl.DefaultWorkspaceFilter |
Non | Aucune | Ce paramètre contient les éléments de filtre qui définissent le contenu du module. Lorsqu’ils sont exécutés, les filtres sont inclus dans le fichier filter.xml . Voir la section Utilisation des filtres ci-dessous. |
finalName |
java.lang.String |
Oui | Paramètre finalName défini dans le projet Maven (phase de compilation) |
Nom du fichier zip du module généré sans extension .zip |
group |
java.lang.String |
Oui | groupID défini dans le projet Maven. |
groupId du module de contenu généré, qui fait partie du chemin d’installation cible pour le module de contenu |
outputDirectory |
java.io.File |
Oui | Répertoire build défini dans le projet Maven | Répertoire local dans lequel est enregistré le module de contenu |
prefix |
java.lang.String |
Non | Aucune | |
project |
org.apache.maven.project.MavenProject |
Oui | Aucune | Projet Maven |
properties |
java.util.Map |
Non | Aucune | Ces paramètres définissent des propriétés supplémentaires que vous pouvez définir dans le fichier properties.xml . Ces propriétés ne peuvent pas remplacer les propriétés prédéfinies suivantes : group (utiliser le paramètre group à définir), name (utiliser le paramètre name à définir), version (utiliser le paramètre version à définir), description (fixé à partir de la description du projet), groupId (groupId du descripteur de projet Maven), artifactId (artifactId du descripteur de projet Maven), dependencies (utiliser le paramètre dependencies à définir), createdBy (valeur de la propriété système user.name ), created (temps système actuel), requiresRoot (utiliser le paramètre requiresRoot à définir), packagePath (généré automatiquement à partir du groupe et du nom du module) |
requiresRoot |
boolean |
Oui | false | Définit si le module requiert ou non root. Ce paramètre deviendra la propriété requiresRoot du fichier properties.xml . |
subPackages |
java.util.List |
Non | Aucune | |
version |
java.lang.String |
Oui | Version définie dans le projet Maven. | Version du module de contenu |
workDirectory |
java.io.File |
Oui | Répertoire défini dans le projet Maven (phase de compilation) | Répertoire qui comporte le contenu à inclure dans le module |
Utilisez l’élément filters pour définir le contenu du module. Les filtres sont ajoutés à l’élément workspaceFilter
du fichier META-INF/vault/filter.xml
du module.
L’exemple de filtre suivant montre la structure XML à utiliser :
<filter>
<root>/apps/myapp</root>
<mode>merge</mode>
<includes>
<include>/apps/myapp/install/</include>
<include>/apps/myapp/components</include>
</includes>
<excludes>
<exclude>/apps/myapp/config/*</exclude>
</excludes>
</filter>
L’élément mode
définit l’impact de l’importation du module sur le contenu du référentiel. Les valeurs suivantes peuvent être utilisées :
Lorsque le filtre ne contient pas d’élément mode
, la valeur replace
par défaut est utilisée.
Nom | Type | Requis | Valeur par défaut | Description |
---|---|---|---|---|
detail |
boolean |
Non | false |
Détermine si toutes les propriétés définissables doivent être affichées ou non pour chaque objectif |
goal |
String |
Non | Aucune | Ce paramètre définit le nom de l’objectif pour lequel afficher l’aide. Si aucune valeur n’est spécifiée, l’aide est affichée pour tous les objectifs. |
indentSize |
int |
Non | 2 |
Nombre d’espaces à utiliser pour le retrait de chaque niveau (doit être positif s’il est défini) |
lineLength |
int |
Non | 80 |
Longueur maximale d’une ligne d’affichage (doit être positive si elle est définie) |
Remplacez les fichiers de configuration du module par défaut afin de personnaliser les propriétés du module. Incluez, par exemple, une image miniature pour différencier le module dans le Gestionnaire de modules.
Les fichiers sources peuvent se trouver n’importe où dans le système de fichiers. Dans le fichier POM, définissez les ressources de création pour copier les fichiers sources dans target/vault-work/META-INF
à des fins d’inclusion dans le module.
Le code POM suivant ajoute au module les fichiers du dossier META-INF
de la source du projet :
<build>
<resources>
<!-- vault META-INF resources (thumbnail etc.) -->
<resource>
<directory>${basedir}/src/main/content/META-INF</directory>
<targetPath>../vault-work/META-INF</targetPath>
</resource>
</resources>
</build>
Le code POM ci-après ajoute uniquement une image miniature au module. L’image miniature doit être appelée thumbnail.png
et figurer dans le dossier META-INF/vault/definition
du module. Dans cet exemple, le fichier source se trouve dans le dossier /src/main/content/META-INF/vault/definition
du projet :
<build>
<resources>
<!-- thumbnail only -->
<resource>
<directory>${basedir}/src/main/content/META-INF/vault/definition</directory>
<targetPath>../vault-work/META-INF/vault/definition</targetPath>
</resource>
</resources>
</build>
Le dernier archétype de projet AEM met en œuvre la structure d’ensemble des bonnes pratiques pour les implémentations On-Premise et AMS et est recommandé pour tous les projets AEM.
Pour plus d’informations, consultez l’article Structure de projet AEM dans les documentations AEM as a Cloud Service et Archétype de projet AEM. Les deux implémentations sont entièrement prises en charge pour AEM 6.5.