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

このドキュメントのサンプルと例は、JEE上のAEM Forms環境に限られています。

エンドポイントレジストリサービスについて

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

  • EJB
  • SOAP
  • 監視フォルダー
  • 電子メール
  • (AEM formsでは非推奨)Remoting
  • タスクマネージャー
メモ

SOAP、EJB、および(JEE上のAEM formsでは非推奨)リモートエンドポイントは、アクティブ化された各サービスに対して自動的に作成されます。 SOAPおよびEJBエンドポイントは、すべてのサービス操作でSOAPおよびEJBを有効にします。

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

電子メール、タスクマネージャーおよび監視フォルダーの各エンドポイントでは、サービスの特定の操作のみが公開されます。 これらのエンドポイントを追加するには、呼び出すメソッドの選択、設定パラメーターの設定、入力パラメーターと出力パラメーターのマッピングの指定をおこなう2番目の設定手順が必要です。

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

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

EJBエンドポイントの追加

AEM Forms Java APIを使用して、EJBエンドポイントをプログラムでサービスに追加できます。 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クライアントオブジェクトの作成

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

EJBエンドポイント属性の設定

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

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

EJBエンドポイントの作成

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

エンドポイントの有効化

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

関連トピック

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

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

接続プロパティの設定

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

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

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

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

  2. EndpointRegistry Clientオブジェクトを作成します。

    • 接続プロパティを含む ServiceClientFactory オブジェクトを作成します。
    • コンストラクターを使用してEndpointRegistryClientオブジェクトを渡し、ServiceClientFactoryオブジェクトを作成します。
  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エンドポイントの追加

AEM Forms Java APIを使用して、プログラムでSOAPエンドポイントをサービスに追加できます。 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. プロジェクトファイルを含めます。

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

  2. EndpointRegistry Clientオブジェクトを作成します。

    • 接続プロパティを含む ServiceClientFactory オブジェクトを作成します。
    • コンストラクターを使用してEndpointRegistryClientオブジェクトを渡し、ServiceClientFactoryオブジェクトを作成します。
  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ドキュメントをEncryptionサービスの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クライアントオブジェクトの作成

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

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

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

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

設定値の指定

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

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

  • url:監視フォルダーの場所を指定します。クラスター環境では、この値は、クラスター内のすべてのコンピューターからアクセス可能な共有ネットワークフォルダーを指す必要があります。
  • 非同期:呼び出しの種類を非同期型または同期型として識別します。一過性および同期型のプロセスは、同期型でのみ呼び出すことができます。デフォルト値は true です。非同期をお勧めします。
  • cronExpression:Quartzで、入力ディレクトリのポーリングをスケジュールするために使用されます。Cron式の設定について詳しくは、https://quartz.sourceforge.net/javadoc/org/quartz/CronTrigger.htmlを参照してください。
  • 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*60*1000ミリ秒に設定します。 この設定は、監視フォルダーがファイルをスキャンするのを10分間待たない場合に防ぎます。 デフォルト値は 0 です。
  • excludeFilePattern:スキャンおよび取得の対象とするファイルとフォルダーを決定するために監視フォルダーが使用するパターンです。このパターンを持つファイルまたはフォルダーは、スキャンされて処理されません。 この設定は、入力が複数のファイルを含むフォルダーの場合に役立ちます。 フォルダーの内容を、監視フォルダーで取得される名前のフォルダーにコピーできます。 この手順により、フォルダーが入力フォルダーに完全にコピーされる前に監視フォルダーがフォルダーを取得して処理するのを防ぎます。 例えば、excludeFilePatternの値がdata*の場合、data*に一致するすべてのファイルとフォルダーは取得されません。 これには、data1data2などの名前のファイルやフォルダーが含まれます。 また、パターンにワイルドカードパターンを追加して、ファイルパターンを指定することもできます。 監視フォルダーでは、*.**.pdfなどのワイルドカードパターンに対応するように正規表現が変更されます。 これらのワイルドカードパターンは、正規表現ではサポートされていません。
  • includeFilePattern:スキャンおよび取得の対象となるフォルダーとファイルを決定するために監視フォルダーで使用されるパターンです。例えば、この値が*の場合、input*に一致するすべてのファイルとフォルダーが取得されます。 これには、input1input2などの名前のファイルやフォルダーが含まれます。 デフォルト値は * です。この値は、すべてのファイルとフォルダーを示します。 また、パターンにワイルドカードパターンを追加して、ファイルパターンを指定することもできます。 監視フォルダーでは、*.**.pdfなどのワイルドカードパターンに対応するように正規表現が変更されます。 これらのワイルドカードパターンは、正規表現ではサポートされていません。 この値は必須です。
  • resultFolderName:保存した結果を保存するフォルダー。この場所は、絶対パスまたは相対ディレクトリパスにすることができます。 結果がこのフォルダーに表示されない場合は、失敗フォルダーを確認してください。読み取り専用ファイルは処理されず、失敗フォルダーに保存されます。デフォルト値は result/%Y/%M/%D/ です。これは、監視フォルダー内の結果フォルダーです。
  • preserveFolderName:正常にスキャンおよび取得された後にファイルが保存される場所。この場所は、絶対パス、相対パス、またはnullのディレクトリパスにすることができます。 デフォルト値は preserve/%Y/%M/%D/ です。
  • failureFolderName:失敗ファイルが保存されるフォルダー。この場所は、常に監視フォルダーからの相対パスで指定します。読み取り専用ファイルは処理されず、失敗フォルダーに保存されます。デフォルト値は failure/%Y/%M/%D/ です。
  • preserveOnFailure:サービスで操作の実行に失敗した場合に入力ファイルを保存する。デフォルト値は true です。
  • overwriteDuplicateFilename:trueに設定すると、結果フォルダーと保存用フォルダー内のファイルが上書きされます。falseに設定すると、名前に数値のインデックスサフィックスを持つファイルおよびフォルダーが使用されます。 デフォルト値は false です。

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

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

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

入力パラメーター名:入力パラメーターの名前。入力値の名前は、プロセスのWorkbenchで指定されます。 入力値がサービス操作(Workbenchで作成されたプロセスではないサービス)に属する場合、入力名はcomponent.xmlファイルで指定されます。 例えば、この節で紹介するプロセスの入力パラメーターの名前はInDocです。

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

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

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

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

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

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

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

出力パラメーター名:出力パラメーターの名前。プロセス出力値の名前は、Workbenchで指定されます。 出力値がサービス操作(Workbenchで作成されたプロセスではないサービス)に属する場合、出力名はcomponent.xmlファイルで指定されます。 例えば、この節で紹介するプロセスの出力パラメーターの名前はSecuredDocです。

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

  • サービスが単一のオブジェクト(単一のドキュメント)を返す場合、パターンは%F.pdfで、ソースの宛先はsourcefilename.pdfになります。 例えば、この節で紹介したプロセスは、1つのドキュメントを返します。 その結果、マッピングの種類を%F.pdf%Fは指定されたファイル名を使用することを意味します)と定義できます。 パターン%Eは、入力ドキュメントの拡張子を指定します。
  • サービスがリストを返す場合、パターンはResult\%F\で、ソースの宛先はResult\sourcefilename\source1 (output 1)とResult\sourcefilename\source2 (output 2)です。
  • サービスがマップを返す場合、パターンはResult\%F\で、ソースの宛先はResult\sourcefilename\file1 and 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. プロジェクトファイルを含めます。

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

  2. EndpointRegistry Clientオブジェクトを作成します。

    • 接続プロパティを含む ServiceClientFactory オブジェクトを作成します。
    • コンストラクターを使用してEndpointRegistryClientオブジェクトを渡し、ServiceClientFactoryオブジェクトを作成します。
  3. 監視フォルダーエンドポイントの属性を設定します。

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

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

    • 設定値の名前を指定するstring値。 url設定値を設定する場合は、urlを指定します。
    • 設定値の値を指定するstring値。 url設定値を設定する場合は、監視フォルダーの場所を指定します。
    メモ

    EncryptDocumentサービスに設定されたすべての設定値を確認するには、QuickStartにあるJavaコードの例を参照してください。Java APIを使用した監視フォルダーエンドポイントの追加

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

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

    • 入力パラメーターの名前を指定するstring値。 例えば、EncryptDocumentサービスの入力パラメーターの名前はInDocです。
    • 入力パラメーターのデータ型を指定するstring値。 例えば、InDoc入力パラメーターのデータ型はcom.adobe.idp.Documentです。
    • マッピングタイプを指定するstring値。 例えば、variableを指定できます。
    • マッピングタイプの値を指定するstring値。 例えば、*.pdfをファイルパターンとして指定できます。
    メモ

    定義する各入力パラメーター値に対してsetInputParameterMappingメソッドを呼び出します。 EncryptDocumentプロセスには1つの入力パラメーターしかないので、このメソッドを1回呼び出す必要があります。

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

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

    • 出力パラメーターの名前を指定するstring値。 例えば、EncryptDocumentサービスの出力パラメーターの名前はSecuredDocです。
    • 出力パラメーターのデータ型を指定するstring値。 例えば、SecuredDoc出力パラメーターのデータ型はcom.adobe.idp.Documentです。
    • マッピングタイプを指定するstring値。 例えば、%F.pdfを指定できます。
  7. 監視フォルダーエンドポイントを作成します。

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

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

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

関連トピック

手順の概要

クイックスタート:Java APIを使用した監視フォルダーエンドポイントの追加

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

接続プロパティの設定

監視フォルダー設定値定数ファイル

クイックスタート:Java APIを使用して監視フォルダーエンドポイントを追加すると、クイックスタートをコンパイルするためにJavaプロジェクトに含める必要がある定数ファイルが使用されます。 この定数ファイルは、監視フォルダーエンドポイントを追加する際に設定する必要がある設定値を表します。 次のJavaコードは、定数ファイルを表しています。

 /**
     * This class contains constants that can be used when setting Watched Folder
     * configuration values
     */

 public final class WatchedFolderEndpointConfigConstants {

         public static final String PROPERTY_FILEPROVIDER_URL = "url";
         public static final String PROPERTY_PROPERTY_ASYNCHRONOUS = "asynchronous";
         public static final String PROPERTY_CRON_EXPRESSION = "cronExpression";
         public static final String PROPERTY_PURGE_DURATION = "purgeDuration";
         public static final String PROPERTY_REPEAT_INTERVAL = "repeatInterval";
         public static final String PROPERTY_REPEAT_COUNT = "repeatCount";
         public static final String PROPERTY_THROTTLE = "throttleOn";
         public static final String PROPERTY_USERNAMER = "userName";
         public static final String PROPERTY_DOMAINNAME = "domainName";
         public static final String PROPERTY_FILEPROVIDER_BATCH_SIZE = "batchSize";
         public static final String PROPERTY_FILEPROVIDER_WAIT_TIME = "waitTime";
         public static final String PROPERTY_EXCLUDE_FILE_PATTERN = "excludeFilePattern";
         public static final String PROPERTY_INCLUDE_FILE_PATTERN = "excludeFilePattern";
         public static final String PROPERTY_FILEPROVIDER_RESULT_FOLDER_NAME =  "resultFolderName";
         public static final String PROPERTY_FILEPROVIDER_PRESERVE_FOLDER_NAME = "preserveFolderName";
         public static final String PROPERTY_FILEPROVIDER_FAILURE_FOLDER_NAME = "failureFolderName";
         public static final String PROPERTY_FILEPROVIDER_PRESERVE_ON_FAILURE = "preserveOnFailure";
         public static final String PROPERTY_FILEPROVIDER_OVERWRITE_DUPLICATE_FILENAME = "overwriteDuplicateFilename";
        }

電子メールエンドポイントの追加

AEM Forms Java APIを使用して、プログラムでEメールエンドポイントをサービスに追加できます。 Eメールエンドポイントを追加すると、1つ以上の添付ファイルを含むEメールメッセージを指定したEメールアカウントに送信できます。 次に、configureサービス操作が呼び出され、ファイルが操作されます。 指定した操作を実行すると、変更されたファイルが添付ファイルとして送信者に電子メールメッセージが送信されます。

プログラムによってEメールエンドポイントをサービスに追加する場合は、MyApplication\EncryptDocument​という短時間のみ有効なプロセスを考慮してください。 短時間のみ有効なプロセスについては、「AEM Formsプロセスについて」を参照してください。

ae_ae_encryptdocumentprocess

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

メモ

Webサービスを使用してEメールエンドポイントを追加することはできません。

手順の概要

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

  1. プロジェクトファイルを含めます。
  2. EndpointRegistryClientオブジェクトを作成します。
  3. 電子メールエンドポイントの属性を設定します。
  4. 設定値を指定します。
  5. 入力パラメーター値を定義します。
  6. 出力パラメーター値を定義します。
  7. Eメールエンドポイントを作成します。
  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クライアントオブジェクトの作成

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

電子メールエンドポイント属性の設定

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

  • コネクタ識別子の値:作成するエンドポイントのタイプを指定します。Eメールエンドポイントを作成するには、Emailを指定します。
  • 説明:エンドポイントの説明を指定します。
  • 名前:エンドポイントの名前を指定します。
  • サービス識別子の値:エンドポイントが属するサービスを指定します。例えば、この節で紹介するプロセスに電子メールエンドポイントを追加するには(Workbenchを使用してアクティブ化するとプロセスがサービスになります)、EncryptDocumentと指定します。
  • 操作名:エンドポイントを使用して呼び出される操作の名前を指定します。通常、Workbenchで作成されたプロセスから生成されたサービスのEメールエンドポイントを作成する場合、操作の名前はinvokeになります。

設定値の指定

プログラムで電子メールエンドポイントをサービスに追加する場合は、電子メールエンドポイントの設定値を指定する必要があります。 これらの設定値は、管理コンソールを使用してEメールエンドポイントを追加する場合、管理者が指定します。

メモ

監視対象の電子メールアカウントは、電子メールエンドポイントにのみ使用される特別なアカウントです。 このアカウントは、通常のユーザーの電子メールアカウントではありません。 通常のユーザーの電子メールアカウントは、電子メールプロバイダーが使用するアカウントとして設定しないでください。電子メールプロバイダーは、メッセージの処理が完了した後で、インボックスから電子メールメッセージを削除します。

プログラムで電子メールエンドポイントをサービスに追加する場合、次の設定値が設定されます。

  • cronExpression:Cron式を使用して電子メールをスケジュールする必要がある場合のCron式。
  • repeatCount:電子メールエンドポイントがフォルダーまたはディレクトリをスキャンする回数。-1 を指定すると、無限にスキャンされます。デフォルト値は -1 です。
  • repeatInterval:受信者が受信メールの確認に使用するスキャン速度(秒)。デフォルト値は 10 です。
  • startDelay:スケジューラーの開始後にスキャンを待機する時間。デフォルトの時間は0です。
  • batchSize:最適なパフォーマンスを得るために受信者が1回のスキャンで処理する電子メールメッセージの数。-1 を指定すると、すべての電子メールが処理されます。デフォルト値は 2 です。
  • userName:電子メールからターゲットサービスを呼び出す際に使用されるユーザー名。デフォルト値は SuperAdmin です。
  • domainName:必須の設定値。デフォルト値は DefaultDom です。
  • domainPattern:プロバイダーが受け入れる受信電子メールのドメインパターンを指定します。例えば、adobe.comを使用した場合、adobe.comからの電子メールのみが処理され、他のドメインからの電子メールは無視されます。
  • filePattern:プロバイダーが受け入れる受信ファイル添付パターンを指定します。これには、特定のファイル名拡張子(*.dat, *.xml)を持つファイル、特定の名前(データ)を持つファイル、名前と拡張子に複合式を持つファイル(*)が含まれます。[dD][aA]'port')と同じです。デフォルト値は * です。
  • recipientSuccessfulJob:ジョブの成功を示すメッセージの送信先の電子メールアドレス。デフォルトでは、ジョブの正常終了メッセージは常に送信者に送信されます。sender と入力すると、電子メールの結果は送信者に送信されます。最大 100 人の受信者を指定できます。追加の受信者をEメールアドレスで指定します。各受信者はコンマで区切ります。 このオプションをオフにするには、この値を空白のままにします。 場合によっては、プロセスをトリガーし、結果の電子メール通知を送信したくないことがあります。 デフォルト値は sender です。
  • recipientFailedJob:ジョブの失敗を示すメッセージの送信先の電子メールアドレス。デフォルトでは、失敗したジョブメッセージは常に送信者に送信されます。 sender と入力すると、電子メールの結果は送信者に送信されます。最大 100 人の受信者を指定できます。追加の受信者をEメールアドレスで指定します。各受信者はコンマで区切ります。 このオプションをオフにするには、この値を空白のままにします。 デフォルト値は sender です。
  • inboxHost:電子メールプロバイダーがスキャンするインボックスのホスト名またはIPアドレス。
  • inboxPort:電子メールサーバーが使用するポート。POP3 のデフォルト値は「110」で、IMAP のデフォルト値は「143」です。SSL が有効になっている場合は、POP3 のデフォルト値は「995」で、IMAP のデフォルト値は「993」です。
  • inboxProtocol:Eメールエンドポイントがインボックスをスキャンする際に使用するEメールプロトコルです。オプションはIMAPまたはPOP3です。 指定のプロトコルはインボックスホストメールサーバーでサポートされている必要があります。
  • inboxTimeOut:電子メールプロバイダーがインボックスの応答を待機する時間(秒)。デフォルト値は 60 です。
  • inboxUser:電子メールアカウントにログインするために必要なユーザー名です。電子メールサーバーと設定によっては、電子メールのユーザー名の部分のみを指定する場合と、完全な電子メールアドレスを指定する場合があります。
  • inboxPassword:インボックスユーザーのパスワードです。
  • inboxSSLEnabled:結果やエラーの通知メッセージを送信する際に、電子メールプロバイダーがSSLを使用するように強制するには、この値を設定します。IMAPまたはPOP3ホストがSSLをサポートしていることを確認します。
  • smtpHost:電子メールプロバイダーが結果およびエラーメッセージを送信するメールサーバーのホスト名。
  • smtpPort:SMTPポートのデフォルト値は25です。
  • smtpUser:電子メールプロバイダーが結果やエラーの電子メール通知を送信する際に使用するユーザーアカウント。
  • smtpPassword:SMTPアカウントのパスワードです。SMTP パスワードが不要なメールサーバーもあります。
  • charSet:Eメールプロバイダーが使用する文字セット。デフォルト値は UTF-8 です。
  • smtpSSLEnabled:結果やエラーの通知メッセージを送信する際に、電子メールプロバイダーがSSLを使用するように強制するには、この値を設定します。SMTPホストがSSLをサポートしていることを確認します。
  • failedJobFolder:SMTPメールサーバーが動作していない場合に結果を保存するディレクトリを指定します。
  • 非同期:「同期」に設定すると、すべての入力ドキュメントが処理され、1回の応答が返されます。asynchronousに設定すると、処理される入力ドキュメントごとに応答が送信されます。 例えば、このトピックで紹介するプロセス用に電子メールエンドポイントが作成され、セキュリティで保護されていない複数のPDFドキュメントを含む電子メールメッセージがエンドポイントのインボックスに送信されます。 すべてのPDFドキュメントがパスワードで暗号化され、エンドポイントが同期として設定されている場合は、セキュリティで保護されたすべてのPDFドキュメントが添付された単一の応答電子メールメッセージが送信されます。 エンドポイントが非同期として設定されている場合は、保護されたPDFドキュメントごとに個別の応答電子メールメッセージが送信されます。 各電子メールメッセージには、添付ファイルとして1つのPDFドキュメントが含まれます。 デフォルト値は「asynchronous」です。

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

Eメールエンドポイントを作成する場合は、入力パラメーターの値を定義する必要があります。 つまり、Eメールエンドポイントによって呼び出される操作に渡される入力値を記述する必要があります。 例えば、このトピックで紹介したプロセスを考えてみましょう。 InDocという名前の入力値が1つあり、データタイプはcom.adobe.idp.Documentです。 このプロセスのEメールエンドポイントを作成する場合(プロセスが有効化された後、サービスになる)、入力パラメーター値を定義する必要があります。

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

入力パラメーター名:入力パラメーターの名前。入力値の名前は、プロセスのWorkbenchで指定されます。 入力値がサービス操作(Workbenchで作成されたプロセスではないFormsサービス)に属する場合、入力名はcomponent.xmlファイルで指定されます。 例えば、この節で紹介するプロセスの入力パラメーターの名前はInDocです。

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

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

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

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

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

Eメールエンドポイントを作成する場合、出力パラメーターの値を定義する必要があります。 つまり、Eメールエンドポイントによって呼び出されるサービスによって返される出力値を記述する必要があります。 例えば、このトピックで紹介したプロセスを考えてみましょう。 SecuredDocという出力値があり、データタイプはcom.adobe.idp.Documentです。 このプロセスのEメールエンドポイントを作成する場合(プロセスが有効化された後、サービスになる)、出力パラメーターの値を定義する必要があります。

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

出力パラメーター名:出力パラメーターの名前。プロセス出力値の名前は、Workbenchで指定されます。 出力値がサービス操作(Workbenchで作成されたプロセスではないサービス)に属する場合、出力名はcomponent.xmlファイルで指定されます。 例えば、この節で紹介するプロセスの出力パラメーターの名前はSecuredDocです。

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

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

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

Eメールエンドポイントの作成

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

エンドポイントの有効化

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

関連トピック

Java APIを使用した電子メールエンドポイントの追加

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

接続プロパティの設定

Java APIを使用した電子メールエンドポイントの追加

Java APIを使用して電子メールエンドポイントを追加します。

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

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

  2. EndpointRegistry Clientオブジェクトを作成します。

    • 接続プロパティを含む ServiceClientFactory オブジェクトを作成します。
    • コンストラクターを使用してEndpointRegistryClientオブジェクトを渡し、ServiceClientFactoryオブジェクトを作成します。
  3. 電子メールエンドポイントの属性を設定します。

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

    Eメールエンドポイントに設定する設定値ごとに、CreateEndpointInfoオブジェクトのsetConfigParameterAsTextメソッドを呼び出す必要があります。 例えば、smtpHost設定値を設定するには、CreateEndpointInfoオブジェクトのsetConfigParameterAsTextメソッドを呼び出して、次の値を渡します。

    • 設定値の名前を指定するstring値。 smtpHost設定値を設定する場合は、smtpHostを指定します。
    • 設定値の値を指定するstring値。 smtpHost設定値を設定する場合は、SMTPサーバーの名前を指定する文字列値を指定します。
    メモ

    この節で紹介するEncryptDocumentサービスの設定値をすべて確認するには、QuickStartにあるJavaコードの例を参照してください。Java APIを使用した電子メールエンドポイントの追加。

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

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

    • 入力パラメーターの名前を指定するstring値。 例えば、EncryptDocumentサービスの入力パラメーターの名前はInDocです。
    • 入力パラメーターのデータ型を指定するstring値。 例えば、InDoc入力パラメーターのデータ型はcom.adobe.idp.Documentです。
    • マッピングタイプを指定するstring値。 例えば、variableを指定できます。
    • マッピングタイプの値を指定するstring値。 例えば、*.pdfをファイルパターンとして指定できます。
    メモ

    定義する各入力パラメーター値に対してsetInputParameterMappingメソッドを呼び出します。 EncryptDocumentプロセスには1つの入力パラメーターしかないので、このメソッドを1回呼び出す必要があります。

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

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

    • 出力パラメーターの名前を指定するstring値。 例えば、EncryptDocumentサービスの出力パラメーターの名前はSecuredDocです。
    • 出力パラメーターのデータ型を指定するstring値。 例えば、SecuredDoc出力パラメーターのデータ型はcom.adobe.idp.Documentです。
    • マッピングタイプを指定するstring値。 例えば、%F.pdfを指定できます。
  7. Eメールエンドポイントを作成します。

    EndpointRegistryClientオブジェクトのcreateEndpointメソッドを呼び出してCreateEndpointInfoオブジェクトを渡すことで、エンドポイントを作成します。 このメソッドは、電子メールエンドポイントを表すEndpointオブジェクトを返します。

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

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

関連トピック

手順の概要

クイックスタート:Java APIを使用した監視フォルダーエンドポイントの追加

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

接続プロパティの設定

電子メール構成値定数ファイル

クイックスタート:Java APIを使用して電子メールエンドポイントを追加する場合、クイックスタートをコンパイルするためにJavaプロジェクトに含める必要がある定数ファイルを使用します。 この定数ファイルは、電子メールエンドポイントを追加する際に設定する必要がある設定値を表します。 次のJavaコードは、定数ファイルを表しています。

 /**
     * This class contains constants that can be used when setting email endpoint
     * configuration values
     */
 public class EmailEndpointConfigConstants {

     public static final String PROPERTY_EMAILPROVIDER_CRON_EXPRESSION = "cronExpression";
     public static final String PROPERTY_EMAILPROVIDER_REPREAT_COUNT = "repeatCount";
     public static final String PROPERTY_EMAILPROVIDER_REPREAT_INTERVAL = "repeatInterval";
     public static final String PROPERTY_EMAILPROVIDER_START_DELAY = "startDelay";
     public static final String PROPERTY_EMAILPROVIDER_BATCH_SIZE = "batchSize";
     public static final String PROPERTY_EMAILPROVIDER_USERNAME = "userName";
     public static final String PROPERTY_EMAILPROVIDER_DOMAINNAME = "domainName";
     public static final String PROPERTY_EMAILPROVIDER_DOMAINPATTERN = "domainPattern";
     public static final String PROPERTY_EMAILPROVIDER_FILEPATTERN = "filePattern";
     public static final String PROPERTY_EMAILPROVIDER_RECIPIENT_SUCCESSFUL_JOB = "recipientSuccessfulJob";
     public static final String PROPERTY_EMAILPROVIDER_RECIPIENT_FAILED_JOB = "recipientFailedJob";
     public static final String PROPERTY_EMAILPROVIDER_INBOX_HOST = "inboxHost";
     public static final String PROPERTY_EMAILPROVIDER_INBOX_PORT = "inboxPort";
     public static final String PROPERTY_EMAILPROVIDER_PROTOCOL = "inboxProtocol";
     public static final String PROPERTY_EMAILPROVIDER_INBOX_TIMEOUT = "inboxTimeOut";
     public static final String PROPERTY_EMAILPROVIDER_INBOX_USER = "inboxUser";
     public static final String PROPERTY_EMAILPROVIDER_INBOX_PASSWORD = "inboxPassword";
     public static final String PROPERTY_EMAILPROVIDER_INBOX_SSL = "inboxSSLEnabled";
     public static final String PROPERTY_EMAILPROVIDER_SMTP_HOST = "smtpHost";
     public static final String PROPERTY_EMAILPROVIDER_SMTP_PORT = "smtpPort";
     public static final String PROPERTY_EMAILPROVIDER_SMTP_USER = "smtpUser";
     public static final String PROPERTY_EMAILPROVIDER_SMTP_PASSWORD = "smtpPassword";
     public static final String PROPERTY_EMAILPROVIDER_CHARSET = "charSet";
     public static final String PROPERTY_EMAILPROVIDER_SMTP_SSL = "smtpSSLEnabled";
     public static final String PROPERTY_EMAILPROVIDER_FAILED_FOLDER = "failedJobFolder";
     public static final String PROPERTY_EMAILPROVIDER_ASYNCHRONOUS = "asynchronous";
 }

リモートエンドポイントの追加

メモ

LiveCycle RemotingAPIは、JEE上のAEM formsで非推奨(廃止予定)となりました。

AEM Forms Java APIを使用して、プログラムによってリモートエンドポイントをサービスに追加できます。 Remotingエンドポイントを追加すると、Flexアプリケーションでリモート処理を使用してサービスを呼び出すことができます。 (「(AEM formsでは非推奨)AEM Forms Remotingを使用したAEM Formsの呼び出し」を参照)。

リモートエンドポイントをプログラムでサービスに追加する目的で、EncryptDocument​という短時間のみ有効なプロセスを考慮します。

ar_ar_encryptdocumentprocess

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

この節では、EncryptDocumentという名前のサービスにリモートエンドポイントを追加する方法を示します。

メモ

Webサービスを使用してリモートエンドポイントを追加することはできません。

手順の概要

エンドポイントをサービスから削除するには、次のタスクを実行します。

  1. プロジェクトファイルを含めます。
  2. EndpointRegistryClientオブジェクトを作成します。
  3. リモートエンドポイントの属性を設定します。
  4. リモートエンドポイントを作成します。
  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ファイルの場所について詳しくは、「AEM Forms Javaライブラリファイルを含める」を参照してください。

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

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

リモートエンドポイント属性の設定

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

  • コネクタ識別子の値:作成するエンドポイントのタイプを指定します。リモートエンドポイントを作成するには、Remotingを指定します。
  • 説明:エンドポイントの説明を指定します。
  • 名前:エンドポイントの名前を指定します。
  • サービス識別子の値:エンドポイントが属するサービスを指定します。例えば、この節で紹介するプロセスにリモートエンドポイントを追加するには(Workbench内でアクティブ化するとプロセスがサービスになります)、EncryptDocumentと指定します。
  • 操作名:エンドポイントを使用して呼び出される操作の名前を指定します。リモートエンドポイントを作成する場合は、ワイルドカード文字(*)を指定します。

リモートエンドポイントの作成

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

エンドポイントの有効化

新しいエンドポイントを作成したら、有効にする必要があります。 リモートエンドポイントが有効な場合、Flexクライアントがサービスを呼び出すことができます。

関連トピック

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

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

接続プロパティの設定

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

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

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

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

  2. EndpointRegistry Clientオブジェクトを作成します。

    • 接続プロパティを含む ServiceClientFactory オブジェクトを作成します。
    • コンストラクターを使用してEndpointRegistryClientオブジェクトを渡し、ServiceClientFactoryオブジェクトを作成します。
  3. リモートエンドポイントの属性を設定します。

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

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

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

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

関連トピック

手順の概要

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

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

接続プロパティの設定

TaskManagerエンドポイントの追加

AEM Forms Java APIを使用して、プログラムによってTaskManagerエンドポイントをサービスに追加できます。 TaskManagerエンドポイントをサービスに追加することで、Workspaceユーザーがサービスを呼び出せるようにします。 つまり、Workspaceで作業しているユーザーは、対応するTaskManagerエンドポイントを持つプロセスを呼び出すことができます。

メモ

Webサービスを使用してTaskManagerエンドポイントを追加することはできません。

手順の概要

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

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

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

必要なファイルを開発プロジェクトに含めます。 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クライアントオブジェクトの作成

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

エンドポイントのカテゴリの作成

カテゴリは、Workspace内のサービスを整理するために使用されます。 つまり、Workspaceユーザーは、Workspace内のカテゴリを選択することで、TaskManagerエンドポイントを持つサービスを呼び出すことができます。 TaskManagerエンドポイントを作成する場合は、既存のカテゴリを参照するか、新しいカテゴリをプログラムで作成できます。

メモ

このセクションでは、TaskManagerエンドポイントをサービスに追加する際に、新しいカテゴリを作成します。

TaskManagerエンドポイント属性の設定

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

  • コネクタ識別子:作成するエンドポイントのタイプを指定します。TaskManagerエンドポイントを作成するには、TaskManagerConnectorを指定します。
  • 説明:エンドポイントの説明を指定します。
  • 名前:エンドポイントの名前を指定します。
  • サービス識別子:エンドポイントが属するサービスを指定します。
  • カテゴリ:TaskManagerエンドポイントに関連付けられるカテゴリ識別子の値を指定します。
  • 操作名:通常、Workbenchで作成されたプロセスから発生するサービスのTaskManagerエンドポイントを作成する場合、操作の名前はになりま invokeす。

TaskManagerエンドポイントの作成

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

エンドポイントの有効化

新しいエンドポイントを作成したら、有効にする必要があります。 エンドポイントが有効な場合は、Workspace内からサービスを呼び出すために使用できます。 エンドポイントを有効にすると、管理コンソール内で表示できます。

関連トピック

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

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

接続プロパティの設定

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

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

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

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

  2. EndpointRegistry Clientオブジェクトを作成します。

    • 接続プロパティを含む ServiceClientFactory オブジェクトを作成します。
    • コンストラクターを使用してEndpointRegistryClientオブジェクトを渡し、ServiceClientFactoryオブジェクトを作成します。
  3. エンドポイントのカテゴリを作成します。

    • コンストラクターを使用し、次の値を渡してCreateEndpointCategoryInfoオブジェクトを作成します。

      • カテゴリの識別子の値を指定するstring値
      • カテゴリの説明を指定するstring値
    • EndpointRegistryClientオブジェクトのcreateEndpointCategoryメソッドを呼び出してCreateEndpointCategoryInfoオブジェクトを渡すことで、カテゴリを作成します。 このメソッドは、新しいカテゴリを表すEndpointCategoryオブジェクトを返します。

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

    • コンストラクタを使用して CreateEndpointInfo オブジェクトを作成します。
    • CreateEndpointInfoオブジェクトのsetConnectorIdメソッドを呼び出し、文字列値TaskManagerConnectorを渡すことによって、コネクタ識別子の値を指定します。
    • CreateEndpointInfoオブジェクトのsetDescriptionメソッドを呼び出し、エンドポイントを表す文字列値を渡すことで、エンドポイントの説明を指定します。
    • CreateEndpointInfoオブジェクトのsetNameメソッドを呼び出し、名前を指定する文字列値を渡すことで、エンドポイントの名前を指定します。
    • CreateEndpointInfoオブジェクトのsetServiceIdメソッドを呼び出し、サービス名を指定する文字列値を渡すことで、エンドポイントが属するサービスを指定します。
    • CreateEndpointInfoオブジェクトのsetCategoryIdメソッドを呼び出し、カテゴリ識別子の値を指定する文字列値を渡すことで、エンドポイントが属するカテゴリを指定します。 EndpointCategoryオブジェクトのgetIdメソッドを呼び出して、このカテゴリの識別子の値を取得できます。
    • CreateEndpointInfoオブジェクトのsetOperationNameメソッドを呼び出し、操作名を指定する文字列値を渡すことで、呼び出される操作を指定します。 通常、Workbenchで作成されたプロセスから発生するサービスのTaskManagerエンドポイントを作成する場合、操作の名前はinvokeになります。
  5. TaskManagerエンドポイントを作成します。

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

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

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

関連トピック

手順の概要

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

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

接続プロパティの設定

エンドポイントの変更

AEM Forms Java APIを使用して、既存のエンドポイントをプログラムで変更できます。 エンドポイントを変更すると、エンドポイントの動作を変更できます。 例えば、監視フォルダーとして使用されるフォルダーを指定する監視フォルダーエンドポイントがあるとします。 監視フォルダーエンドポイントに属する設定値をプログラムで変更することにより、別のフォルダーが監視フォルダーとして機能するようになります。 監視フォルダーエンドポイントに属する設定値について詳しくは、「監視フォルダーエンドポイントの追加」を参照してください。

この節では、エンドポイントを変更する方法を示すために、監視フォルダーとして動作するフォルダーを変更して監視フォルダーエンドポイントを変更します。

メモ

Webサービスを使用してエンドポイントを変更することはできません。

手順の概要

エンドポイントを変更するには、次のタスクを実行します。

  1. プロジェクトファイルを含めます。
  2. EndpointRegistryClientオブジェクトを作成します。
  3. エンドポイントを取得します。
  4. 新しい設定値を指定します。

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

必要なファイルを開発プロジェクトに含めます。 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クライアントオブジェクトの作成

プログラムによってエンドポイントを変更するには、EndpointRegistryClientオブジェクトを作成する必要があります。

変更するエンドポイントの取得

エンドポイントを変更する前に、取得する必要があります。 エンドポイントを取得するには、エンドポイントにアクセスできるユーザーとして接続する必要があります。 管理者として接続することをお勧めします。 (接続プロパティの設定を参照)。

エンドポイントのリストを取得することで、エンドポイントを取得できます。 その後、リストを繰り返し処理して、削除する特定のエンドポイントを検索できます。 例えば、エンドポイントに対応するサービスとエンドポイントのタイプを特定することで、エンドポイントを特定できます。 エンドポイントを見つけたら、変更できます。

新しい設定値の指定

エンドポイントを変更する場合は、新しい設定値を指定します。 例えば、監視フォルダーエンドポイントを変更するには、変更するエンドポイントだけでなく、すべての監視フォルダーエンドポイントの設定値をリセットします。 監視フォルダーエンドポイントに属する設定値について詳しくは、「監視フォルダーエンドポイントの追加」を参照してください。

メモ

電子メールエンドポイントに属する設定値について詳しくは、電子メールエンドポイントの追加を参照してください。

メモ

エンドポイントによって呼び出されたサービスは変更できません。 このサービスを変更しようとすると、例外が発生します。 特定のエンドポイントに関連付けられたサービスを変更するには、エンドポイントを削除し、新しく作成します。 (エンドポイントの削除を参照)。

関連トピック

Java APIを使用したエンドポイントの変更

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

接続プロパティの設定

Java APIを使用したエンドポイントの変更

Java APIを使用してエンドポイントを変更します。

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

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

  2. EndpointRegistry Clientオブジェクトを作成します。

    • 接続プロパティを含む ServiceClientFactory オブジェクトを作成します。
    • コンストラクターを使用してEndpointRegistryClientオブジェクトを渡し、ServiceClientFactoryオブジェクトを作成します。
  3. 変更するエンドポイントを取得します。

    • EndpointRegistryClientオブジェクトのgetEndpointsメソッドを呼び出し、フィルターとして機能するPagingFilterオブジェクトを渡すことで、現在のユーザー(接続プロパティで指定)がアクセスできるすべてのエンドポイントのリストを取得します。 (PagingFilter)null値を渡すと、すべてのエンドポイントを返すことができます。 このメソッドは、 java.util.Listオブジェクトを返します。各要素はEndpointオブジェクトです。 PagingFilterオブジェクトについて詳しくは、『AEM Forms APIリファレンス』を参照してください。
    • java.util.Listオブジェクトを繰り返し処理して、エンドポイントがあるかどうかを判断します。 エンドポイントが存在する場合、各要素はEndPointインスタンスになります。
    • EndPointオブジェクトのgetServiceIdメソッドを呼び出して、エンドポイントに対応するサービスを判断します。 このメソッドは、サービス名を指定するstring値を返します。
    • EndPointオブジェクトのgetConnectorIdメソッドを呼び出して、エンドポイントのタイプを判断します。 このメソッドは、エンドポイントのタイプを指定するstring値を返します。 例えば、エンドポイントが監視フォルダーエンドポイントの場合、このメソッドはWatchedFolderを返します。
  4. 新しい設定値を指定します。

    • コンストラクターを呼び出して、ModifyEndpointInfoオブジェクトを作成します。

    • 設定する設定値ごとに、ModifyEndpointInfoオブジェクトのsetConfigParameterAsTextメソッドを呼び出します。 例えば、URL設定値を設定するには、ModifyEndpointInfoオブジェクトのsetConfigParameterAsTextメソッドを呼び出して、次の値を渡します。

      • 設定値の名前を指定するstring値。 例えば、url設定値を設定するには、urlと指定します。
      • 設定値の値を指定するstring値。 url設定値の値を定義するには、監視フォルダーの場所を指定します。
    • EndpointRegistryClientオブジェクトのmodifyEndpointメソッドを呼び出して、ModifyEndpointInfoオブジェクトを渡します。

関連トピック

手順の概要

クイックスタート:Java APIを使用したエンドポイントの変更

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

接続プロパティの設定

エンドポイントの削除

AEM Forms Java APIを使用して、プログラムでエンドポイントをサービスから削除できます。 エンドポイントを削除すると、そのエンドポイントが有効になっている呼び出しメソッドを使用してサービスを呼び出すことはできません。 例えば、サービスからSOAPエンドポイントを削除する場合、SOAPモードを使用してサービスを呼び出すことはできません。

この節では、サービスからエンドポイントを削除する方法を示すために、EncryptDocument​というサービスからEJBエンドポイントを削除します。

メモ

Webサービスを使用してエンドポイントを削除することはできません。

手順の概要

エンドポイントをサービスから削除するには、次のタスクを実行します。

  1. プロジェクトファイルを含めます。
  2. EndpointRegistryClientオブジェクトを作成します。
  3. エンドポイントを取得します。
  4. エンドポイントを削除します。

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

必要なファイルを開発プロジェクトに含めます。 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クライアントオブジェクトの作成

プログラムによってエンドポイントを削除するには、EndpointRegistryClientオブジェクトを作成する必要があります。

削除するエンドポイントの取得

エンドポイントを削除する前に、取得する必要があります。 エンドポイントを取得するには、エンドポイントにアクセスできるユーザーとして接続する必要があります。 管理者として接続することをお勧めします。 (接続プロパティの設定を参照)。

エンドポイントのリストを取得することで、エンドポイントを取得できます。 その後、リストを繰り返し処理して、削除する特定のエンドポイントを検索できます。 例えば、エンドポイントに対応するサービスとエンドポイントのタイプを特定することで、エンドポイントを特定できます。 エンドポイントを見つけたら、削除できます。

エンドポイントの削除

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

関連トピック

Java APIを使用したエンドポイントの削除

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

接続プロパティの設定

Java APIを使用したエンドポイントの削除

Java APIを使用してエンドポイントを削除します。

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

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

  2. EndpointRegistry Clientオブジェクトを作成します。

    • 接続プロパティを含む ServiceClientFactory オブジェクトを作成します。
    • コンストラクターを使用してEndpointRegistryClientオブジェクトを渡し、ServiceClientFactoryオブジェクトを作成します。
  3. 削除するエンドポイントを取得します。

    • EndpointRegistryClientオブジェクトのgetEndpointsメソッドを呼び出し、フィルターとして機能するPagingFilterオブジェクトを渡すことで、現在のユーザー(接続プロパティで指定)がアクセスできるすべてのエンドポイントのリストを取得します。 (PagingFilter)nullを渡すと、すべてのエンドポイントが返されます。 このメソッドは、 java.util.Listオブジェクトを返します。各要素はEndpointオブジェクトです。
    • java.util.Listオブジェクトを繰り返し処理して、エンドポイントがあるかどうかを判断します。 エンドポイントが存在する場合、各要素はEndPointインスタンスになります。
    • EndPointオブジェクトのgetServiceIdメソッドを呼び出して、エンドポイントに対応するサービスを判断します。 このメソッドは、サービス名を指定するstring値を返します。
    • EndPointオブジェクトのgetConnectorIdメソッドを呼び出して、エンドポイントのタイプを判断します。 このメソッドは、エンドポイントのタイプを指定するstring値を返します。 例えば、エンドポイントがEJBエンドポイントの場合、このメソッドはEJBを返します。
  4. エンドポイントを削除します。

    EndpointRegistryClientオブジェクトのremoveメソッドを呼び出し、削除するエンドポイントを表すEndPointオブジェクトを渡すことで、エンドポイントを削除します。

関連トピック

手順の概要

クイックスタート:Java APIを使用したエンドポイントの削除

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

接続プロパティの設定

エンドポイントコネクタ情報を取得しています

AEM Forms APIを使用して、エンドポイントコネクタに関する情報をプログラムで取得できます。 コネクタは、様々な呼び出しメソッドを使用してエンドポイントからサービスを呼び出すことを可能にします。 例えば、監視フォルダーコネクタを使用すると、エンドポイントで監視フォルダーを使用してサービスを呼び出すことができます。 プログラムによってエンドポイントコネクタに関する情報を取得することで、必要な設定値やオプションの設定値など、コネクタに関連付けられた設定値を取得できます。

この節では、エンドポイントコネクタに関する情報を取得する方法を示すために、監視フォルダーコネクタに関する情報を取得します。 (監視フォルダーエンドポイントの追加を参照)。

メモ

Webサービスを使用してエンドポイントに関する情報を取得することはできません。

メモ

このトピックでは、ConnectorRegistryClient APIを使用して、エンドポイントコネクタに関する情報を取得します。 (『AEM Forms APIリファレンス🔗』を参照)。

手順の概要

エンドポイントコネクタ情報を取得するには、次のタスクを実行します。

  1. プロジェクトファイルを含めます。
  2. ConnectorRegistryClientオブジェクトを作成します。
  3. コネクタタイプを指定します。
  4. 設定値を取得します。

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

必要なファイルを開発プロジェクトに含めます。 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にデプロイされている場合に必要)

AEM FormsがJBoss以外のサポート対象のJ2EEアプリケーションサーバーにデプロイされている場合は、adobe-utilities.jarとjbossall-client.jarを、AEM FormsがデプロイされているJ2EEアプリケーションサーバーに固有のJARファイルに置き換えます。 すべてのAEM Forms JARファイルの場所について詳しくは、「AEM Forms Javaライブラリファイルを含める」を参照してください。

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

プログラムによってエンドポイントコネクタ情報を取得するには、ConnectorRegistryClientオブジェクトを作成します。

コネクタタイプの指定

情報を取得するコネクタのタイプを指定します。 次のタイプのコネクタが存在します。

  • EJB:クライアントアプリケーションがEJBモードを使用してサービスを呼び出せるようにします。
  • SOAP:クライアントアプリケーションがSOAPモードを使用してサービスを呼び出せるようにします。
  • 監視フォルダー:監視フォルダーがサービスを呼び出せるようにします。
  • 電子メール:電子メールメッセージでサービスを呼び出せるようにします。
  • リモート処理:Flexクライアントアプリケーションからサービスを呼び出せるようにします。
  • TaskManagerConnector:WorkspaceユーザーがWorkspace内からサービスを呼び出せるようにします。

設定値の取得

コネクタタイプを指定したら、サポートされている設定値など、コネクタに関する情報を取得できます。 例えば、任意のコネクタの場合、必須の設定値とオプションの設定値を決定できます。

関連トピック

Java APIを使用したエンドポイントコネクタ情報の取得

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

接続プロパティの設定

Java APIを使用してエンドポイントコネクタ情報を取得する

Java APIを使用してエンドポイントコネクタ情報を取得します。

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

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

  2. ConnectorRegistry Clientオブジェクトを作成します。

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

    ConnectorRegistryClientオブジェクトのgetEndpointDefinitionメソッドを呼び出し、コネクタの種類を指定する文字列値を渡すことで、コネクタの種類を指定します。 例えば、監視フォルダーのコネクタタイプを指定するには、文字列値WatchedFolderを渡します。 このメソッドは、コネクタの種類に対応するEndpointオブジェクトを返します。

  4. 設定値を取得します。

    • EndpointオブジェクトのgetConfigParametersメソッドを呼び出して、このエンドポイント内に関連付けられている設定値を取得します。 このメソッドは、ConfigParameterオブジェクトの配列を返します。
    • 配列内の各要素を取得して、各設定値に関する情報を取得します。 各要素はConfigParameterオブジェクトです。 例えば、ConfigParameterオブジェクトのisRequiredメソッドを呼び出すことで、設定値が必須かオプションかを判断できます。 設定値が必要な場合、このメソッドはtrueを返します。

関連トピック

手順の概要

クイックスタート:Java APIを使用したエンドポイントコネクタ情報の取得

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

接続プロパティの設定

このページ