资产代理开发

Adobe Experience Manager(AEM)资产使用代理为某些任务分发处理。

代理是一个特定(有时也是单独的)AEM实例,它使用代理工作程序作为处理程序,负责处理作业并创建结果。 代理工作器可用于各种任务。 对于AEM Assets代理,此代理可用于加载资产以在AEM Assets内进行渲染。 例如,IDS代理工作者使用InDesign Server处理文件以在AEM Assets使用。

当代理是单独的AEM实例时,这有助于减少AEM创作实例的负载。 默认情况下,AEM Assets在同一JVM(通过代理外部化)中执行资产处理任务,以减少AEM创作实例的负载。

代理(HTTP访问)

当代理配置为在以下位置接受处理作业时,可通过HTTP Servlet使用:/libs/dam/cloud/proxy。 此servlet根据已发布的参数创建sling作业。 然后,此操作会添加到代理作业队列并连接到相应的代理工作器。

支持的操作

  • job

    要求:该参 jobevent 数必须设置为序列化值映射。它用于为作业处理器创建Event

    结果:添加新作业。如果成功,则返回唯一作业ID。

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

    要求:必须 jobid 设置参数。

    结果:返回作业处理者创建的结果节点的JSON表示形式。

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

    要求:必须设置参数jobid。

    结果:返回与给定作业关联的资源。

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

    要求:必须设置参数jobid。

    结果:如果找到,则删除作业。

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

代理工作器

代理工作者是负责处理作业和创建结果的处理器。 Worker驻留在代理实例上,必须实现sling JobProcessor才能被识别为代理Worker。

注意

该工作人员必须实施sling JobProcessor才能被识别为代理工作人员。

客户端API

JobService 可用作OSGi服务,它提供创建作业、删除作业和从这些作业获取结果的方法。此服务的默认实现(JobServiceImpl)使用HTTP客户端与远程代理servlet通信。

以下是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);

云服务配置

注意

com.day.cq.dam.api.proxy下提供代理API的参考文档。

代理和代理工作器配置均可通过云服务配置使用,这些配置可从AEM Assets 工具​控制台或/etc/cloudservices/proxy下访问。 每个代理工作器应在/etc/cloudservices/proxy下添加一个节点,以了解工作器特定的配置详细信息(例如/etc/cloudservices/proxy/workername)。

注意

有关详细信息,请参阅Indesign Server代理工作器配置Cloud Services配置

以下是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");

开发自定义代理工作器

IDS代理工作者是AEM Assets代理工作者的一个示例,该代理工作者已经提供现成的外包,用于外包Indesign资产的处理。

您还可以开发和配置自己的AEM Assets代理工作人员,以创建专门的工作人员来调度和外包您的AEM Assets处理任务。

设置您自己的自定义代理工作者需要您:

  • 设置和实施(使用Sling事件):

    • 自定义作业主题
    • 自定义作业事件处理程序
  • 然后,使用JobService API可以:

    • 向代理派送自定义作业
    • 管理您的作业
  • 如果要从工作流中使用代理,则必须使用WorkflowExternalProcess API和JobService API实现自定义外部步骤。

以下示意图和步骤详细说明了如何继续:

chlimage_1-249

注意

在以下步骤中,Indesign等效项指示为参考示例。

  1. 使用Sling作业,因此您需要为您的用例定义作业主题。

    例如,请参见IDSJob.IDS_EXTENDSCRIPT_JOB了解IDS代理工作器。

  2. 外部步骤用于触发事件,然后等待完成;这是通过轮询id来完成的。 您必须自行制定实施新功能的步骤。

    实施WorkflowExternalProcess,然后使用JobService API和您的作业主题准备作业事件并将其调度到JobService(一种OSGi服务)。

    例如,请参阅IDS代理工作器的INDDMediaExtractProcess.java。

  3. 为您的主题实施作业处理程序。 此处理程序需要进行开发,以便执行您的特定操作并被视为工作者实现。

    例如,请参见IDSJobProcessor.java了解IDS代理工作器。

  4. 在dam-commons中利用ProxyUtil.java。 这允许您使用dam代理向员工分派任务。

注意

AEM Assets代理框架不提供现成的池机制。

InDesign集成允许访问indesign服务器池(IDSPool)。 此池特定于Indesign集成,而不是AEM Assets代理框架的一部分。

注意

结果同步:

如果n个实例使用同一代理,则处理结果与代理保持一致。 客户端(AEM作者)的作业使用与创建作业时给客户端的相同唯一作业ID请求结果。 代理只需完成作业,并将结果保持为可请求。

在此页面上

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