Assets のプロキシ開発

Adobe Experience Manager Assetsでは、プロキシを使用して、特定のタスクの処理を配布します。

プロキシとは、ジョブの処理と結果の作成を担当するプロセッサーとしてプロキシワーカーを使用する、特定の（場合によっては別々の）Experience Managerインスタンスです。 プロキシワーカーは、幅広いタスクに使用できます。Experience Manager Assetsプロキシの場合は、Experience Manager Assets内でレンダリングするためのアセットの読み込みに使用できます。 例えば、IDS プロキシワーカーは、InDesign Server を使用して、 Assets 内で使用できるようにファイルを処理します。Experience Manager

プロキシが別個のExperience Managerインスタンスである場合は、Experience Managerオーサリングインスタンスの負荷を軽減するのに役立ちます。 デフォルトでは、Experience Manager Assetsは、同じJVM（プロキシを介して外部化）でアセット処理タスクを実行し、Experience Managerオーサリングインスタンスの負荷を軽減します。

プロキシ（HTTP アクセス）

プロキシは、次の場所でのジョブの処理を受け入れるよう設定されている場合に、HTTP Servlet を介して使用できます。 /libs/dam/cloud/proxy. このサーブレットは、POST されたパラメーターから 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

プロキシワーカー

プロキシワーカーは、ジョブの処理および結果の作成を担当するプロセッサーです。ワーカーはプロキシインスタンスにあり、プロキシワーカーとして認識されるには、sling JobProcessor を実装する必要があります。

クライアント API

JobService は、ジョブを作成および削除し、ジョブの結果を取得するためのメソッドを提供する OSGi サービスとして使用できます。このサービスのデフォルトの実装（JobServiceImpl）は、HTTP クライアントを使用して、リモートプロキシサーブレットと通信します。

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);

クラウドサービス設定

プロキシとプロキシワーカーの両方の設定は、クラウドサービスの設定を介して使用できます。Experience Manager Assets ツール​コンソールまたは/etc/cloudservices/proxyからアクセスできます。 各プロキシワーカーは、/etc/cloudservices/proxyの下に、ワーカー固有の設定の詳細（/etc/cloudservices/proxy/workernameなど）を示すノードを追加する必要があります。

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プロキシワーカーは、InDesignアセットの処理をアウトソースするためにあらかじめ用意されているExperience Manager Assetsプロキシワーカーの例です。

独自のExperience Manager Assetsプロキシワーカーを開発および設定して、Experience Manager Assets処理タスクをディスパッチおよびアウトソースする専用のワーカーを作成することもできます。

独自のカスタムプロキシワーカーを設定するには、以下を実行する必要があります。

• 以下を設定および実装します（Sling イベントを使用）。

  • カスタムジョブトピック
  • カスタムジョブイベントハンドラー

• 次に、JobService API を使用して以下を実行します。

  • プロキシへのカスタムジョブのディスパッチ
  • ジョブの管理

• ワークフローからプロキシを使用する場合は、WorkflowExternalProcess API および JobService API を使用して、カスタム外部手順を実装する必要があります。

以下の図および手順に、実行方法の詳細を示します。

1. Sling ジョブが使用されるので、ユーザーの使用例向けにジョブトピックを定義する必要があります。

   例として、IDS プロキシワーカーの IDSJob.IDS_EXTENDSCRIPT_JOB を参照してください。

2. 外部手順を使用してイベントを呼び出し、それが終了するまで待機します。これは、ID をポーリングすることによって実行されます。新機能を実装する独自の手順を開発する必要があります。

   WorkflowExternalProcess を実装してから、JobService API およびジョブトピックを使用してジョブイベントを準備し、JobService（OSGi サービス）にディスパッチします。

   例として、IDS プロキシワーカーの INDDMediaExtractProcess.java を参照してください。

3. トピックのジョブハンドラーを実装します。特定のアクションを実行し、ワーカー実装と見なされるように、このハンドラーを開発する必要があります。

   例として、IDS プロキシワーカーの IDSJobProcessor.java を参照してください。

4. dam-commons の ProxyUtil.java を使用します。これにより、DAM プロキシを使用してジョブをワーカーにディスパッチできます。