Assets desenvolvimento de proxy

Última atualização em 2023-12-04
  • Criado para:
  • Admin
    Developer

Adobe Experience Manager Assets O 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 lidar com um trabalho e criar um resultado. Um trabalhador proxy pode ser usado para uma grande variedade de tarefas. Se houver uma Assets proxy que pode ser usado para carregar ativos para renderização dentro do Assets. Por exemplo, a variável Worker do proxy de IDS usa um Adobe InDesign Servidor para processar arquivos para uso no Assets.

Quando o proxy é separado Experience Manager ajuda a reduzir a carga no Experience Manager instância(s) de criação. Por padrão, Assets O executa as tarefas de processamento de ativos na mesma JVM (externalizada via Proxy) para reduzir a carga no Experience Manager instância de criação.

Proxy (Acesso HTTP)

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

    Resultado: adiciona uma nova tarefa. Se for bem-sucedido, uma ID de tarefa 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 trabalhos.

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 à tarefa especificada.

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

Worker do proxy

Um trabalhador proxy é um processador responsável por gerenciar um trabalho e criar um resultado. Os funcionários residem na instância do proxy e devem implementar sling JobProcessor para ser reconhecido 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 e 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.

Veja a seguir um exemplo de uso da API:

@Reference
 JobService proxyJobService;

 // to create a 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 de Cloud Service

As configurações de proxy e proxy worker estão disponíveis por meio das configurações de serviços em nuvem, conforme acessíveis a partir do Assets Ferramentas console 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

Veja a seguir 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");

Desenvolvimento de um Worker de proxy personalizado

A variável Worker do proxy de IDS é um exemplo de um Assets trabalhador proxy que já foi fornecido pronto para uso para terceirizar o processamento de ativos do InDesign.

Você também pode desenvolver e configurar seus próprios Assets um funcionário por procuração para criar um funcionário especializado para despachar e terceirizar seu Assets processando tarefas.

Para configurar seu próprio trabalhador proxy personalizado, é necessário:

  • Configurar e implementar o (usando evento Sling):

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

    • despachar 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, equivalentes de InDesign são indicados como exemplos de referência.

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

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

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

    Implementar um WorkflowExternalProcess, em seguida, use a API JobService e o 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 trabalhador proxy do IDS.

  3. Implemente um manipulador de tarefas para o 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 trabalhador proxy de IDS.

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

OBSERVAÇÃO

O que Assets A estrutura de proxy não fornece o mecanismo de pool pronto para uso.

A variável InDesign A integração permite o acesso de um pool de InDesign (IDSPool). Esse pool é específico do InDesign integração e não faz parte do Assets estrutura de proxy.

OBSERVAÇÃO

Sincronização dos resultados:

Com n instâncias usando o mesmo proxy, o resultado do processamento permanece com o proxy. É o trabalho do cliente (Experience Manager Author) solicitar o resultado usando a mesma ID de trabalho exclusiva 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