Desenvolvimento de proxy de ativos

O Adobe Experience Manager (AEM) Assets usa um proxy para distribuir o processamento de determinadas tarefas.

Um proxy é uma instância AEM específica (e, às vezes, separada) que usa trabalhadores proxy como processadores responsáveis por manipular um trabalho e criar um resultado. Um trabalhador proxy pode ser usado para uma grande variedade de tarefas. No caso de um proxy da AEM Assets, isso pode ser usado para carregar ativos para renderização no AEM Assets. Por exemplo, o trabalhador proxy IDS usa um InDesign Server para processar arquivos para uso no AEM Assets.

Quando o proxy é uma instância AEM separada, isso ajuda a reduzir a carga na(s) instância(s) de criação de AEM. Por padrão, o AEM Assets executa as tarefas de processamento de ativos na mesma JVM (externalizada via Proxy) para reduzir a carga na instância de criação de AEM.

Proxy (Acesso HTTP)

Um proxy está disponível por meio do Servlet HTTP quando está configurado para aceitar tarefas de processamento em: /libs/dam/cloud/proxy. Este servlet cria um trabalho de sling a partir dos parâmetros publicados. Isso é então adicionado à fila de trabalhos de proxy e conectado ao trabalhador proxy apropriado.

Operações suportadas

  • job

    Requisitos: o parâmetro jobevent deve ser definido como um mapa de valores serializado. Isso é usado para criar um Event para um processador de trabalho.

    Resultado: Adiciona um novo trabalho. Se bem-sucedido, uma ID de trabalho exclusiva é retornada.

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

    Requisitos: o parâmetro jobid deve ser definido.

    Resultado: Retorna uma representação JSON do Nó de resultado, conforme criado pelo processador de trabalho.

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

    Requisitos: o parâmetro jobid deve ser definido.

    Resultado: Retorna um recurso associado ao trabalho em questão.

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

    Requisitos: o parâmetro jobid deve ser definido.

    Resultados: Remove um trabalho, se encontrado.

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

Trabalhador Proxy

Um trabalhador proxy é um processador responsável por manipular uma tarefa e criar um resultado. Os trabalhadores residem na instância proxy e devem implementar sling JobProcessor para serem reconhecidos como um trabalhador proxy.

OBSERVAÇÃO

O trabalhador deve implementar sling JobProcessor para ser reconhecido como um trabalhador proxy.

API do cliente

JobService O está disponível como um serviço OSGi que fornece métodos para criar trabalhos, remover trabalhos e obter resultados desses trabalhos. A implementação padrão deste serviço (JobServiceImpl) usa o cliente HTTP para se comunicar com o servlet proxy remoto.

Este é um exemplo de uso da 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);

Configurações do Cloud Service

OBSERVAÇÃO

A documentação de referência da API de proxy está disponível em com.day.cq.dam.api.proxy.

As configurações do proxy e do trabalhador proxy estão disponíveis por meio das configurações dos serviços de nuvem, conforme acessível no console Ferramentas do AEM Assets ou em /etc/cloudservices/proxy. Espera-se que cada trabalhador proxy adicione um nó em /etc/cloudservices/proxy para detalhes de configuração específicos do trabalhador (por exemplo, /etc/cloudservices/proxy/workername).

Este é um exemplo de uso da 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");

Desenvolvendo um trabalhador proxy personalizado

O trabalhador proxy do IDS é um exemplo de um trabalhador proxy do AEM Assets que já foi fornecido pronto para uso para terceirizar o processamento de ativos do Indesign.

Você também pode desenvolver e configurar seu próprio trabalhador proxy da AEM Assets para criar um trabalhador especializado para despachar e terceirizar suas tarefas de processamento da AEM Assets.

Configurar seu próprio trabalho proxy personalizado requer:

  • Configurar e implementar (usando o evento Sling):

    • um tópico de tarefa personalizada
    • um manipulador de evento de trabalho personalizado
  • Em seguida, use a API JobService para:

    • despache seu trabalho personalizado para o proxy
    • gerencie seu trabalho
  • Se quiser usar o proxy de um workflow, é necessário implementar uma etapa externa personalizada usando a API WorkflowExternalProcess e a API JobService.

O diagrama e as etapas a seguir detalham como proceder:

chlimage_1-249

OBSERVAÇÃO

Nas etapas a seguir, os equivalentes Indesign são indicados como exemplos de referência.

  1. Um Sling job é usado, portanto, você precisa definir um tópico de trabalho para seu caso de uso.

    Como exemplo, consulte IDSJob.IDS_EXTENDSCRIPT_JOB para o trabalhador proxy IDS.

  2. A etapa externa é usada para acionar o evento e, em seguida, aguardar até que isso seja concluído; isso é feito pesquisando a id. Você deve desenvolver sua própria etapa para implementar novas funcionalidades.

    Implemente um WorkflowExternalProcess, em seguida, use a API JobService e o tópico de seu trabalho para preparar um evento de trabalho e enviá-lo ao JobService (um serviço OSGi).

    Como exemplo, consulte INDDMediaExtractProcess.java para o trabalhador proxy IDS.

  3. Implemente um manipulador de trabalho para seu tópico. Esse manipulador requer desenvolvimento para executar sua ação específica e é considerado a implementação do trabalhador.

    Como exemplo, consulte IDSJobProcessor.java para o trabalhador proxy IDS.

  4. Use ProxyUtil.java em dam-commons. Isso permite despachar trabalhos para trabalhadores usando o proxy dam.

OBSERVAÇÃO

O que a estrutura de proxy do AEM Assets não fornece pronto para uso é o mecanismo de pool.

A integração do InDesign permite o acesso de um pool de servidores do Indesign (IDSPool). Esse pool é específico para a integração do Indesign e não faz parte da estrutura de proxy do AEM Assets.

OBSERVAÇÃO

Sincronização dos resultados:

Com n instâncias usando o mesmo proxy, o resultado do processamento permanece com o proxy. É tarefa do cliente (Autor do AEM) solicitar o resultado usando a mesma id de trabalho exclusiva fornecida ao cliente na criação de emprego. O proxy simplesmente faz o trabalho e mantém o resultado pronto para ser solicitado.

Nesta página