Assets desenvolvimento de proxy

Adobe Experience Manager Assets usa um proxy para distribuir o processamento de determinadas tarefas.

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

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

Proxy (Acesso HTTP)

Um proxy está disponível via Servlet HTTP quando está configurado para aceitar trabalhos de processamento em: /libs/dam/cloud/proxy. Este servlet cria um trabalho sling a partir dos parâmetros publicados. Isso é adicionado à fila de trabalhos 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 será 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 especificado.

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 um trabalho e criar um resultado. Os funcionários 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 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 proxy worker estão disponíveis por meio de configurações de serviços em nuvem, conforme acessado pelo console Assets Ferramentas 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).

OBSERVAÇÃO

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 proxy Worker personalizado

O trabalho proxy IDS é um exemplo de um Assets trabalhador proxy que já é fornecido prontamente para terceirizar o processamento de ativos de InDesign.

Você também pode desenvolver e configurar seu próprio representante Assets para criar um funcionário especializado para despachar e terceirizar suas Assets tarefas de processamento.

A configuração de seu próprio representante personalizado requer que você:

  • Configure e implemente (usando o evento Sling):

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

    • despache seu trabalho personalizado para o proxy
    • gerenciar seu trabalho
  • Se quiser usar o proxy de um fluxo de trabalho, você deve 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 de InDesign são indicados como exemplos de referência.

  1. Um Trabalho Sling é usado, portanto, é necessário definir um tópico de trabalho para seu caso de uso.

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

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

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

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

  3. Implemente um gerenciador de tarefas para o seu tópico. Esse manipulador requer desenvolvimento para que execute sua ação específica e seja considerado a implementação do trabalhador.

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

  4. Use ProxyUtil.java em dam-commons. Isso permite que você despache trabalhos para trabalhadores usando o proxy dam.

OBSERVAÇÃO

O que a estrutura proxy Assets não fornece predefinida é o mecanismo de pool.

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

OBSERVAÇÃO

Sincronização dos resultados:

Com nenhuma instância usando o mesmo proxy, o resultado do processamento permanece com o proxy. É tarefa do cliente (Autor do Experience Manager) solicitar o resultado usando a mesma ID exclusiva de trabalho que foi fornecida ao cliente na criação do trabalho. O proxy simplesmente faz o trabalho e mantém o resultado pronto para ser solicitado.

Nesta página