Développement d’un proxy Assets

Adobe Experience Manager (AEM) Assets utilise un proxy pour distribuer le traitement de certaines tâches.

Un proxy est une instance AEM spécifique (et parfois distincte) qui utilise des workers de proxy comme processeurs chargés de gérer une tâche et de produire un résultat. Un worker de proxy peut être utilisé pour de nombreuses tâches. Dans le cas d’un proxy AEM Assets, il peut être utilisé pour charger des ressources pour le rendu dans AEM Assets. Par exemple, le worker de proxy IDS utilise un serveur InDesign pour traiter les fichiers à utiliser dans AEM Assets.

Lorsque le proxy est une instance AEM distincte, il contribue à réduire la charge sur la ou les instances de création AEM. Par défaut, AEM Assets exécute les tâches de traitement des fichiers dans la même JVM (externalisée par proxy) afin de réduire la charge sur l’instance de création AEM.

Proxy (Accès HTTP)

Un proxy est disponible via le servlet HTTP lorsqu’il est configuré pour accepter des tâches de traitement à l’adresse suivante : /libs/dam/cloud/proxy. Ce servlet crée une tâche sling à partir des paramètres publiés. Elle est ensuite ajoutée à la file d’attente des tâches du proxy et connectée au worker de proxy approprié.

Opérations prises en charge

  • job

    Exigences : le paramètre jobevent doit être défini en tant que correspondance de valeur en série. Il est utilisé pour créer un Event pour un processeur de travaux.

    Résultat : ajoute une nouvelle tâche. Si l’opération réussit, un identifiant de tâche unique est renvoyé.

curl -u admin:admin -F":operation=job" -F"someproperty=xxxxxxxxxxxx"
    -F"jobevent=serialized value map" http://localhost:4502/libs/dam/cloud/proxy
  • result

    Exigences : le paramètre jobid doit être défini.

    Résultat : renvoie une représentation JSON du nœud de résultats tel que créé par le processeur de tâches.

curl -u admin:admin -F":operation=result" -F"jobid=xxxxxxxxxxxx"
    http://localhost:4502   /libs/dam/cloud/proxy
  • resource

    Exigences : le paramètre jobid doit être défini.

    Résultat : renvoie une ressource associée à la tâche concernée.

curl -u admin:admin -F":operation=resource" -F"jobid=xxxxxxxxxxxx"
    -F"resourcePath=something.pdf" http://localhost:4502/libs/dam/cloud/proxy
  • remove

    Exigences : le paramètre jobid doit être défini.

    Résultats : supprime une tâche si elle est trouvée.

curl -u admin:admin -F":operation=remove" -F"jobid=xxxxxxxxxxxx"
    http://localhost:4502/libs/dam/cloud/proxy

Worker de proxy

Un worker de proxy est un processeur chargé de gérer une tâche et de produire un résultat. Les workers résident sur l’instance de proxy et doivent mettre en œuvre sling JobProcessor pour être reconnus en tant que workers de proxy.

REMARQUE

Le worker doit mettre en œuvre sling JobProcessor pour être reconnu en tant que worker de proxy.

API client

JobService est disponible en tant que service OSGi qui prévoit des méthodes pour créer des tâches, supprimer des tâches et obtenir des résultats de ces tâches. La mise en œuvre par défaut de ce service (JobServiceImpl) utilise le client HTTP pour communiquer avec le servlet de proxy à distance.

Voici un exemple d’utilisation d’API :

@Reference
 JobService proxyJobService;

 // to create a new job
 final Hashtable props = new Hashtable();
 props.put("someproperty", "some value");
 props.put(JobUtil.PROPERTY_JOB_TOPIC, "myworker/job"); // this is an identifier of the worker
 final String jobId = proxyJobService.addJob(props, new Asset[]{asset});

 // to check status (returns JobService.STATUS_FINISHED or JobService.STATUS_INPROGRESS)
 int status = proxyJobService.getStatus(jobId)

 // to get the result
 final String jsonString = proxyJobService.getResult(jobId);

 // to remove job and cleanup
 proxyJobService.removeJob(jobId);

Configurations du service cloud

REMARQUE

La documentation de référence pour l’API de proxy est disponible sous com.day.cq.dam.api.proxy.

Les configurations de proxy et de proxy worker sont disponibles par le biais des configurations de services Cloud comme accessibles à partir de la console Outils AEM Assets ou sous /etc/cloudservices/proxy. Chaque agent proxy doit ajouter un noeud sous /etc/cloudservices/proxy pour les détails de configuration spécifiques au programme de travail (par exemple, /etc/cloudservices/proxy/workername).

REMARQUE

Voici un exemple d’utilisation d’API :

@Reference(policy = ReferencePolicy.STATIC)
 ProxyConfig proxyConfig;
 
 // to get proxy config
 Configuration cloudConfig = proxyConfig.getConfiguration();
 final String value = cloudConfig.get("someProperty", "defaultValue");

 // to get worker config
 Configuration cloudConfig = proxyConfig.getConfiguration("workername");
 final String value = cloudConfig.get("someProperty", "defaultValue");

Développement d’un worker de proxy personnalisé

Le service de proxy IDS est un exemple de service de proxy AEM Assets qui est déjà fourni prêt à l'emploi pour sous-traiter le traitement des ressources Indesign.

Vous pouvez également développer et configurer votre propre collaborateur proxy AEM Assets pour créer un collaborateur spécialisé qui répartira et externalisera vos tâches de traitement AEM Assets.

Pour configurer votre propre worker de proxy personnalisé, vous devez effectuer les opérations suivantes :

  • Configurer et mettre en œuvre (à l’aide des événements Sling) :

    • une rubrique de tâche personnalisée ;
    • un gestionnaire d’événements de tâche personnalisé.
  • Puis utiliser l’API JobService pour :

    • distribuer votre tâche personnalisée au proxy ;
    • gérer votre tâche.
  • Si vous souhaitez utiliser le proxy à partir d’un processus, vous devez mettre en œuvre une étape externe personnalisée à l’aide de l’API WorkflowExternalProcess et de l’API JobService.

Le schéma et les étapes ci-dessous détaillent la procédure à suivre :

chlimage_1-249

REMARQUE

Dans les étapes suivantes, des équivalents InDesign sont indiqués comme exemples de référence.

  1. Une tâche Sling est utilisée, ce qui signifie que vous devez définir une rubrique de tâche pour votre cas d’emploi.

    Par exemple, consultez IDSJob.IDS_EXTENDSCRIPT_JOB pour le worker de proxy IDS.

  2. L’étape externe est utilisée pour déclencher l’événement et attendre qu’il soit terminé en interrogeant l’identifiant. Vous devez développer votre propre étape pour mettre en œuvre de nouvelles fonctionnalités.

    Mettez en œuvre une API WorkflowExternalProcess, puis utilisez l’API JobService et votre rubrique de tâche pour préparer un événement de tâche et le distribuer à l’API JobService (un service OSGi).

    Par exemple, consultez INDDMediaExtractProcess.java pour le worker de proxy IDS.

  3. Mettez en œuvre un gestionnaire de tâches pour votre rubrique. Ce gestionnaire nécessite un développement afin d’effectuer votre action spécifique et est considéré comme la mise en œuvre du worker.

    Par exemple, consultez IDSJobProcessor.java pour le worker de proxy IDS.

  4. Utilisez ProxyUtil.java dans dam-commons. Cela vous permet de distribuer des tâches à des workers à l’aide du proxy de gestion des actifs numériques.

REMARQUE

Ce que le cadre proxy AEM Assets ne fournit pas prêt à l'emploi est le mécanisme de pool.

L’intégration InDesign autorise l’accès à un pool de serveurs InDesign (IDSPool). Ce pool est spécifique à l’intégration d’Indesign et ne fait pas partie de la structure proxy AEM Assets.

REMARQUE

Synchronisation des résultats :

Avec n instances utilisant le même proxy, le résultat de traitement reste avec le proxy. Il revient au client (auteur AEM) de demander le résultat à l’aide du même identifiant de tâche unique qui lui a été donné lors de la création de la tâche. Le proxy fait son travail et conserve le résultat disponible sur demande.

Sur cette page

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now