SDK d’AEM as a Cloud Service

Le SDK as a Cloud Service AEM est composé des artefacts suivants :

  • Quickstart Jar : composant d’exécution AEM utilisé pour le développement local.
  • Java™ API Jar - La dépendance Java™ Jar/Maven qui expose toutes les API Java™ autorisées pouvant être utilisées pour le développement par rapport à AEM as a Cloud Service. Anciennement appelé Uberjar.
  • Javadoc Jar - Les javadocs du fichier Java™ API Jar
  • Outils Dispatcher : ensemble d’outils utilisés en vue du développement local pour Dispatcher. Artefacts distincts pour UNIX® et Windows

En outre, certains clients qui ont déjà été déployés avec AEM version 6.5 ou antérieure utilisent les artefacts ci-dessous. Si la compilation locale ne fonctionne pas avec le fichier Quickstart Jar et que vous pensez que c’est dû à la suppression des interfaces d’AEM as a Cloud Service déployé, contactez le service clientèle. Ils peuvent déterminer si vous avez besoin d’un accès. Elle nécessite des modifications dans le serveur principal.

  • 6.5 Deprecated Java™ API Jar - un jeu supplémentaire d’interfaces qui ont été supprimées depuis AEM 6.5
  • 6.5 Deprecated Javadoc Jar : Javadocs pour l’ensemble supplémentaire d’interfaces.

Création pour le SDK

Le SDK AEM as a Cloud Service permet de créer et de déployer du code personnalisé. Pour plus d’informations, consultez la documentation sur l’archétype de projet AEM. Voici ce qui est réalisé de manière générale :

  • Compilation du code. Comme prévu, le code source est compilé afin de générer les packages de contenu résultants.
  • Création d’artefacts. Les artefacts sont créés pendant ce processus.
  • Analyse des lots. Les lots sont analysés à l’aide du plug-in d’analyse Maven, qui recherche des problèmes dans le projet Maven, tels que les dépendances manquantes.
  • Déploiement d’artefacts. Les artefacts sont déployés sur le serveur local.

Les mêmes opérations sont exécutées par Cloud Manager lors du déploiement vers des environnements cloud. L’exécution de versions localement permet le développement et les tests locaux. Les développeurs peuvent découvrir du code ou des problèmes structurels efficacement avant de s’engager dans le contrôle de code source et de déclencher des déploiements de Cloud Manager, ce qui peut prendre plus de temps.

REMARQUE

Le SDK as a Cloud Service AEM doit être créé avec une distribution et une version de Java prises en charge par Environnement de création de Cloud Manager. AEM clients as a Cloud Service peuvent télécharger le JDK d’Oracle à partir du Portail de distribution de logiciels et avoir la prise en charge étendue de Java 11 jusqu’en septembre 2026 en raison des conditions de licence et de prise en charge d’Adobe pour la technologie Java d’Oracle lorsqu’elle est utilisée dans des projets Adobe Experience Manager.

Accès au SDK d’AEM as a Cloud Service

  • Vous pouvez consulter l’icône À propos d’Adobe Experience Manager d’AEM Admin Console pour connaître la version d’AEM que vous exécutez en production.
  • Le fichier Quickstart Jar et les outils Dispatcher peuvent être téléchargés dans un fichier ZIP depuis le portail de distribution de logiciels. L’accès aux listes de SDK est limité aux personnes qui ont des environnements sur AEM Managed Services ou AEM as a Cloud Service.
  • Les fichiers Java™ API Jar et Javadoc Jar peuvent être téléchargés via l’outil Maven, que ce soit en ligne de commande ou avec votre IDE préféré.
  • Les fichiers pom de projet Maven doivent faire référence au package API Jar suivant. Vous devez également référencer la dépendance à l’égard de tout sous-package pom.
<dependency>
  <groupId>com.adobe.aem</groupId>
  <artifactId>aem-sdk-api</artifactId>
  <version>2019.11.3006.20191108T223635Z-191201</version>
  <scope>provided</scope>
</dependency>
REMARQUE

L’entrée de version du SDK doit correspondre à la version d’AEM as a Cloud Service. Vous pouvez voir la version que vous utilisez en vous connectant à AEM. Dans le coin supérieur droit de l’écran, accédez au point d’interrogation et sélectionnez À propos d’Adobe Experience Manager.

Actualisation d’un projet local avec une nouvelle version du SDK

Quand est-il recommandé d’actualiser le projet local avec un nouveau SDK ?

Adobe recommande l’actualiser après une version de maintenance mensuelle.

Il est facultatif de l’actualiser après une version de maintenance quotidienne. Les clients sont informés lorsque leur instance de production a été correctement mise à niveau vers une nouvelle version d’AEM. Pour les versions de maintenance quotidiennes, il n’est pas prévu que le nouveau SDK ait changé de manière significative, voire pas du tout. Il est toutefois recommandé d’actualiser occasionnellement l’environnement de développement AEM local avec le dernier SDK, puis de recréer et de tester l’application personnalisée. La version de maintenance mensuelle comprend généralement des modifications ayant plus d’impact. Les développeurs doivent donc immédiatement actualiser, recréer et tester.

Voici la procédure recommandée pour actualiser un environnement local :

  1. Assurez-vous que tout contenu utile est soit validé dans le projet dans le contrôle de code source, soit disponible dans un package de contenu modifiable pour importation ultérieure…
  2. Le contenu du test de développement local doit être stocké séparément afin qu’il ne soit pas déployé dans le cadre de la génération du pipeline Cloud Manager. La raison en est qu'elle n'est utilisée que pour le développement local.
  3. Arrêtez le démarrage rapide en cours d’exécution.
  4. Déplacer le crx-quickstart vers un autre dossier pour une conservation sécurisée.
  5. Notez la nouvelle version d’AEM, qui est indiquée dans Cloud Manager (elle est utilisée pour identifier la nouvelle version de QuickStart Jar à télécharger ultérieurement).
  6. Téléchargez le fichier JAR QuickStart dont la version correspond à la version de l’AEM de production sur le portail de distribution de logiciels.
  7. Créez un nouveau dossier et insérez le nouveau fichier QuickStart Jar.
  8. Démarrez le nouveau fichier QuickStart avec les modes d’exécution de votre choix (renommez le fichier ou transmettez les modes d’exécution au moyen de -r).
    • Assurez-vous qu’il n’y a aucun vestige de l’ancien fichier quickstart dans le dossier.
  9. Créez votre application AEM…
  10. Déployez votre application AEM sur AEM local au moyen de Package Manager.
  11. Installez tous les modules de contenu modifiable nécessaires au test de l’environnement local via le gestionnaire de modules.
  12. Poursuivez le développement et déployez les modifications si nécessaire.

Si du contenu doit être installé avec chaque nouvelle version de quickstart d’AEM, incluez-le dans un package de contenu et dans le contrôle de code source du projet. Installez-le ensuite à chaque fois.

Il est recommandé de mettre à jour fréquemment le SDK (par exemple, toutes les deux semaines) et de supprimer quotidiennement l’état local complet pour ne pas dépendre accidentellement de données avec état dans l’application.

Si vous dépendez de CryptoSupport (en configurant les informations d’identification des services Cloud ou du service de messagerie SMTP dans AEM ou en utilisant l’API CryptoSupport dans votre application.), les propriétés chiffrées sont chiffrées par une clé. Cette clé est générée automatiquement au premier démarrage d’un environnement AEM. Bien que la configuration du cloud se charge de réutiliser automatiquement la clé de chiffrement spécifique à l’environnement, il est nécessaire d’injecter la clé de chiffrement dans l’environnement de développement local.

Par défaut, AEM est configuré pour stocker les données clés dans le dossier de données d’un dossier, mais pour faciliter leur réutilisation dans le développement, le processus d’AEM peut être initialisé au premier démarrage avec "".-Dcom.adobe.granite.crypto.file.disable=true". Ce processus génère les données de chiffrement à l’adresse "/etc/key".

Pour pouvoir réutiliser des packages de contenu contenant les valeurs chiffrées, procédez comme suit :

  • Lorsque vous démarrez le fichier quickstart.jar local, veillez à ajouter le paramètre ci-dessous : « -Dcom.adobe.granite.crypto.file.disable=true ». Il est recommandé de toujours l’ajouter, bien qu’il soit facultatif.
  • La première fois que vous démarrez une instance, créez un package contenant un filtre pour la racine./etc/key". Ce package contient le secret à réutiliser dans tous les environnements pour lesquels vous souhaitez qu’ils soient réutilisés.
  • Exportez tout contenu modifiable contenant des secrets ou recherchez les valeurs chiffrées au moyen de la fonction /crx/de vous pouvez donc l’ajouter au module qui est réutilisé dans toutes les installations.
  • Lorsque vous créez une nouvelle instance (pour remplacer par une nouvelle version ou dans la mesure où plusieurs environnements de développement doivent partager les informations d’identification pour les tests), installez le module généré aux étapes 2 et 3. Cela vous permet de réutiliser le contenu sans avoir à le reconfigurer manuellement. La raison est que la cryptoclé est maintenant synchronisée.

Sur cette page