エンドポイントのプログラム管理

最終更新日： 2024年7月15日
  • 適用対象：
  • Experience Manager 6.5
  • トピック：

作成対象：

  • 開発者

このドキュメントのサンプルと例は、JEE 環境の AEM Forms のみを対象としています。

Endpoint Registry サービスについて

Endpoint Registry サービスは、エンドポイントをプログラムで管理する機能を提供します。例えば、次の種類のエンドポイントをサービスに追加できます。

  • EJB
  • SOAP
  • 監視フォルダー
  • メール
  • （AEM Forms では非推奨）リモート
  • タスクマネージャー
メモ
SOAP、EJB、および（JEE 上の AEM Forms では非推奨）リモートエンドポイントは、アクティブにした各サービスに対して自動的に作成されます。SOAP および EJB エンドポイントは、すべてのサービス操作で SOAP および EJB を有効にします。

リモートエンドポイントを使用すると、Flex クライアントは、エンドポイントが追加される AEM Forms サービスで操作を呼び出すことができます。エンドポイントと同じ名前を持つ Flex の宛先が作成され、Flex クライアントは、関連するサービスの操作を呼び出すために、この宛先を指す RemoteObjects を作成できます。

メール、タスクマネージャー、監視フォルダーの各エンドポイントでは、サービスの特定の操作のみが公開されます。これらのエンドポイントを追加する場合は、呼び出し方法の選択、設定パラメーターの指定、入力および出力のパラメーターマッピングの指定を行うので、もう一段階の設定手順が必要になります。

TaskManager エンドポイントを​ カテゴリ ​というグループに整理できます。その後、これらのカテゴリは TaskManager を通じて Workspace に公開され、エンドユーザーには分類した TaskManager エンドポイントが表示されます。Workspace 内では、エンドユーザーにはナビゲーションウィンドウにこれらのカテゴリが表示されます。各カテゴリ内のエンドポイントは、Workspace の「Start Processes」ページにプロセスカードとして表示されます。

Endpoint Registry サービスを使用して、次のタスクを実行できます。

EJB エンドポイントの追加

EJB エンドポイントは、AEM Forms Java API を使用して、プログラムによってサービスに追加できます。EJB エンドポイントをサービスに追加すると、クライアントアプリケーションで EJB モードを使用してサービスを呼び出すことができます。つまり、AEM Forms を呼び出すために必要な接続プロパティを設定する場合は、EJB モードを選択できます（接続プロパティの設定を参照）。

メモ
web サービスを使用して EJB エンドポイントを追加することはできません。
メモ
通常、EJB エンドポイントはデフォルトでサービスに追加されますが、EJB エンドポイントは、プログラムでデプロイされたプロセスや、EJB エンドポイントが削除され、再度追加される必要があるプロセスに追加できます。

手順の概要

EJB エンドポイントをサービスに追加するには、次のタスクを実行します。

  1. プロジェクトファイルを含めます。
  2. EndpointRegistry Client オブジェクトを作成します。
  3. EJB エンドポイント属性を設定します。
  4. EJB エンドポイントを作成します。
  5. エンドポイントを有効にします。

プロジェクトファイルを含める

開発プロジェクトに必要なファイルを含めます。次の JAR ファイルをプロジェクトのクラスパスに追加する必要があります。

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-utilities.jar（AEM Forms が JBoss Application Server にデプロイされている場合に必要）
  • jbossall-client.jar（AEM Forms が JBoss Application Server にデプロイされている場合に必要）

これらの JAR ファイルの場所については、AEM Forms Java ライブラリファイルを含めるを参照してください。

EndpointRegistry Client オブジェクトを作成する

EJB エンドポイントをプログラムで追加する前に、 EndpointRegistryClient オブジェクトを作成する必要があります。

EJB エンドポイント属性を設定する

サービスの EJB エンドポイントを作成するには、次の値を指定します。

  • コネクタ識別子：作成するエンドポイントのタイプを指定します。EJB エンドポイントを作成するには、EJB を指定します。
  • 説明：エンドポイントの説明を指定します。
  • 名前：エンドポイントの名前を指定します。
  • サービス識別子：エンドポイントが属するサービスを指定します。
  • 操作名：エンドポイントを使用して呼び出す操作の名前を指定します。EJB エンドポイントを作成する際に、ワイルドカード文字（*）を指定します。ただし、すべてのサービス操作を呼び出すのではなく、特定の操作を指定する場合は、ワイルドカード文字（*）を使用するのではなく、操作の名前を指定します。

EJB エンドポイントを作成する

EJB エンドポイント属性を設定した後、サービス用の EJB エンドポイントを作成できます。

エンドポイントを有効にする

エンドポイントを作成したら、そのエンドポイントを有効にする必要があります。エンドポイントを有効にした後は、エンドポイントを使用してサービスを呼び出すことができます。エンドポイントを有効にすると、管理コンソール内で表示できます。

関連トピック

Java API を使用した EJB エンドポイントの追加

AEM Forms Java ライブラリファイルを含める

接続プロパティの設定

Java API を使用した EJB エンドポイントの追加

Java API を使用して EJB エンドポイントを追加します。

  1. プロジェクトファイルを含めます。

    adobe-livecycle-client.jar などのクライアント JAR ファイルを Java プロジェクトのクラスパスに含めます。（

  2. EndpointRegistry クライアントオブジェクトを作成します。

    • 接続プロパティを含む ServiceClientFactory オブジェクトを作成します。
    • コンストラクタを使用して ServiceClientFactory オブジェクトを渡すことによって、EndpointRegistryClient オブジェクトを作成します。

  3. EJB エンドポイント属性を設定します。

    • コンストラクタを使用して CreateEndpointInfo オブジェクトを作成します。
    • CreateEndpointInfo オブジェクトの setConnectorId メソッドを呼び出し、文字列値 EJB を渡すことによって、コネクター識別子の値を指定します。
    • CreateEndpointInfoオブジェクトの setDescription メソッドを呼び出し、エンドポイントを説明する文字列値を渡すことによって、エンドポイントの説明を指定します。
    • CreateEndpointInfo オブジェクトの setName メソッドを呼び出し、名前を指定する文字列値を渡すことによって、エンドポイントの名前を指定します。
    • CreateEndpointInfo オブジェクトの setServiceId メソッドを呼び出し、サービス名を指定する文字列値を渡すことによって、エンドポイントが属するサービスを指定します。
    • CreateEndpointInfo オブジェクトの setOperationName メソッドを呼び出し、操作名を指定する文字列値を渡すことによって、呼び出される操作を指定します。SOAP および EJB エンドポイントの場合は、ワイルドカード文字（*）を指定します。これは、すべての操作を示します。

  4. EJB エンドポイントを作成します。

    エンドポイントを作成するには、EndpointRegistryClient オブジェクトの createEndpoint メソッドを呼び出し、CreateEndpointInfo オブジェクトを渡します。このメソッドは、新しい EJB エンドポイントを表す Endpoint オブジェクトを返します。

  5. エンドポイントを有効にします。

    エンドポイントを有効にするには、EndpointRegistryClient オブジェクトの enable メソッドを呼び出し、createEndpoint メソッドによって返された Endpoint オブジェクトを渡します。

関連情報

手順の概要

クイックスタート：Java API を使用した EJB エンドポイントの追加

AEM Forms Java ライブラリファイルを含める

接続プロパティの設定

SOAP エンドポイントの追加

SOAP エンドポイントは、AEM Forms Java API を使用して、プログラムによってサービスに追加できます。SOAP エンドポイントを追加すると、クライアントアプリケーションで SOAP モードを使用してサービスを呼び出すことができます。つまり、AEM Forms を呼び出すために必要な接続プロパティを設定する場合、SOAP モードを選択できます。

メモ
Web サービスを使用して SOAP エンドポイントを追加することはできません。
メモ
通常、SOAP エンドポイントはデフォルトでサービスに追加されますが、SOAP エンドポイントは、プログラムでデプロイされたプロセスや、SOAP エンドポイントが削除され、再度追加される必要があるプロセスに追加できます。

手順の概要

SOAP エンドポイントをサービスに追加するには、次のタスクを実行します。

  1. プロジェクトファイルを含めます。
  2. EndpointRegistryClient オブジェクトを作成します。
  3. SOAP エンドポイント属性を設定します。
  4. SOAP エンドポイントを作成します。
  5. エンドポイントを有効にします。

プロジェクトファイルを含める

必要なファイルを開発プロジェクトに含めます。Java を使用してクライアントアプリケーションを作成する場合は、必要な JAR ファイルを含めます。Web サービスを使用している場合は、必ずプロキシファイルを含めてください。

次の JAR ファイルをプロジェクトのクラスパスに追加する必要があります。

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-utilities.jar（AEM Forms が JBoss Application Server にデプロイされている場合に必要）
  • jbossall-client.jar（AEM Forms が JBoss Application Server にデプロイされている場合に必要）

これらの JAR ファイルは、SOAP エンドポイントを作成するために必要です。ただし、SOAP エンドポイントを使用してサービスを呼び出す場合は、追加の JAR ファイルが必要です。AEM Forms JAR ファイルについて詳しくは、AEM Forms Java ライブラリファイルを含めるを参照してください。

EndpointRegistry クライアントオブジェクトの作成

プログラムによって SOAP エンドポイントをサービスに追加するには、 EndpointRegistryClient オブジェクトを作成する必要があります。

SOAP エンドポイント属性を設定する

SOAP エンドポイントをサービスに追加するには、次の値を指定します。

  • コネクタ識別子の値：作成するエンドポイントのタイプを指定します。SOAP エンドポイントを作成するには、SOAP を指定します。
  • 説明：エンドポイントの説明を指定します。
  • 名前：エンドポイントの名前を指定します。
  • サービス識別子の値：エンドポイントが属するサービスを指定します。
  • 操作名：エンドポイントを使用して呼び出される操作の名前を指定します。SOAP エンドポイントを作成する際に、ワイルドカード文字（*）を指定します。ただし、すべてのサービス操作を呼び出すのではなく、特定の操作を指定する場合は、ワイルドカード文字（*）を使用するのではなく、操作の名前を指定します。

SOAP エンドポイントを作成する

SOAP エンドポイント属性を設定した後、SOAP エンドポイントを作成できます。

エンドポイントを有効にする

エンドポイントを作成したら、そのエンドポイントを有効にする必要があります。エンドポイントが有効であれば、サービスの呼び出しに使用することができます。エンドポイントを有効にすると、管理コンソール内で表示できます。

関連トピック

Java API を使用した SOAP エンドポイントの追加

AEM Forms Java ライブラリファイルを含める

接続プロパティの設定

Java API を使用した SOAP エンドポイントの追加

Java API を使用して、SOAP エンドポイントをサービスに追加します。

  1. プロジェクトファイルを含めます。

    adobe-livecycle-client.jar などのクライアント JAR ファイルを Java プロジェクトのクラスパスに含めます。

  2. EndpointRegistry クライアントオブジェクトを作成します。

    • 接続プロパティを含む ServiceClientFactory オブジェクトを作成します。
    • コンストラクタを使用して ServiceClientFactory オブジェクトを渡すことによって、EndpointRegistryClient オブジェクトを作成します。

  3. SOAP エンドポイント属性を設定します。

    • コンストラクタを使用して CreateEndpointInfo オブジェクトを作成します。
    • CreateEndpointInfo オブジェクトの setConnectorId メソッドを呼び出し、文字列値 SOAP を渡すことによって、コネクター識別子の値を指定します。
    • CreateEndpointInfoオブジェクトの setDescription メソッドを呼び出し、エンドポイントを説明する文字列値を渡すことによって、エンドポイントの説明を指定します。
    • CreateEndpointInfo オブジェクトの setName メソッドを呼び出し、名前を指定する文字列値を渡すことによって、エンドポイントの名前を指定します。
    • CreateEndpointInfo オブジェクトの setServiceId メソッドを呼び出し、サービス名を指定する文字列値を渡すことによって、エンドポイントが属するサービスを指定します。
    • CreateEndpointInfo オブジェクトの setOperationName メソッドを呼び出し、操作名を指定する文字列値を渡すことによって、呼び出される操作を指定します。SOAP および EJB エンドポイントの場合は、ワイルドカード文字（*）を指定します。これは、すべての操作を示します。

  4. SOAP エンドポイントを作成します。

    エンドポイントを作成するには、EndpointRegistryClient オブジェクトの createEndpoint メソッドを呼び出し、CreateEndpointInfo オブジェクトを渡します。このメソッドは、新しい SOAP エンドポイントを表す Endpoint オブジェクトを返します。

  5. エンドポイントを有効にします。

    エンドポイントを有効にするには、EndpointRegistryClient オブジェクトの enable メソッドを呼び出し、createEndpoint メソッドによって返された Endpoint オブジェクトを渡します。

関連情報

手順の概要

クイックスタート：Java API を使用した SOAP エンドポイントの追加

AEM Forms Java ライブラリファイルを含める

接続プロパティの設定

監視フォルダーエンドポイントの追加

AEM Forms Java API を使用して、プログラムによって監視フォルダーエンドポイントをサービスに追加できます。監視フォルダーエンドポイントを追加すると、ユーザーはフォルダーにファイル (PDF ファイルなど ) を配置できます。ファイルがフォルダーに配置されると、設定済みのサービスが呼び出され、ファイルを操作します。サービスが指定の操作を実行した後に、変更されたファイルが指定の出力フォルダーに保存されます。監視フォルダーは、毎週月曜日、水曜日、金曜日の正午など、一定の時間間隔で、または Cron スケジュールでスキャンされるように設定されています。

監視フォルダーエンドポイントをプログラムによってサービスに追加する場合は、EncryptDocument という名前の短時間のみ有効なプロセスを考慮してください（AEM Formsプロセスについてを参照してください）。

aw_aw_encryptdocumentprocess

このプロセスは、保護されていない PDF ドキュメントを入力値として受け取り、その PDF ドキュメントを暗号化サービスの EncryptPDFUsingPassword 操作に渡します。PDF ドキュメントをパスワードで暗号化し、パスワードで暗号化された PDF ドキュメントはこのプロセスの出力値です。入力値の名前 ( 保護されていない PDF ドキュメント ) は InDoc、 データタイプは com.adobe.idp.Documentです。出力値の名前 ( パスワードで暗号化された PDF ドキュメント ) は SecuredDoc、 データタイプは com.adobe.idp.Documentです。

メモ
Web サービスを使用した監視フォルダーエンドポイントの追加はできません。

手順の概要

監視フォルダーエンドポイントをサービスに追加するには、次のタスクを実行します。

  1. プロジェクトファイルを含めます。
  2. EndpointRegistryClientオブジェクトを作成します。
  3. 監視フォルダーエンドポイントの属性を設定します。
  4. 設定値を指定します。
  5. 入力パラメーター値を定義します。
  6. 出力パラメーター値を定義します。
  7. 監視フォルダーエンドポイントを作成します。
  8. エンドポイントを有効にします。

プロジェクトファイルを含める

必要なファイルを開発プロジェクトに含めます。Java を使用してクライアントアプリケーションを作成する場合は、必要な JAR ファイルを含めます。Web サービスを使用している場合は、必ずプロキシファイルを含めてください。

次の JAR ファイルをプロジェクトのクラスパスに追加する必要があります。

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-utilities.jar（AEM Forms が JBoss Application Server にデプロイされている場合に必要）
  • jbossall-client.jar（AEM Forms が JBoss Application Server にデプロイされている場合に必要）

これらの JAR ファイルの場所については、AEM Forms Java ライブラリファイルを含めるを参照してください。

EndpointRegistry Client オブジェクトの作成

プログラムによって監視フォルダーエンドポイントを追加するには、 EndpointRegistryClient オブジェクトを作成する必要があります。

監視フォルダーエンドポイントの属性を設定する

サービスの監視フォルダーエンドポイントを作成するには、次の値を指定します。

  • コネクタ識別子：作成するエンドポイントのタイプを指定します。監視フォルダーエンドポイントを作成するには、次を指定します。 WatchedFolder
  • 説明：エンドポイントの説明を指定します。
  • 名前：エンドポイントの名前を指定します。
  • サービス識別子：エンドポイントが属するサービスを指定します。例えば、この節で説明するプロセスに監視フォルダーエンドポイントを追加する場合（Workbench を使用してアクティベートすると、プロセスはサービスになります）、 EncryptDocumentを指定します。
  • 操作名：エンドポイントを使用して呼び出される操作の名前を指定します。通常、Workbench で作成されたプロセスから発生するサービスの監視フォルダーエンドポイントを作成する場合、操作の名前はinvokeになります。

設定値の指定

プログラムによって監視フォルダーエンドポイントをサービスに追加する場合は、監視フォルダーエンドポイントの設定値を指定します。管理コンソールを使用して監視フォルダーエンドポイントを追加した場合、これらの設定値は管理者が指定します。

次のリストでは、監視フォルダーエンドポイントをプログラムでサービスに追加する際に設定される設定値を指定します。

  • パス：監視フォルダーの場所を指定します。クラスター環境では、クラスター内のすべてのコンピューターからアクセスできる共有ネットワークフォルダーを指定する必要があります。
  • 非同期：呼び出しを非同期型にするか同期型にするかを指定します。一次的プロセスや同期プロセスは、同期のみ呼び出すことができます。デフォルト値は true です。非同期をお勧めします。
  • cronExpression：Quartz で、入力ディレクトリのポーリングをスケジュールするために使用されます。
  • purgeDuration：これは必須の属性です。結果フォルダー内のファイルやフォルダがこの値よりも古い場合には、そのファイルやフォルダが削除されます。この値の単位は日です。この属性は、結果フォルダーに常に空き容量を確保しておきたい場合に役立ちます。-1 を指定すると、結果フォルダーの削除は行われません。デフォルト値は -1 です。
  • repeatInterval：入力の有無を確認するために監視フォルダーをスキャンする間隔（秒単位）です。「ジョブ数を制限」が有効になっている場合を除き、平均的なジョブの処理にかかる時間よりも長い時間をこの値に指定する必要があります。そうしないと、システムが過負荷になるおそれがあります。デフォルト値は 5 です。
  • repeatCount：監視フォルダーがフォルダーまたはディレクトリをスキャンする回数です。-1 を指定すると、無限にスキャンされます。デフォルト値は -1 です。
  • throttleOn：一度に処理できる監視フォルダーのジョブ数を制限します。ジョブの最大数は、batchSize の値によって決まります。
  • userName：監視フォルダーからターゲットサービスを呼び出すときに使用されるユーザー名です。この値は必須です。デフォルト値は「SuperAdmin」です。
  • domainName：ユーザーのドメインです。この値は必須です。デフォルト値は「DefaultDom」です。
  • batchSize：1 回のスキャンで取得されるファイルまたはフォルダーの数です。この値を使用して、システムが過負荷の状態になるのを防ぎます。一度にスキャンするファイル数が多すぎると、クラッシュにつながる可能性があります。デフォルト値は 2 です。
  • waitTime：フォルダーまたはファイルを作成してからスキャンするまでに待機する時間（ミリ秒単位）です。例えば、待機時間が 36,000,000 ミリ秒（1 時間）のときにファイルが 1 分前に作成されている場合、59 分以上経過するとこのファイルが取得されます。この属性は、ファイルまたはフォルダーを入力フォルダーにコピーする処理を確実に完了するために役立ちます。例えば、処理の対象となるファイルサイズが大きく、そのファイルをダウンロードするのに 10 分かかる場合は、待機時間を 10 x 60 x 1000 ミリ秒に設定します。このように設定しておけば、監視フォルダーが 10 分間待機せずにファイルをスキャンすることを防げます。デフォルト値は 0 です。
  • excludeFilePattern：スキャンおよび取得するファイルとフォルダーを判別する際に監視フォルダーが使用するパターンです。このパターンに当てはまるファイルまたはフォルダーは、スキャン処理の対象外となります。この設定は、複数のファイルが存在するフォルダーが入力に使用される場合に便利です。フォルダーの内容を、監視フォルダーの取得対象となる名前のフォルダーにコピーすることができます。この手順により、入力フォルダーにフォルダーを完全にコピーする前に、監視フォルダーがフォルダーを取得して処理することを回避できます。例えば、excludeFilePattern の値が data* であれば、data* に一致するファイルとフォルダーはいずれも取得されません。data1 や data2 などといった名前のファイルとフォルダーがこれに該当します。また、ワイルドカードパターンをパターンに追加してファイルパターンを指定することもできます。監視フォルダーでは、*.* や *.pdf などのワイルドカードパターンをサポートするよう、正規表現を変更しました。これらのワイルドカードパターンは、正規表現ではサポートされていません。
  • includeFilePattern：スキャンおよび取得の対象となるフォルダーとファイルを判別するために監視フォルダーが使用するパターンです。例えば、この値が * であれば、input* に一致するすべてのファイルとフォルダーが取得されます。input1 や input2 などといった名前のファイルとフォルダーがこれに該当します。デフォルト値は * です。この値は、すべてのファイルとフォルダーが対象になることを示しています。また、ワイルドカードパターンをパターンに追加してファイルパターンを指定することもできます。監視フォルダーでは、*.* や *.pdf などのワイルドカードパターンに対応するよう、正規表現を変更しました。これらのワイルドカードパターンは、正規表現では対応していません。この値は必須です。
  • resultFolderName：保存された結果を格納するフォルダーです。この場所には、絶対ディレクトリパスや相対ディレクトリパスを指定することができます。結果がこのフォルダーに表示されない場合は、失敗フォルダーを確認してください。読み取り専用ファイルは処理されず、失敗フォルダーに保存されます。デフォルト値は result/%Y/%M/%D/ です。これは、監視フォルダー内の結果フォルダーです。
  • preserveFolderName：スキャンとピックアップに成功した後にファイルが保存される場所です。この場所は、絶対パス、相対パス、null ディレクトリパスのいずれかを指定できます。デフォルト値は preserve/%Y/%M/%D/ です。
  • failureFolderName：失敗ファイルが保存されるフォルダーです。この場所は、常に監視フォルダーからの相対パスで指定します。読み取り専用ファイルは処理されず、失敗フォルダーに保存されます。デフォルト値は failure/%Y/%M/%D/ です。
  • preserveOnFailure：サービスで操作の実行に失敗した場合に入力ファイルを保存します。デフォルト値は true です。
  • overwriteDuplicateFilename：この値を True に設定すると、結果フォルダーと保存用フォルダーにあるファイルが上書きされます。false 設定すると、ファイルやフォルダーの名前に数字のインデックスサフィックスが使用されます。デフォルト値は false です。

入力パラメーター値の定義

監視フォルダーエンドポイントを作成する場合は、入力パラメーターの値を定義する必要があります。つまり、監視フォルダーによって呼び出される操作に渡される入力値を記述する必要があります。例えば、このトピックで紹介するプロセスについて考えてみましょう。入力値として InDoc があり、データ型は com.adobe.idp.Document です。このプロセスの監視フォルダーエンドポイントを作成する場合（プロセスがアクティブ化されると、そのエンドポイントがサービスになります）、入力パラメーターの値を定義する必要があります。

監視フォルダーエンドポイントに必要な入力パラメーター値を定義するには、次の値を指定します。

パラメーター名を入力：入力パラメーターの名前。入力値の名前は、プロセスに対して Workbench で指定されます。入力値がサービス操作（Workbench で作成されたプロセスではないサービス）に属する場合、入力名は component.xml ファイルで指定されます。たとえば、このセクションで紹介するプロセスの入力パラメーターの名前は、InDoc です。

マッピングタイプ：サービス操作を呼び出すために必要な入力値を設定するために使用します。マッピングには次の 2 つのタイプがあります。

  • Literal：監視フォルダーでは、フィールドに入力された値が表示どおりに使用されます。すべての基本 Java 型がサポートされます。たとえば、文字列、long、int および Boolean などの入力が使用される API の場合、文字列は適切な型に変換され、サービスが呼び出されます。
  • Variable：監視フォルダーでは、入力した値をファイルパターンとして使用して入力を取得します。例えば、マッピングの種類に「変数」を選択し、入力ドキュメントを PDF ファイルにする場合、 *.pdf をマッピング値として使用します。

マッピング値：マッピングタイプの値を指定します。例えば、Variable マッピングのタイプを選択した場合は、 *.pdf をファイルパターンとして指定できます。

データタイプ：入力値のデータタイプを指定します。例えば、このセクションで紹介するプロセスの入力値のデータタイプは、com.adobe.idp.Document です。

出力パラメーター値の定義

監視フォルダーエンドポイントを作成する場合は、出力パラメーターの値を定義する必要があります。つまり、監視フォルダーエンドポイントによって呼び出されるサービスが返す出力値を記述する必要があります。例えば、このトピックで紹介するプロセスについて考えてみましょう。出力値の名前が SecuredDoc で、データタイプが com.adobe.idp.Document とします。このプロセスの監視フォルダーエンドポイントを作成する場合（プロセスは、アクティブにするとサービスになります）、出力パラメーターの値を定義する必要があります。

監視フォルダーエンドポイントに必要な出力パラメーター値を定義するには、次の値を指定します。

出力パラメーター名：出力パラメーターの名前。プロセス出力値の名前は、Workbench で指定します。出力値がサービス操作（Workbench で作成したプロセスではないサービス）に属する場合、出力名は component.xml ファイルで指定します。例えば、このセクションで紹介するプロセスの出力パラメーターの名前は SecuredDoc です。

マッピングタイプ：サービスおよび操作の出力を設定するために使用します。以下のオプションが利用できます。

  • サービスが 1 つのオブジェクト（1 つのドキュメント）を返す場合、パターンは %F.pdf で、ソースの宛先は sourcefilename.pdf です。例えば、このセクションで紹介したプロセスは、1 つのドキュメントを返します。その結果、マッピングタイプは %F.pdf（%F は、指定されたファイル名を使用することを意味します）と定義されます。パターン %E は、入力ドキュメントの拡張を指定します。
  • サービスがリストを返す場合、パターンは Result\%F\ で、ソースの宛先は Result\sourcefilename\source1（出力 1）および Result\sourcefilename\source2（出力 2）です。
  • サービスがマップを返す場合、パターンは Result\%F\ で、ソースの宛先は Result\sourcefilename\file1 および Result\sourcefilename\file2 です。マップに複数のオブジェクトがある場合、パターンは Result\%F.pdf で、ソースの宛先は Result\sourcefilename1.pdf（出力 1）、Result\sourcefilenam2.pdf（出力 2）などです。

データタイプ：戻り値のデータタイプを指定します。例えば、このセクションで紹介するプロセスの戻り値のデータタイプは com.adobe.idp.Document です。

監視フォルダーエンドポイントの作成

エンドポイントの属性を設定し、設定値を指定して、入力パラメーターと出力パラメーターの値を定義した後で、監視フォルダーエンドポイントを作成する必要があります。

エンドポイントを有効にする

監視フォルダーエンドポイントを作成したら、そのエンドポイントを有効にする必要があります。エンドポイントが有効であれば、サービスの呼び出しに使用することができます。エンドポイントを有効にすると、管理コンソール内で表示できます。

関連トピック

Java API を使用して監視フォルダーエンドポイントを追加する

AEM Forms Java ライブラリファイルを含める

接続プロパティの設定

Java API を使用して監視フォルダーエンドポイントを追加する

AEM Forms Java API を使用して、監視フォルダーエンドポイントを追加します。

  1. プロジェクトファイルを含めます。

    adobe-livecycle-client.jar などのクライアント JAR ファイルを Java プロジェクトのクラスパスに含めます。

  2. EndpointRegistry クライアントオブジェクトを作成します。

    • 接続プロパティを含む ServiceClientFactory オブジェクトを作成します。
    • コンストラクターを使用して ServiceClientFactory オブジェクトを渡し、EndpointRegistryClient オブジェクトを作成します。

  3. 監視フォルダーエンドポイントの属性を設定します。

    • コンストラクターを使用して CreateEndpointInfo オブジェクトを作成します。
    • CreateEndpointInfo オブジェクトの setConnectorId メソッドを呼び出し、文字列値 WatchedFolder を渡すことによって、コネクター識別子の値を指定します。
    • CreateEndpointInfoオブジェクトの setDescription メソッドを呼び出し、エンドポイントを説明する文字列値を渡すことによって、エンドポイントの説明を指定します。
    • CreateEndpointInfo オブジェクトの setName メソッドを呼び出し、名前を指定する文字列値を渡すことによって、エンドポイントの名前を指定します。
    • CreateEndpointInfo オブジェクトの setServiceId メソッドを呼び出し、サービス名を指定する文字列値を渡すことによって、エンドポイントが属するサービスを指定します。
    • CreateEndpointInfo オブジェクトの setOperationName メソッドを呼び出し、操作名を指定する文字列値を渡すことによって、呼び出される操作を指定します。通常、Workbench で作成されたプロセスから生成されたサービスの監視フォルダーエンドポイントを作成する場合、操作名は invoke になります。

  4. 設定値を指定します。

    監視フォルダーエンドポイントに指定する設定値ごとに、CreateEndpointInfo オブジェクトの setConfigParameterAsText メソッドを呼び出す必要があります。例えば、url の設定値を指定するには、CreateEndpointInfo オブジェクトの setConfigParameterAsText メソッドを呼び出して、以下の文字列値を渡します。

    • 設定値の名前を指定する文字列値。url 設定値を設定する場合は、url を指定します。
    • 設定値の値を指定する文字列値。url 設定値を設定するには、監視フォルダーの場所を指定します。
    メモ
    EncryptDocument サービスに設定されたすべての設定値を確認するには、QuickStart：Java API を使用した監視フォルダーエンドポイントの追加にある Java コードの例を参照してください。

  5. 入力パラメーター値を定義します。

    入力パラメーター値を定義するには、CreateEndpointInfo オブジェクトの setInputParameterMapping メソッドを呼び出し、次の値を渡します。

    • 入力パラメーターの名前を指定する文字列値。例えば、EncryptDocument サービスの入力パラメーターの名前は InDoc です。
    • 入力パラメーターのデータタイプを指定する文字列値。例えば、InDoc 入力パラメーターのデータタイプは com.adobe.idp.Document です。
    • マッピングタイプを指定する文字列値です。例えば、variable を指定できます。
    • マッピングタイプの値を指定する文字列値。例えば、ファイルパターンとして、*.pdf を指定できます。
    メモ
    定義する入力パラメーター値ごとに setInputParameterMapping メソッドを呼び出します。EncryptDocument プロセスには入力パラメーターが 1 つしかないので、このメソッドを 1 度呼び出す必要があります。

  6. 出力パラメーター値を定義します。

    出力パラメーター値を定義するには、CreateEndpointInfo オブジェクトの setOutputParameterMapping メソッドを呼び出し、次の値を渡します。

    • 出力パラメーターの名前を指定する文字列値。例えば、EncryptDocument サービスの出力パラメーターの名前は SecuredDoc です。
    • 出力パラメーターのデータタイプを指定する文字列値。例えば、SecuredDoc 出力パラメーターのデータタイプは com.adobe.idp.Document です。
    • マッピングタイプを指定する文字列値です。例えば、%F.pdf を指定できます。

  7. 監視フォルダーエンドポイントを作成します。

    エンドポイントを作成するには、EndpointRegistryClient オブジェクトの createEndpoint メソッドを呼び出し、CreateEndpointInfo オブジェクトを渡します。このメソッドは、 監視フォルダーエンドポイントを表す Endpoint オブジェクトを返します。

  8. エンドポイントを有効にします。

    エンドポイントを有効にするには、EndpointRegistryClient オブジェクトの enable メソッドを呼び出し、createEndpoint メソッドによって返された Endpoint オブジェクトを渡します。

関連情報

手順の概要

QuickStart：Java API を使用した監視フォルダーエンドポイントの追加

AEM Forms Java ライブラリファイルの組み込み

接続プロパティの設定