このドキュメントのサンプルと例は、JEE 環境の AEM Forms のみを対象としています。
Endpoint Registry サービスについて
Endpoint Registry サービスは、エンドポイントをプログラムで管理する機能を提供します。例えば、次の種類のエンドポイントをサービスに追加できます。
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 エンドポイントは、AEM Forms Java API を使用して、プログラムによってサービスに追加できます。EJB エンドポイントをサービスに追加すると、クライアントアプリケーションで EJB モードを使用してサービスを呼び出すことができます。つまり、AEM Forms を呼び出すために必要な接続プロパティを設定する場合は、EJB モードを選択できます(接続プロパティの設定を参照)。
web サービスを使用して EJB エンドポイントを追加することはできません。
通常、EJB エンドポイントはデフォルトでサービスに追加されますが、EJB エンドポイントは、プログラムでデプロイされたプロセスや、EJB エンドポイントが削除され、再度追加される必要があるプロセスに追加できます。
EJB エンドポイントをサービスに追加するには、次のタスクを実行します。
EndpointRegistry Client
オブジェクトを作成します。プロジェクトファイルを含める
開発プロジェクトに必要なファイルを含めます。次の JAR ファイルをプロジェクトのクラスパスに追加する必要があります。
これらの JAR ファイルの場所については、AEM Forms Java ライブラリファイルを含めるを参照してください。
EndpointRegistry Client オブジェクトを作成する
EJB エンドポイントをプログラムで追加する前に、 EndpointRegistryClient
オブジェクトを作成する必要があります。
EJB エンドポイント属性を設定する
サービスの EJB エンドポイントを作成するには、次の値を指定します。
EJB
を指定します。*
)を指定します。ただし、すべてのサービス操作を呼び出すのではなく、特定の操作を指定する場合は、ワイルドカード文字(*
)を使用するのではなく、操作の名前を指定します。EJB エンドポイントを作成する
EJB エンドポイント属性を設定した後、サービス用の EJB エンドポイントを作成できます。
エンドポイントを有効にする
エンドポイントを作成したら、そのエンドポイントを有効にする必要があります。 エンドポイントを有効にした後は、エンドポイントを使用してサービスを呼び出すことができます。エンドポイントを有効にすると、管理コンソール内で表示できます。
関連トピック
Java API を使用して EJB エンドポイントを追加します。
プロジェクトファイルを含めます。
Java プロジェクトのクラスパスに、adobe-livecycle-client.jar などのクライアント JAR ファイルを含めます。 (
EndpointRegistry クライアントオブジェクトを作成します。
ServiceClientFactory
オブジェクトを作成します。ServiceClientFactory
オブジェクトを渡すことによって、EndpointRegistryClient
オブジェクトを作成します。EJB エンドポイント属性を設定します。
CreateEndpointInfo
オブジェクトを作成します。CreateEndpointInfo
オブジェクトの setConnectorId
メソッドと文字列値を渡す EJB
.CreateEndpointInfo
オブジェクトの setDescription
メソッドを使用してエンドポイントを表す string 値を渡す方法を示します。CreateEndpointInfo
オブジェクトの setName
メソッドを使用して、名前を指定する string 値を渡す。CreateEndpointInfo
オブジェクトの setServiceId
メソッドを使用し、サービス名を指定する string 値を渡す。CreateEndpointInfo
オブジェクトの setOperationName
メソッドを使用して、操作名を指定する string 値を渡します。 SOAP および EJB エンドポイントの場合は、ワイルドカード文字(*
)を指定します。これは、すべての操作を示します。EJB エンドポイントを作成します。
を呼び出してエンドポイントを作成する EndpointRegistryClient
オブジェクトの createEndpoint
メソッドおよび CreateEndpointInfo
オブジェクト。 このメソッドは、新しい EJB エンドポイントを表す Endpoint
オブジェクトを返します。
エンドポイントを有効にします。
を呼び出してエンドポイントを有効にする EndpointRegistryClient
オブジェクトの enable メソッドおよび Endpoint
が返したオブジェクト createEndpoint
メソッド。
関連情報
クイックスタート:Java API を使用した EJB エンドポイントの追加
SOAP エンドポイントは、AEM Forms Java API を使用して、プログラムによってサービスに追加できます。SOAP エンドポイントを追加すると、クライアントアプリケーションで SOAP モードを使用してサービスを呼び出すことができます。つまり、AEM Forms を呼び出すために必要な接続プロパティを設定する場合、SOAP モードを選択できます。
Web サービスを使用して SOAP エンドポイントを追加することはできません。
通常、SOAP エンドポイントはデフォルトでサービスに追加されますが、SOAP エンドポイントは、プログラムでデプロイされたプロセスや、SOAP エンドポイントが削除され、再度追加される必要があるプロセスに追加できます。
SOAP エンドポイントをサービスに追加するには、次のタスクを実行します。
EndpointRegistryClient
オブジェクトを作成します。プロジェクトファイルを含める
必要なファイルを開発プロジェクトに含めます。Java を使用してクライアントアプリケーションを作成する場合は、必要な JAR ファイルを含めます。Web サービスを使用している場合は、必ずプロキシファイルを含めてください。
次の JAR ファイルをプロジェクトのクラスパスに追加する必要があります。
これらの JAR ファイルは、SOAP エンドポイントを作成するために必要です。ただし、SOAP エンドポイントを使用してサービスを呼び出す場合は、追加の JAR ファイルが必要です。AEM Forms JAR ファイルについて詳しくは、AEM Forms Java ライブラリファイルを含めるを参照してください。
EndpointRegistry クライアントオブジェクトの作成
プログラムによって SOAP エンドポイントをサービスに追加するには、 EndpointRegistryClient
オブジェクトを作成する必要があります。
SOAP エンドポイント属性を設定する
SOAP エンドポイントをサービスに追加するには、次の値を指定します。
SOAP
を指定します。*
)を指定します。ただし、すべてのサービス操作を呼び出すのではなく、特定の操作を指定する場合は、ワイルドカード文字(*
)を使用するのではなく、操作の名前を指定します。SOAP エンドポイントを作成する
SOAP エンドポイント属性を設定した後、SOAP エンドポイントを作成できます。
エンドポイントを有効にする
エンドポイントを作成したら、そのエンドポイントを有効にする必要があります。 エンドポイントが有効であれば、サービスの呼び出しに使用することができます。エンドポイントを有効にすると、管理コンソール内で表示できます。
関連トピック
Java API を使用した SOAP エンドポイントの追加
Java API を使用して、SOAP エンドポイントをサービスに追加します。
プロジェクトファイルを含めます。
Java プロジェクトのクラスパスに、adobe-livecycle-client.jar などのクライアント JAR ファイルを含めます。
EndpointRegistry クライアントオブジェクトを作成します。
ServiceClientFactory
オブジェクトを作成します。ServiceClientFactory
オブジェクトを渡すことによって、EndpointRegistryClient
オブジェクトを作成します。SOAP エンドポイント属性を設定します。
CreateEndpointInfo
オブジェクトを作成します。CreateEndpointInfo
オブジェクトの setConnectorId
メソッドと文字列値を渡す SOAP
.CreateEndpointInfo
オブジェクトの setDescription
メソッドを使用してエンドポイントを表す string 値を渡す方法を示します。CreateEndpointInfo
オブジェクトの setName
メソッドを使用して、名前を指定する string 値を渡す。CreateEndpointInfo
オブジェクトの setServiceId
メソッドを使用し、サービス名を指定する string 値を渡す。CreateEndpointInfo
オブジェクトの setOperationName
メソッドを使用して、操作名を指定する string 値を渡す。 SOAP および EJB エンドポイントの場合は、ワイルドカード文字(*
)を指定します。これは、すべての操作を示します。SOAP エンドポイントを作成します。
を呼び出してエンドポイントを作成する EndpointRegistryClient
オブジェクトの createEndpoint
メソッドおよび CreateEndpointInfo
オブジェクト。 このメソッドは、新しい SOAP エンドポイントを表す Endpoint
オブジェクトを返します。
エンドポイントを有効にします。
を呼び出してエンドポイントを有効にする EndpointRegistryClient
オブジェクトの enable メソッドを参照し、 Endpoint
が返したオブジェクト createEndpoint
メソッド。
関連情報
クイックスタート:Java API を使用した SOAP エンドポイントの追加
AEM Forms Java API を使用して、プログラムによって監視フォルダーエンドポイントをサービスに追加できます。監視フォルダーエンドポイントを追加すると、ユーザーはフォルダーにファイル (PDF ファイルなど ) を配置できます。ファイルがフォルダーに配置されると、設定済みのサービスが呼び出され、ファイルを操作します。サービスが指定の操作を実行した後に、変更されたファイルが指定の出力フォルダーに保存されます。監視フォルダーは、毎週月曜日、水曜日、金曜日の正午など、一定の時間間隔で、または Cron スケジュールでスキャンされるように設定されています。
監視フォルダーエンドポイントをプログラムによってサービスに追加する場合は、EncryptDocument という名前の短時間のみ有効なプロセスを考慮してください(AEM Formsプロセスについてを参照してください)。
このプロセスは、セキュリティで保護されていないPDFドキュメントを入力値として受け取り、セキュリティで保護されていないPDFドキュメントを Encryption サービスの EncryptPDFUsingPassword
操作。 PDF ドキュメントをパスワードで暗号化し、パスワードで暗号化された PDF ドキュメントはこのプロセスの出力値です。入力値の名前 ( 保護されていない PDF ドキュメント ) は InDoc
、 データタイプは com.adobe.idp.Document
です。出力値の名前 ( パスワードで暗号化された PDF ドキュメント ) は SecuredDoc
、 データタイプは com.adobe.idp.Document
です。
Web サービスを使用した監視フォルダーエンドポイントの追加はできません。
監視フォルダーエンドポイントをサービスに追加するには、次のタスクを実行します。
EndpointRegistryClient
オブジェクトを作成します。プロジェクトファイルを含める
必要なファイルを開発プロジェクトに含めます。Java を使用してクライアントアプリケーションを作成する場合は、必要な JAR ファイルを含めます。Web サービスを使用している場合は、必ずプロキシファイルを含めてください。
次の JAR ファイルをプロジェクトのクラスパスに追加する必要があります。
これらの JAR ファイルの場所については、AEM Forms Java ライブラリファイルを含めるを参照してください。
EndpointRegistry Client オブジェクトの作成
プログラムによって監視フォルダーエンドポイントを追加するには、 EndpointRegistryClient
オブジェクトを作成する必要があります。
監視フォルダーエンドポイントの属性を設定する
サービスの監視フォルダーエンドポイントを作成するには、次の値を指定します。
WatchedFolder
EncryptDocument
を指定します。invoke
になります。設定値の指定
プログラムによって監視フォルダーエンドポイントをサービスに追加する場合は、監視フォルダーエンドポイントの設定値を指定します。 管理コンソールを使用して監視フォルダーエンドポイントを追加した場合、これらの設定値は管理者が指定します。
次のリストでは、監視フォルダーエンドポイントをプログラムでサービスに追加する際に設定される設定値を指定します。
data*
であれば、data*
に一致するファイルとフォルダーはいずれも取得されません。data1
や data2
などといった名前のファイルとフォルダーがこれに該当します。また、ワイルドカードパターンをパターンに追加してファイルパターンを指定することもできます。監視フォルダーでは、*.*
や *.pdf
などのワイルドカードパターンをサポートするよう、正規表現を変更しました。これらのワイルドカードパターンは、正規表現ではサポートされていません。*
であれば、input*
に一致するすべてのファイルとフォルダーが取得されます。input1
や input2
などといった名前のファイルとフォルダーがこれに該当します。デフォルト値は *
です。この値は、すべてのファイルとフォルダーが対象になることを示しています。また、ワイルドカードパターンをパターンに追加してファイルパターンを指定することもできます。監視フォルダーでは、*.*
や *.pdf
などのワイルドカードパターンに対応するよう、正規表現を変更しました。これらのワイルドカードパターンは、正規表現では対応していません。この値は必須です。result/%Y/%M/%D/
です。これは、監視フォルダー内の結果フォルダーです。preserve/%Y/%M/%D/
です。failure/%Y/%M/%D/
です。入力パラメーター値の定義
監視フォルダーエンドポイントを作成する場合は、入力パラメーターの値を定義する必要があります。つまり、監視フォルダーによって呼び出される操作に渡される入力値を記述する必要があります。例えば、このトピックで紹介するプロセスについて考えてみましょう。入力値として 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
です。
マッピングタイプ:サービスおよび操作の出力を設定するために使用します。以下のオプションが利用できます。
%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 API を使用して、監視フォルダーエンドポイントを追加します。
プロジェクトファイルを含めます。
Java プロジェクトのクラスパスに、adobe-livecycle-client.jar などのクライアント JAR ファイルを含めます。
EndpointRegistry クライアントオブジェクトを作成します。
ServiceClientFactory
オブジェクトを作成します。ServiceClientFactory
オブジェクトを渡し、EndpointRegistryClient
オブジェクトを作成します。監視フォルダーエンドポイントの属性を設定します。
CreateEndpointInfo
オブジェクトを作成します。CreateEndpointInfo
オブジェクトの setConnectorId
メソッドと文字列値を渡す WatchedFolder
.CreateEndpointInfo
オブジェクトの setDescription
メソッドを使用してエンドポイントを表す string 値を渡す方法を示します。CreateEndpointInfo
オブジェクトの setName
メソッドを使用して、名前を指定する string 値を渡す。CreateEndpointInfo
オブジェクトの setServiceId
メソッドを使用し、サービス名を指定する string 値を渡す。CreateEndpointInfo
オブジェクトの setOperationName
メソッドを使用して、操作名を指定する string 値を渡す。 通常、Workbench で作成されたプロセスから生成されたサービスの監視フォルダーエンドポイントを作成する場合、操作名は invoke になります。設定値を指定します。
設定値ごとに、監視フォルダーエンドポイントに対してを呼び出す必要があります。 CreateEndpointInfo
オブジェクトの setConfigParameterAsText
メソッド。 例えば、 url
設定値、を呼び出す CreateEndpointInfo
オブジェクトの setConfigParameterAsText
メソッドを使用して、次の文字列値を渡します。
url
設定値を設定する場合は、url
を指定します。url
設定値を設定するには、監視フォルダーの場所を指定します。EncryptDocument サービスに設定されたすべての設定値を確認するには、QuickStart:Java API を使用した監視フォルダーエンドポイントの追加にある Java コードの例を参照してください。
入力パラメーター値を定義します。
を呼び出して、入力パラメーター値を定義する CreateEndpointInfo
オブジェクトの setInputParameterMapping
メソッドを使用して、次の値を渡します。
InDoc
です。InDoc
入力パラメーターのデータタイプは com.adobe.idp.Document
です。variable
を指定できます。定義する入力パラメーター値ごとに setInputParameterMapping
メソッドを呼び出します。EncryptDocument プロセスには入力パラメーターが 1 つしかないので、このメソッドを 1 度呼び出す必要があります。
出力パラメーター値を定義します。
を呼び出して、出力パラメーター値を定義する CreateEndpointInfo
オブジェクトの setOutputParameterMapping
メソッドを使用して、次の値を渡します。
SecuredDoc
です。SecuredDoc
出力パラメーターのデータタイプは com.adobe.idp.Document
です。%F.pdf
を指定できます。監視フォルダーエンドポイントを作成します。
を呼び出してエンドポイントを作成する EndpointRegistryClient
オブジェクトの createEndpoint
メソッドおよび CreateEndpointInfo
オブジェクト。 このメソッドは、 監視フォルダーエンドポイントを表す Endpoint
オブジェクトを返します。
エンドポイントを有効にします。
を呼び出してエンドポイントを有効にする EndpointRegistryClient
オブジェクトの enable
メソッドおよび Endpoint
が返したオブジェクト createEndpoint
メソッド。
関連情報
QuickStart:Java API を使用した監視フォルダーエンドポイントの追加
The QuickStart: 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 を使用して、プログラムによってメールエンドポイントをサービスに追加できます。メールエンドポイントを追加すると、1 つ以上の添付ファイルを含むメールメッセージを、指定したメールアカウントに送信することをユーザーに許可できます。次に、サービス操作の設定が呼び出され、ファイルを操作します。指定した操作を実行すると、変更されたファイルが添付ファイルとして送信者にメールメッセージが送信されます。
メールエンドポイントをプログラムでサービスに追加する場合は、MyApplication\EncryptDocument のような短時間のみ有効なプロセスを考慮してください。短時間のみ有効なプロセスについては、 AEM Formsプロセスについてを参照してください。
このプロセスは、セキュリティで保護されていないPDFドキュメントを入力値として受け取り、セキュリティで保護されていないPDFドキュメントを Encryption サービスの EncryptPDFUsingPassword
操作。 このプロセスは、PDF ドキュメントをパスワードで暗号化し、パスワードで暗号化された PDF ドキュメントを出力値として返します。入力値の名前(保護されていない PDF ドキュメント)は InDoc
、データタイプは com.adobe.idp.Document
です。出力値の名前(パスワードで暗号化された PDF ドキュメント)は SecuredDoc
、データタイプは com.adobe.idp.Document
です。
Web サービスを使用してメールエンドポイントを追加することはできません。
メールエンドポイントをサービスに追加するには、次のタスクを実行します。
EndpointRegistryClient
オブジェクトを作成します。プロジェクトファイルを含める
必要なファイルを開発プロジェクトに含めます。Java を使用してクライアントアプリケーションを作成する場合は、必要な JAR ファイルを含めます。Web サービスを使用している場合は、必ずプロキシファイルを含めてください。
次の JAR ファイルをプロジェクトのクラスパスに追加する必要があります。
これらの JAR ファイルの場所については、AEM Forms Java ライブラリファイルを含めるを参照してください。
EndpointRegistry Client オブジェクトの作成
プログラム的にメールエンドポイントを追加する前に、 EndpointRegistryClient
オブジェクトを作成する必要があります。
メールエンドポイント属性の設定
サービスのメールエンドポイントを作成するには、次の値を指定します。
Email
を指定します。EncryptDocument
を指定します。invoke
です。設定値の指定
プログラムによって電子メールエンドポイントをサービスに追加する際に、電子メールエンドポイントの設定値を指定します。 これらの設定値は、管理コンソールを使用してメールエンドポイントを追加する場合に、管理者が指定します。
監視対象のメールアカウントは、メールエンドポイントにのみ使用される専用のアカウントです。このアカウントは通常のユーザーのメールアカウントではありません。通常のユーザーの電子メールアカウントは、電子メールプロバイダーが使用するアカウントとして設定してはいけません。電子メールプロバイダーは、メッセージの使用が完了した後で、インボックスから電子メールメッセージを削除します。
メールエンドポイントをサービスにプログラム的に追加する際に、次の設定値が設定されます。
SuperAdmin
です。DefaultDom
です。adobe.com
を使用すると、adobe.com から受信したメールのみが処理され、それ以外のドメインからのメールは無視されます。*
です。sender
と入力すると、メールによる結果通知が送信者に送信されます。最大 100 人の受信者を指定できます。追加の受信者をメールアドレスで指定します。各受信者はコンマで区切ります。このオプションをオフにするには、この値を空白のままにします。場合によっては、プロセスをトリガーしても、結果のメール通知を受信したくないことがあります。デフォルト値は sender
です。sender
と入力すると、メールの結果が送信者に送信されます。最大 100 人の受信者を指定できます。追加の受信者をメールアドレスで指定します。各受信者はコンマで区切ります。このオプションをオフにするには、この値を空白のままにします。デフォルト値は sender
です。IMAP
と POP3
があります。指定のプロトコルはインボックスホストメールサーバーでサポートされている必要があります。UTF-8
です。入力パラメーター値の定義
メールエンドポイントを作成する場合、入力パラメーターの値を定義する必要があります。つまり、メールエンドポイントによって呼び出される操作に渡される入力値を記述する必要があります。例えば、このトピックで紹介するプロセスについて考えてみましょう。InDoc
という名前の入力値が 1 つあり、そのデータタイプは com.adobe.idp.Document
です。このプロセスのメールエンドポイントを作成する場合(プロセスをアクティブにするとサービスになります)、入力パラメーター値を定義する必要があります。
メールエンドポイントに必要な入力パラメーター値を定義するには、次の値を指定します。
入力パラメーター名:入力パラメーターの名前。入力値の名前は、プロセスに対して Workbench で指定されます。入力値がサービス操作に属する場合(Workbench で作成されたプロセスではない Forms サービス)、入力名は component.xml ファイルで指定されます。例えば、この節で紹介するプロセスの入力パラメーターの名前は InDoc
です。
マッピングタイプ:サービス操作を呼び出すために必要な入力値の設定に使用します。マッピングタイプには次の 2 種類があります。
Literal
:メールエンドポイントは、フィールドに入力した値を表示どおりに使用します。基本 Java 型がすべてサポートされます。例えば、文字列、long、int および Boolean などの入力が使用される API の場合、文字列は適切な型に変換され、サービスが呼び出されます。Variable
:入力した値は、メールエンドポイントが入力を取得するのに使用するファイルパターンです。例えば、マッピングタイプに「変数」を選択し、入力ドキュメントを PDF ファイルにすると、マッピング値として *.pdf
を使用します。マッピング値:マッピングタイプの値を指定します。例えば、マッピングタイプに「変数」を選択した場合、ファイルパターンとして *.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(出力 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 を使用してメールエンドポイントを追加します。
プロジェクトファイルを含めます。
Java プロジェクトのクラスパスに、adobe-livecycle-client.jar などのクライアント JAR ファイルを含めます。
EndpointRegistry クライアントオブジェクトを作成します。
ServiceClientFactory
オブジェクトを作成します。ServiceClientFactory
オブジェクトを渡すことによって、EndpointRegistryClient
オブジェクトを作成します。メールエンドポイント属性を設定します。
CreateEndpointInfo
オブジェクトを作成します。CreateEndpointInfo
オブジェクトの setConnectorId
メソッドと文字列値を渡す Email
.CreateEndpointInfo
オブジェクトの setDescription
メソッドを使用してエンドポイントを表す string 値を渡す方法を示します。CreateEndpointInfo
オブジェクトの setName
メソッドを使用して、名前を指定する string 値を渡す。CreateEndpointInfo
オブジェクトの setServiceId
メソッドを使用し、サービス名を指定する string 値を渡す。CreateEndpointInfo
オブジェクトの setOperationName
メソッドを使用して、操作名を指定する string 値を渡す。 通常、Workbench で作成されたプロセスから派生するサービスのメールエンドポイントを作成する場合、操作の名前は「呼び出し」になります。設定値を指定します。
電子メールエンドポイントに設定する設定値ごとに、 CreateEndpointInfo
オブジェクトの setConfigParameterAsText
メソッド。 例えば、 smtpHost
設定値、を呼び出す CreateEndpointInfo
オブジェクトの setConfigParameterAsText
メソッドを使用して、次の値を渡します。
smtpHost
設定値を設定する場合は、smtpHost
を指定します。smtpHost
設定値を設定する場合は、SMTP サーバーの名前を指定する文字列値を指定します。このセクションで紹介する EncryptDocument サービスに設定されたすべての設定値を確認するには、Java コードの例を参照してください(クイックスタート:Java API を使用したメールエンドポイントの追加)。
入力パラメーター値を定義します。
を呼び出して、入力パラメーター値を定義する CreateEndpointInfo
オブジェクトの setInputParameterMapping
メソッドを使用して、次の値を渡します。
InDoc
です。InDoc
入力パラメーターのデータタイプは com.adobe.idp.Document
です。variable
を指定できます。定義する入力パラメーター値ごとに setInputParameterMapping
メソッドを呼び出します。EncryptDocument プロセスには入力パラメーターが 1 つしかないので、このメソッドを 1 度呼び出す必要があります。
出力パラメーター値を定義します。
を呼び出して、出力パラメーター値を定義する CreateEndpointInfo
オブジェクトの setOutputParameterMapping
メソッドを使用して、次の値を渡します。
SecuredDoc
です。SecuredDoc
出力パラメーターのデータタイプは com.adobe.idp.Document
です。%F.pdf
を指定できます。メールエンドポイントを作成します。
を呼び出してエンドポイントを作成する EndpointRegistryClient
オブジェクトの createEndpoint
メソッドおよび CreateEndpointInfo
オブジェクト。 このメソッドは、メールエンドポイントを表す Endpoint
オブジェクトを返します。
エンドポイントを有効にします。
を呼び出してエンドポイントを有効にする EndpointRegistryClient
オブジェクトの enable
メソッドおよび Endpoint
が返したオブジェクト createEndpoint
メソッド。
関連情報
QuickStart:Java API を使用した監視フォルダーエンドポイントの追加
The クイックスタート: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";
}
JEE 上の AEM Forms で LiveCycle Remoting API は非推奨になりました。
AEM Forms Java API を使用して、プログラムによってリモートエンドポイントをサービスに追加できます。リモートエンドポイントを追加すると、リモート処理を使用してFlexアプリケーションからサービスを呼び出すことができます。((AEM Forms では廃止)AEM Forms Remoting を使用した AEM Forms の呼び出しを参照してください)。
リモートエンドポイントをプログラムでサービスに追加する場合は、次の EncryptDocument という短時間のみ有効なプロセスを考えてみてください。
このプロセスは、セキュリティで保護されていないPDFドキュメントを入力値として受け取り、セキュリティで保護されていないPDFドキュメントを Encryption サービスの EncryptPDFUsingPassword
操作。 PDF ドキュメントをパスワードで暗号化し、パスワードで暗号化された PDF ドキュメントはこのプロセスの出力値です。入力値の名前 ( 保護されていない PDF ドキュメント ) は InDoc
、 データタイプは com.adobe.idp.Document
です。出力値(パスワードで暗号化された PDF ドキュメント)の名前は SecuredDoc
、データタイプは com.adobe.idp.Document
です。
サービスにリモートエンドポイントを追加する方法を示すために、このセクションでは EncryptDocument という名前のサービスにリモートエンドポイントを追加します。
Web サービスを使用してリモートエンドポイントを追加することはできません。
エンドポイントをサービスから削除するには、以下のタスクを実行します。
EndpointRegistryClient
オブジェクトを作成します。プロジェクトファイルを含める
必要なファイルを開発プロジェクトに含めます。Java を使用してクライアントアプリケーションを作成する場合は、必要な JAR ファイルを含めます。Web サービスを使用している場合は、必ずプロキシファイルを含めてください。
次の JAR ファイルをプロジェクトのクラスパスに追加する必要があります。
これらの JAR ファイルの場所については、AEM Forms Java ライブラリファイルを含めるを参照してください。
EndpointRegistry クライアントオブジェクトを作成する
リモートエンドポイントをプログラムで追加するには、EndpointRegistryClient
オブジェクトを作成する必要があります。
リモートエンドポイント属性の設定
サービスのリモートエンドポイントを作成するには、次の値を指定します。
Remoting
を指定します。EncryptDocument
を指定します。リモートエンドポイントの作成
リモートエンドポイント属性を設定した後、サービスのリモートエンドポイントを作成できます。
エンドポイントを有効にする
エンドポイントを作成したら、そのエンドポイントを有効にする必要があります。 リモートエンドポイントが有効な場合、Flex クライアントがサービスを呼び出すことができます。
関連トピック
Java API を使用してリモートエンドポイントを追加します。
プロジェクトファイルを含めます。
Java プロジェクトのクラスパスに、adobe-livecycle-client.jar などのクライアント JAR ファイルを含めます。
EndpointRegistry クライアントオブジェクトを作成します。
ServiceClientFactory
オブジェクトを作成します。EndpointRegistryClient
オブジェクトを作成し、ServiceClientFactory
オブジェクトを渡します。リモートエンドポイントの属性を設定します。
CreateEndpointInfo
オブジェクトを作成します。CreateEndpointInfo
オブジェクトの setConnectorId
メソッドと文字列値を渡す Remoting
.CreateEndpointInfo
オブジェクトの setDescription
メソッドを使用してエンドポイントを表す string 値を渡す方法を示します。CreateEndpointInfo
オブジェクトの setName
メソッドを使用して、名前を指定する string 値を渡す。CreateEndpointInfo
オブジェクトの setServiceId
メソッドを使用し、サービス名を指定する string 値を渡す。CreateEndpointInfo
オブジェクトの setOperationName
メソッドを使用して、操作名を指定する string 値を渡す。 リモートエンドポイントの場合は、ワイルドカード文字(*)を指定します。リモートエンドポイントを作成します。
を呼び出してエンドポイントを作成する EndpointRegistryClient
オブジェクトの createEndpoint
メソッドおよび CreateEndpointInfo
オブジェクト。 このメソッドは、新しいリモートエンドポイントを表す Endpoint
オブジェクトを返します。
エンドポイントを有効にします。
を呼び出してエンドポイントを有効にする EndpointRegistryClient
オブジェクトの enable
メソッドおよび Endpoint
が返したオブジェクト createEndpoint
メソッド。
関連情報
クイックスタート:Java API を使用してリモートエンドポイントを追加する
AEM Forms Java API を使用して、プログラムによって TaskManager エンドポイントをサービスに追加できます。TaskManager エンドポイントをサービスに追加することで、Workspace ユーザーがサービスを呼び出せるようにします。つまり、Workspace で作業しているユーザーが、対応する TaskManager エンドポイントを持つプロセスを呼び出せるようになります。
Web サービスを使用して TaskManager エンドポイントを追加することはできません。
TaskManager エンドポイントをサービスに追加するには、次のタスクを実行します。
EndpointRegistryClient
オブジェクトを作成します。プロジェクトファイルを含める
必要なファイルを開発プロジェクトに含めます。Java を使用してクライアントアプリケーションを作成する場合は、必要な JAR ファイルを含めます。Web サービスを使用している場合は、必ずプロキシファイルを含めてください。
次の JAR ファイルをプロジェクトのクラスパスに追加する必要があります。
これらの JAR ファイルの場所については、AEM Forms Java ライブラリファイルを含めるを参照してください。
EndpointRegistry Client オブジェクトの作成
TaskManager エンドポイントをプログラムによって追加するには、EndpointRegistryClient
オブジェクトを事前に作成しておく必要があります。
エンドポイントのカテゴリの作成
カテゴリは、Workspace 内のサービスを整理するために使用されます。つまり、Workspace ユーザーは、Workspace 内のカテゴリを選択することで、TaskManager エンドポイントを持つサービスを呼び出すことができます。TaskManager エンドポイントを作成する場合、既存のカテゴリを参照するか、プログラムによってカテゴリを作成できます。
このセクションでは、TaskManager エンドポイントをサービスに追加する際に、新しいカテゴリを作成します。
TaskManager エンドポイント属性の設定
サービスの TaskManager エンドポイントを作成するには、次の値を指定します。
TaskManagerConnector
を指定します。invoke
です。TaskManager エンドポイントの作成
TaskManager エンドポイントの属性を設定したら、サービスの TaskManager エンドポイントを作成できます。
エンドポイントを有効にする
エンドポイントを作成したら、そのエンドポイントを有効にする必要があります。 エンドポイントを有効にしたら、Workspace 内からサービスを呼び出すために使用できます。エンドポイントを有効にすると、管理コンソール内で表示できます。
関連トピック
Java API を使用した TaskManager エンドポイントの追加
Java API を使用して TaskManager エンドポイントを追加します。
プロジェクトファイルを含めます。
Java プロジェクトのクラスパスに、adobe-livecycle-client.jar などのクライアント JAR ファイルを含めます。
EndpointRegistry クライアントオブジェクトを作成します。
ServiceClientFactory
オブジェクトを作成します。ServiceClientFactory
オブジェクトを渡すことによって、EndpointRegistryClient
オブジェクトを作成します。エンドポイントのカテゴリを作成します。
コンストラクターを使用して、次の文字列値を渡すことによって、CreateEndpointCategoryInfo
オブジェクトを作成します。
を呼び出して、カテゴリを作成します。 EndpointRegistryClient
オブジェクトの createEndpointCategory
メソッドおよび CreateEndpointCategoryInfo
オブジェクト。 このメソッドは、新しいカテゴリを表す EndpointCategory
オブジェクトを返します。
TaskManager エンドポイント属性を設定します。
CreateEndpointInfo
オブジェクトを作成します。CreateEndpointInfo
オブジェクトの setConnectorId
メソッドと文字列値を渡す TaskManagerConnector
.CreateEndpointInfo
オブジェクトの setDescription
メソッドを使用してエンドポイントを表す string 値を渡す方法を示します。CreateEndpointInfo
オブジェクトの setName
メソッドを使用して、名前を指定する string 値を渡す。CreateEndpointInfo
オブジェクトの setServiceId
メソッドを使用し、サービス名を指定する string 値を渡す。CreateEndpointInfo
オブジェクトの setCategoryId
メソッドを使用して、カテゴリ識別子の値を指定する string 値を渡す。 を呼び出すことができます。 EndpointCategory
オブジェクトの getId
メソッドを使用して、このカテゴリの識別子の値を取得します。CreateEndpointInfo
オブジェクトの setOperationName
メソッドを使用して、操作名を指定する string 値を渡す。 通常、Workbench で作成したプロセスから派生するサービスの TaskManager
エンドポイントで、操作の名前は invoke
です。TaskManager エンドポイントを作成します。
を呼び出してエンドポイントを作成する EndpointRegistryClient
オブジェクトの createEndpoint
メソッドおよび CreateEndpointInfo
オブジェクト。 このメソッドは、新しい TaskManager エンドポイントを表す Endpoint
オブジェクトを返します。
エンドポイントを有効にします。
を呼び出してエンドポイントを有効にする EndpointRegistryClient
オブジェクトの enable
メソッドおよび Endpoint
が返したオブジェクト createEndpoint
メソッド。
関連情報
クイックスタート:Java API を使用した TaskManager エンドポイントの追加
AEM Forms Java API を使用して、既存のエンドポイントをプログラムで変更できます。エンドポイントを変更すると、エンドポイントの動作を変更できます。例えば、監視フォルダーとして使用するフォルダーを指定する監視フォルダーエンドポイントがあるとします。監視フォルダーエンドポイントに属する設定値をプログラムで変更することで、別のフォルダーが監視フォルダーとして機能するようになります。監視フォルダーエンドポイントに属する設定値について詳しくは、監視フォルダーエンドポイントの追加を参照してください。
このセクションでは、エンドポイントを変更する方法を示すために、監視フォルダーとして動作するフォルダーを変更して、監視フォルダーエンドポイントを変更します。
Web サービスを使用してエンドポイントを変更することはできません。
エンドポイントを変更するには、次のタスクを実行します。
EndpointRegistryClient
オブジェクトを作成します。プロジェクトファイルを含める
必要なファイルを開発プロジェクトに含めます。Java を使用してクライアントアプリケーションを作成する場合は、必要な JAR ファイルを含めます。Web サービスを使用している場合は、必ずプロキシファイルを含めてください。
次の JAR ファイルをプロジェクトのクラスパスに追加する必要があります。
これらの JAR ファイルの場所については、AEM Forms Java ライブラリファイルを含めるを参照してください。
EndpointRegistry クライアントオブジェクトの作成
エンドポイントをプログラムで変更するには、EndpointRegistryClient
オブジェクトを作成する必要があります。
変更するエンドポイントの取得
エンドポイントを変更する前に、エンドポイントを取得する必要があります。エンドポイントを取得するには、エンドポイントにアクセスできるユーザーとして接続する必要があります。管理者として接続することをお勧めします。(接続プロパティの設定を参照)。
エンドポイントのリストを取得して、エンドポイントを取得できます。その後、リストを繰り返し処理し、削除する特定のエンドポイントを検索できます。例えば、エンドポイントに対応するサービスとエンドポイントのタイプを指定して、エンドポイントを特定できます。エンドポイントを見つけたら、変更できます。
新しい設定値を指定する
エンドポイントを変更する場合は、新しい設定値を指定します。例えば、監視フォルダーエンドポイントを変更するには、変更するエンドポイントだけでなく、すべての監視フォルダーエンドポイント設定値をリセットします。監視フォルダーエンドポイントに属する設定値について詳しくは、 監視フォルダーエンドポイントの追加を参照してください。
メールエンドポイントに属する設定値について詳しくは、 メールエンドポイントの追加を参照してください。
エンドポイントによって呼び出されたサービスは変更できません。サービスを変更しようとすると、例外が発生します。特定のエンドポイントに関連付けられているサービスを変更するには、エンドポイントを削除して、エンドポイントを作成します。 ( エンドポイントの削除を参照してください)。
関連トピック
Java API を使用してエンドポイントを変更します。
プロジェクトファイルを含めます。
Java プロジェクトのクラスパスに、adobe-livecycle-client.jar などのクライアント JAR ファイルを含めます。
EndpointRegistry クライアントオブジェクトを作成します。
ServiceClientFactory
オブジェクトを作成します。EndpointRegistryClient
オブジェクトを渡すことによって、 ServiceClientFactory
オブジェクトを作成します。変更するエンドポイントを取得します。
EndpointRegistryClient
オブジェクトの getEndpoints
メソッドと PagingFilter
オブジェクトを指定します。 (PagingFilter)null
値を指定して、すべてのエンドポイントを返します。このメソッドは、各要素が Endpoint
オブジェクトである java.util.List
オブジェクトを返します。PagingFilter
オブジェクトの情報は、AEM Forms API リファレンスを参照してください。java.util.List
オブジェクトを反復処理して、エンドポイントがあるかどうかを判断します。エンドポイントが存在する場合、各要素は EndPoint
インスタンスです。EndPoint
オブジェクトの getServiceId
メソッド。 このメソッドは、サービス名を指定する文字列値を返します。EndPoint
オブジェクトの getConnectorId
メソッド。 このメソッドは、エンドポイントのタイプを指定する文字列値を返します。例えば、エンドポイントが監視フォルダーエンドポイントの場合、このメソッドは WatchedFolder
を返します。新しい設定値を指定します。
コンストラクターを使用して ModifyEndpointInfo
オブジェクトを作成します。
設定する設定値ごとに、 ModifyEndpointInfo
オブジェクトの setConfigParameterAsText
メソッド。 例えば、URL 設定値を設定するには、 ModifyEndpointInfo
オブジェクトの setConfigParameterAsText
メソッドを使用して、次の値を渡します。
url
構成値を設定するには、url
を指定します。url
設定値の値を定義するには、監視フォルダーの場所を指定します。EndpointRegistryClient
オブジェクトの modifyEndpoint
メソッドを呼び出し、ModifyEndpointInfo
オブジェクトを渡します
関連情報
クイックスタート:Java API を使用したエンドポイントの変更
AEM Forms Java API を使用して、プログラムによってエンドポイントをサービスから削除できます。エンドポイントを削除すると、エンドポイントが有効な呼び出しメソッドを使用してもサービスを呼び出せなくなります。例えば、サービスから SOAP エンドポイントを削除すると、SOAP モードを使用してもサービスを呼び出せません。
このセクションでは、サービスからエンドポイントを削除する方法を示すために、EJB エンドポイントを EncryptDocument という名前のサービスから削除します。
Web サービスを使用してエンドポイントを削除することはできません。
エンドポイントをサービスから削除するには、以下のタスクを実行します。
EndpointRegistryClient
オブジェクトを作成します。プロジェクトファイルを含める
開発プロジェクトに必要なファイルを含めます。Java を使用してクライアントアプリケーションを作成する場合は、必要な JAR ファイルを含めます。Web サービスを使用している場合は、必ずプロキシファイルを含めてください。
次の JAR ファイルをプロジェクトのクラスパスに追加する必要があります。
これらの JAR ファイルの場所については、AEM Forms Java ライブラリファイルを含めるを参照してください。
EndpointRegistry クライアントオブジェクトの作成
プログラムによってエンドポイントを削除するには、EndpointRegistryClient
オブジェクトを作成する必要があります。
削除するエンドポイントを取得する
エンドポイントを削除する前に、エンドポイントを取得する必要があります。エンドポイントを取得するには、エンドポイントにアクセスできるユーザーとして接続する必要があります。管理者として接続することをお勧めします。(接続プロパティの設定を参照)。
エンドポイントのリストを取得して、エンドポイントを取得できます。その後、リストを繰り返し処理し、削除する特定のエンドポイントを検索できます。例えば、エンドポイントに対応するサービスとエンドポイントのタイプを指定して、エンドポイントを特定できます。エンドポイントを見つけたら、そのエンドポイントを削除できます。
エンドポイントを削除
エンドポイントを作成したら、そのエンドポイントを有効にする必要があります。 エンドポイントが有効であれば、サービスの呼び出しに使用することができます。エンドポイントを有効にすると、管理コンソール内で表示できます。
関連トピック
Java API を使用してエンドポイントを削除します。
プロジェクトファイルを含めます。
Java プロジェクトのクラスパスに、adobe-livecycle-client.jar などのクライアント JAR ファイルを含めます。
EndpointRegistry クライアントオブジェクトを作成します。
ServiceClientFactory
オブジェクトを作成します。EndpointRegistryClient
オブジェクトを作成するには、コンストラクターを使用して ServiceClientFactory
オブジェクトを渡します。削除するエンドポイントを取得します。
EndpointRegistryClient
オブジェクトの getEndpoints
メソッドと PagingFilter
オブジェクトを指定します。 (PagingFilter)null
を渡して、すべてのエンドポイントを返します。このメソッドは、各要素が Endpoint
オブジェクトである java.util.List
オブジェクトを返します。java.util.List
オブジェクトを反復処理して、エンドポイントがあるかどうかを判断します。エンドポイントが存在する場合、各要素は EndPoint
インスタンスです。EndPoint
オブジェクトの getServiceId
メソッド。 このメソッドは、サービス名を指定する文字列値を返します。EndPoint
オブジェクトの getConnectorId
メソッド。 このメソッドは、エンドポイントのタイプを指定する文字列値を返します。例えば、エンドポイントが EJB エンドポイントである場合、このメソッドは EJB
を返します。エンドポイントを削除します。
を呼び出してエンドポイントを削除する EndpointRegistryClient
オブジェクトの remove
メソッドおよび EndPoint
削除するエンドポイントを表すオブジェクト。
関連情報
QuickStart:Java API を使用したエンドポイントの削除
AEM Forms APIを使用して、エンドポイントコネクターの情報をプログラムで取得することができます。コネクターを使用すると、エンドポイントで様々な呼び出し方法を用いてサービスを呼び出すことができます。例えば、監視フォルダーコネクターを使用すると、エンドポイントで監視フォルダーを使用したサービスを呼び出すことができます。エンドポイントコネクターの情報をプログラムで取得することで、どの設定値が必須で、どの設定値が任意であるかなど、コネクターに関連する設定値を取得することができます。
エンドポイントコネクターの情報を取得する方法を説明するために、ここでは監視フォルダーコネクターの情報を取得します(監視フォルダーエンドポイントの追加を参照)。
Web サービスを使用してエンドポイントの情報を取得することはできません。
このトピックでは、ConnectorRegistryClient
APIを使用して、エンドポイントコネクターの情報を取得します(AEM Forms API リファレンスを参照)。
エンドポイントコネクターの情報を取得するには、以下のタスクを実行します。
ConnectorRegistryClient
オブジェクトの作成。プロジェクトファイルを含める
開発プロジェクトに必要なファイルを含めます。Java を使用してクライアントアプリケーションを作成する場合は、必要な JAR ファイルを含めます。Web サービスを使用している場合は、必ずプロキシファイルを含めてください。
次の JAR ファイルをプロジェクトのクラスパスに追加する必要があります。
AEM Forms が JBoss 以外のサポート対象の J2EE アプリケーションサーバーにデプロイされている場合は、adobe-utilities.jar ファイルと jbossall-client.jar ファイルを、AEM Forms がデプロイされている J2EE アプリケーションサーバーに固有の JAR ファイルに置き換えます。すべての AEM Forms JAR ファイルの場所については、AEM Forms Java ライブラリファイルを含めるを参照してください。
ConnectorRegistry クライアントオブジェクトの作成
エンドポイントコネクタの情報をプログラムで取得するには、ConnectorRegistryClient
オブジェクトを作成します。
コネクタタイプを指定
情報を取得するコネクターのタイプを指定します。以下のタイプのコネクターが存在します。
設定値の取得
コネクタータイプを指定すると、サポートされている設定値など、コネクターに関する情報を取得することができます。例えば、任意のコネクタについて、どの設定値が必須で、どの設定値がオプションであるかを決定することができます。
関連トピック
Java API を使用したエンドポイントコネクター情報の取得
Java API を使用して、エンドポイントコネクターの情報を取得します。
プロジェクトファイルを含めます。
Java プロジェクトのクラスパスに、adobe-livecycle-client.jar などのクライアント JAR ファイルを含めます。
ConnectorRegistry クライアントオブジェクトを作成します。
ServiceClientFactory
オブジェクトを作成します。ServiceClientFactory
オブジェクトを渡し、ConnectorRegistryClient
オブジェクトを作成します。コネクタタイプを指定します。
を呼び出して、コネクタのタイプを指定します。 ConnectorRegistryClient
オブジェクトの getEndpointDefinition
メソッドを使用して、コネクタの種類を指定する string 値を渡します。 例えば、監視フォルダーのコネクタータイプを指定するには、文字列値 WatchedFolder
を渡します。このメソッドは、コネクタタイプに対応する Endpoint
オブジェクトを返します。
設定値を取得します。
Endpoint
オブジェクトの getConfigParameters
メソッド。 このメソッドは、 ConfigParameter
オブジェクトの配列を返します。ConfigParameter
オブジェクトです。例えば、設定値が必須かオプションかを、 ConfigParameter
オブジェクトの isRequired
メソッド。 設定値が必要な場合、このメソッドは true
を返します。関連トピック