Utilisation de cURL avec AEM

Les administrateurs ont souvent besoin d’automatiser ou de simplifier des tâches courantes sur un système. Dans AEM, par exemple, la gestion des utilisateurs, l’installation des modules et la gestion des lots OSGi sont des tâches fréquemment effectuées.

En raison de la nature RESTful de la structure Sling sur laquelle l’AEM est créée, la plupart des tâches peuvent être effectuées avec un appel d’URL. cURL peut être utilisé pour exécuter ce type d’appel d’adresse URL et peut s’avérer un outil utile pour les administrateurs AEM.

Qu’est-ce que cURL ?

cURL est un outil de ligne de commande Open Source utilisé pour manipuler des adresses URL. Il prend en charge un large éventail de protocoles Internet, notamment HTTP, HTTPS, FTP, FTPS, SCP, TFTP, LDAP, DAP, DICT, TELNET, FILE, IMAP, POP3, SMTP et RTSP.

Initialement publié en 1997, cURL est un outil bien établi et largement répandu pour obtenir ou envoyer des données en utilisant la syntaxe de l’adresse URL. Le nom « cURL » signifie à l’origine « see URL » (afficher l’adresse URL).

Compte tenu de la nature RESTful de la structure Sling sur laquelle repose AEM, la plupart des tâches peuvent se réduire à l’appel d’une adresse URL, ce que cURL peut exécuter. Les tâches de manipulation de contenu, comme l’activation des pages et le démarrage de workflows, ainsi que les tâches opérationnelles, comme la gestion de modules et d’utilisateurs, peuvent être automatisées à l’aide de cURL. De plus, vous pouvez créer vos propres commandes cURL pour la plupart des tâches dans AEM.

Téléchargement de cURL

cURL est une partie standard de Mac OS et de certaines distributions Linux. Cependant, il est disponible pour la plupart des systèmes d’exploitation. Les derniers téléchargements sont disponibles à l’adresse https://curl.haxx.se/download.html.

Le référentiel source de cURL est également disponible sur GitHub.

Création d’une commande AEM compatible avec cURL

Il est possible de créer des commandes cURL pour la plupart des opérations dans AEM, comme le déclenchement de workflows, le contrôle de configuration OSGi, le déclenchement de commandes JMX, la création d’agents de réplication, et bien plus encore.

Pour déterminer la commande exacte dont vous avez besoin pour une opération particulière, utilisez les outils de développement de votre navigateur pour enregistrer l’appel POST envoyé au serveur lorsque vous exécutez la commande AEM.

La procédure ci-dessous décrit, à titre d’exemple, comment effectuer cette opération en créant une page dans le navigateur Chrome.

1. Préparez l’action à appeler dans AEM. Dans ce cas, nous avons atteint la fin de l'Assistant Créer une page, mais n'avons pas encore cliqué sur Créer.

   

2. Démarrez les outils de développement et sélectionnez l’onglet Network. Cliquez sur l’option Preserve log avant d’effacer la console.

   

3. Cliquez sur Create dans l’assistant de création de page afin de créer réellement le workflow.

4. Cliquez avec le bouton droit de la souris sur l’action POST qui en résulte et sélectionnez Copy > Copy as cURL.

   

5. Copiez la commande cURL dans un éditeur de texte et supprimez tous les en-têtes de la commande, avec -H (en bleu dans l’image ci-dessous) et ajoutez le paramètre d’authentification approprié tel que -u <user>:<password>.

   

6. Exécutez la commande cURL à l’aide de la ligne de commande et affichez la réponse.

   

Commandes cURL d’AEM pour les tâches opérationnelles courantes

Voici une liste de commandes cURL d’AEM pour les tâches administratives et opérationnelles courantes.

Gestion de modules

Liste de tous les packages installés

curl -u <user>:<password> http://<host>:<port>/crx/packmgr/service.jsp?cmd=ls

Création d’un module

curl -u <user>:<password> -X POST http://localhost:4502/crx/packmgr/service/.json/etc/packages/mycontent.zip?cmd=create -d packageName=<name> -d groupName=<name>

Aperçu d’un module

curl -u <user>:<password> -X POST http://localhost:4502/crx/packmgr/service/.json/etc/packages/mycontent.zip?cmd=preview

Liste du contenu d’un module

curl -u <user>:<password> -X POST http://localhost:4502/crx/packmgr/service/console.html/etc/packages/mycontent.zip?cmd=contents

Compilation d’un module

curl -X POST http://localhost:4502/crx/packmgr/service/.json/etc/packages/mycontent.zip?cmd=build

Réencapsulation d’un module

curl -u <user>:<password> -X POST http://localhost:4502/crx/packmgr/service/.json/etc/packages/mycontent.zip?cmd=rewrap

Changement de nom d’un module

curl -u <user>:<password> -X POST -Fname=<New Name> http://localhost:4502/etc/packages/<Group Name>/<Package Name>.zip/jcr:content/vlt:definition

Chargement d’un module

curl -u <user>:<password> -F cmd=upload -F force=true -F package=@test.zip http://localhost:4502/crx/packmgr/service/.json

Installation d’un module

curl -u <user>:<password> -F cmd=install http://localhost:4502/crx/packmgr/service/.json/etc/packages/my_packages/test.zip

Désinstallation d’un module

curl -u <user>:<password> -F cmd=uninstall http://localhost:4502/crx/packmgr/service/.json/etc/packages/my_packages/test.zip

Suppression d’un module

curl -u <user>:<password> -F cmd=delete http://localhost:4502/crx/packmgr/service/.json/etc/packages/my_packages/test.zip

Téléchargement d’un module

curl -u <user>:<password> http://localhost:4502/etc/packages/my_packages/test.zip

Gestion des utilisateurs

Création d’un utilisateur

curl -u <user>:<password> -FcreateUser= -FauthorizableId=hashim -Frep:password=hashim http://localhost:4502/libs/granite/security/post/authorizables

Création d’un groupe

curl -u <user>:<password> -FcreateGroup=group1 -FauthorizableId=testGroup1 http://localhost:4502/libs/granite/security/post/authorizables

Ajout d’une propriété à un utilisateur existant

curl -u <user>:<password> -Fprofile/age=25 http://localhost:4502/home/users/h/hashim.rw.html

Création d’un utilisateur avec un profil

curl -u <user>:<password> -FcreateUser=testuser -FauthorizableId=hashimkhan -Frep:password=hashimkhan -Fprofile/gender=male http://localhost:4502/libs/granite/security/post/authorizables

Création d’un utilisateur comme membre d’un groupe

curl -u <user>:<password> -FcreateUser=testuser -FauthorizableId=testuser -Frep:password=abc123 -Fmembership=contributor http://localhost:4502/libs/granite/security/post/authorizables

Ajout d’un utilisateur à un groupe

curl -u <user>:<password> -FaddMembers=testuser1 http://localhost:4502/home/groups/t/testGroup.rw.html

Suppression d’un utilisateur dans un groupe

curl -u <user>:<password> -FremoveMembers=testuser1 http://localhost:4502/home/groups/t/testGroup.rw.html

Définition de l’appartenance à un groupe d’un utilisateur

curl -u <user>:<password> -Fmembership=contributor -Fmembership=testgroup http://localhost:4502/home/users/t/testuser.rw.html

Suppression d’un utilisateur

curl -u <user>:<password> -FdeleteAuthorizable= http://localhost:4502/home/users/t/testuser

Suppression d’un groupe

curl -u <user>:<password> -FdeleteAuthorizable= http://localhost:4502/home/groups/t/testGroup

Sauvegarde

Voir Sauvegarde et restauration pour plus de détails.

OSGi

Démarrage d’un lot

curl -u <user>:<password> -Faction=start http://localhost:4502/system/console/bundles/<bundle-name>

Arrêt d’un lot

curl -u <user>:<password> -Faction=stop http://localhost:4502/system/console/bundles/<bundle-name>

Dispatcher

Invalidation du cache

curl -H "CQ-Action: Activate" -H "CQ-Handle: /content/test-site/" -H "CQ-Path: /content/test-site/" -H "Content-Length: 0" -H "Content-Type: application/octet-stream" http://localhost:4502/dispatcher/invalidate.cache

Purge du cache

curl -H "CQ-Action: Deactivate" -H "CQ-Handle: /content/test-site/" -H "CQ-Path: /content/test-site/" -H "Content-Length: 0" -H "Content-Type: application/octet-stream" http://localhost:4502/dispatcher/invalidate.cache

Agent de réplication

Contrôle de l’état d’un agent

curl -u <user>:<password> "http://localhost:4502/etc/replication/agents.author/publish/jcr:content.queue.json?agent=publish"
http://localhost:4502/etc/replication/agents.author/publish/jcr:content.queue.json?agent=publish

Suppression d’un agent

curl -X DELETE http://localhost:4502/etc/replication/agents.author/replication99 -u <user>:<password>

Création d’un agent

curl -u <user>:<password> -F "jcr:primaryType=cq:Page" -F "jcr:content/jcr:title=new-replication" -F "jcr:content/sling:resourceType=/libs/cq/replication/components/agent" -F "jcr:content/template=/libs/cq/replication/templates/agent" -F "jcr:content/transportUri=http://localhost:4503/bin/receive?sling:authRequestLogin=1" -F "jcr:content/transportUser=admin" -F "jcr:content/transportPassword={DES}8aadb625ced91ac483390ebc10640cdf"http://localhost:4502/etc/replication/agents.author/replication99

Suspension d’un agent

curl -u <user>:<password> -F "cmd=pause" -F "name=publish"  http://localhost:4502/etc/replication/agents.author/publish/jcr:content.queue.json

Effacement d’une file d’attente d’agent

curl -u <user>:<password> -F "cmd=clear" -F "name=publish"  http://localhost:4502/etc/replication/agents.author/publish/jcr:content.queue.json

Communities

Affectation et révocation de badges

Voir Score des communautés et badges pour plus de détails.

Voir Scoring and Badges Essentials pour plus de détails.

Réindexation de MSRP

Voir MSRP - Fournisseur de ressources d’Enregistrement MongoDB pour plus d’informations.

Sécurité

Activation et désactivation de CRXDE Lite

Voir Activation de l'CRXDE Lite dans AEM pour plus de détails.

Nettoyage de la mémoire d’entrepôt de données

Voir Data Store Garbage Collection pour plus d’informations.

Intégration d’Analytics à Target

Voir Optimisation en Adobe Analytics et Adobe Target pour plus de détails.

Connexion unique

Envoi d’un en-tête de test

Voir Connexion unique pour plus d’informations.

Commandes cURL de manipulation de contenu d’AEM courantes

Vous trouverez ci-après une liste des commandes cURL d’AEM pour la manipulation de contenu.

Gestion des pages

Activation des pages

curl -u <user>:<password> -X POST -F path="/content/path/to/page?lang=fr" -F cmd="activate" http://localhost:4502/bin/replicate.json

Désactivation des pages

curl -u <user>:<password> -X POST -F path="/content/path/to/page?lang=fr" -F cmd="deactivate" http://localhost:4502/bin/replicate.json

Activation d’une arborescence

curl -u <user>:<password> -F cmd=activate -F ignoredeactivated=true -F onlymodified=true -F path=/content/geometrixx http://localhost:4502/etc/replication/treeactivation.html

Verrouillage de la page

curl -u <user>:<password> -X POST -F cmd="lockPage" -F path="/content/path/to/page?lang=fr" -F "_charset_"="utf-8" http://localhost:4502/bin/wcmcommand

Déverrouillage de la page

curl -u <user>:<password> -X POST -F cmd="unlockPage" -F path="/content/path/to/page?lang=fr" -F "_charset_"="utf-8" http://localhost:4502/bin/wcmcommand

Copie de la page

curl -u <user>:<password> -F cmd=copyPage -F destParentPath=/path/to/destination/parent -F srcPath=/path/to/source/location http://localhost:4502/bin/wcmcommand

Workflows

Voir Interaction avec des Workflows par programmation pour plus de détails.

Contenu Sling

Création d’un dossier

curl -u <user>:<password> -F jcr:primaryType=sling:Folder http://localhost:4502/etc/test

Suppression d’un nœud

curl -u <user>:<password> -F :operation=delete http://localhost:4502/etc/test/test.properties

Déplacement d’un nœud

curl -u <user>:<password> -F":operation=move" -F":applyTo=/sourceurl"  -F":dest=/target/parenturl/" https://localhost:4502/content

Copie d’un nœud

curl -u <user>:<password> -F":operation=copy" -F":applyTo=/sourceurl"  -F":dest=/target/parenturl/" https://localhost:4502/content

Chargement de fichiers à l’aide de Sling PostServlet

curl -u <user>:<password> -F"*=@test.properties"  http://localhost:4502/etc/test

Chargement de fichiers à l’aide de Sling PostServlet et spécification d’un nom de nœud

curl -u <user>:<password> -F"test2.properties=@test.properties"  http://localhost:4502/etc/test

Chargement de fichiers spécifiant un type de contenu

curl -u <user>:<password> -F "*=@test.properties;type=text/plain" http://localhost:4502/etc/test

Manipulation des ressources

Voir API HTTP des ressources pour plus d’informations.