エンドポイントレジストリサービスについて
Endpoint Registryサービスは、エンドポイントをプログラムで管理する機能を提供します。 例えば、次の種類のエンドポイントをサービスに追加できます。
SOAP、EJB、および(JEE上のAEM formsでは非推奨)リモートエンドポイントは、アクティブ化された各サービスに対して自動的に作成されます。 SOAPおよびEJBエンドポイントは、すべてのサービス操作でSOAPおよびEJBを有効にします。
リモートエンドポイントを使用すると、Flexクライアントは、エンドポイントが追加されたAEM Formsサービスの操作を呼び出すことができます。 エンドポイントと同じ名前のFlex宛先が作成され、Flexクライアントは、この宛先を指すRemoteObjectsを作成して、関連するサービスの操作を呼び出すことができます。
電子メール、タスクマネージャーおよび監視フォルダーエンドポイントで公開されるのは、サービスの特定の操作のみです。 これらのエンドポイントを追加するには、呼び出すメソッドを選択し、設定パラメーターを設定し、入力パラメーターと出力パラメーターのマッピングを指定する、2つ目の設定手順が必要です。
TaskManagerエンドポイントは、カテゴリと呼ばれるグループに編成できます。 これらのカテゴリはTaskManagerを通じてWorkspaceに公開され、エンドユーザーはTaskManagerエンドポイントを分類したとおりに表示します。 Workspace内で、エンドユーザーはナビゲーションペインにこれらのカテゴリを表示します。 各カテゴリ内のエンドポイントは、Workspaceの開始プロセスページにプロセスカードとして表示されます。
Endpoint Registryサービスを使用して、次のタスクを実行できます。
プログラムでEJBエンドポイントをサービスに追加するには、AEM FormsJava APIを使用します。 EJBエンドポイントをサービスに追加すると、クライアントアプリケーションでEJBモードを使用してサービスを呼び出せるようになります。 つまり、AEM Formsの呼び出しに必要な接続プロパティを設定する場合、EJBモードを選択できます。 (接続プロパティの設定を参照。)
Webサービスを使用してEJBエンドポイントを追加することはできません。
通常、EJBエンドポイントはデフォルトでサービスに追加されますが、EJBエンドポイントは、プログラム的にデプロイされたプロセスや、EJBエンドポイントが削除され、再度追加する必要があるプロセスに追加できます。
EJBエンドポイントをサービスに追加するには、次のタスクを実行します。
EndpointRegistry Client
オブジェクトを作成します。プロジェクトファイルを含める
開発プロジェクトに必要なファイルを含めます。 次のJARファイルをプロジェクトのクラスパスに追加する必要があります。
これらのJARファイルの場所について詳しくは、「AEM FormsJavaライブラリファイルを含める」を参照してください。
EndpointRegistry Clientオブジェクトの作成
プログラムによってEJBエンドポイントを追加する前に、EndpointRegistryClient
オブジェクトを作成する必要があります。
EJBエンドポイント属性の設定
サービス用のEJBエンドポイントを作成するには、次の値を指定します。
EJB
を指定します。*
)を指定します。 ただし、すべてのサービス操作を呼び出すのではなく、特定の操作を指定する場合は、ワイルドカード文字(*
)を使用するのではなく、操作の名前を指定します。EJBエンドポイントの作成
EJBエンドポイント属性を設定した後、サービス用のEJBエンドポイントを作成できます。
エンドポイントの有効化
新しいエンドポイントを作成したら、そのエンドポイントを有効にする必要があります。 有効にしたエンドポイントは、サービスの呼び出しに使用できます。 エンドポイントを有効にした後、管理コンソール内で表示できます。
関連トピック
Java APIを追加使用したEJBエンドポイント:
プロジェクトファイルを含めます。
Javaプロジェクトのクラスパスに、adobe-livecycle-client.jarなどのクライアントJARファイルを含めます。 (
EndpointRegistry Clientオブジェクトを作成します。
ServiceClientFactory
オブジェクトを作成します。EndpointRegistryClient
オブジェクトを渡して、ServiceClientFactory
オブジェクトを作成します。EJBエンドポイント属性を設定します。
CreateEndpointInfo
オブジェクトを作成します。CreateEndpointInfo
オブジェクトのsetConnectorId
メソッドを呼び出し、文字列値EJB
を渡して、コネクタ識別子の値を指定します。CreateEndpointInfo
オブジェクトのsetDescription
メソッドを呼び出し、エンドポイントを説明する文字列値を渡して、エンドポイントの説明を指定します。CreateEndpointInfo
オブジェクトのsetName
メソッドを呼び出し、名前を指定する文字列値を渡して、エンドポイントの名前を指定します。CreateEndpointInfo
オブジェクトのsetServiceId
メソッドを呼び出し、サービス名を指定する文字列値を渡して、エンドポイントが属するサービスを指定します。CreateEndpointInfo
オブジェクトのsetOperationName
メソッドを呼び出して呼び出す操作を指定し、操作名を指定する文字列値を渡します。 SOAPおよびEJBエンドポイントの場合は、ワイルドカード文字(*
)を指定します。これはすべての操作を意味します。EJBエンドポイントを作成します。
EndpointRegistryClient
オブジェクトのcreateEndpoint
メソッドを呼び出し、CreateEndpointInfo
オブジェクトを渡して、エンドポイントを作成します。 このメソッドは、新しいEJBエンドポイントを表すEndpoint
オブジェクトを返します。
エンドポイントを有効にします。
EndpointRegistryClient
オブジェクトのenableメソッドを呼び出し、createEndpoint
メソッドから返されたEndpoint
オブジェクトを渡して、エンドポイントを有効にします。
関連トピック
QuickStart:Java APIを使用したEJBエンドポイントの追加
AEM FormsJava APIを使用すると、プログラムによってSOAPエンドポイントをサービスに追加できます。 SOAPエンドポイントを追加すると、クライアントアプリケーションがSOAPモードを使用してサービスを呼び出せるようになります。 つまり、AEM Formsの呼び出しに必要な接続プロパティを設定する場合は、SOAPモードを選択できます。
Webサービスを使用してSOAPエンドポイントを追加することはできません。
通常、SOAPエンドポイントはデフォルトでサービスに追加されますが、SOAPエンドポイントは、プログラム的にデプロイされるプロセスや、SOAPエンドポイントが削除され、再度追加する必要があるプロセスに追加できます。
SOAPエンドポイントをサービスに追加するには、次のタスクを実行します。
EndpointRegistryClient
オブジェクトを作成します。プロジェクトファイルを含める
必要なファイルを開発プロジェクトに含めます。 Javaを使用してクライアントアプリケーションを作成する場合は、必要なJARファイルを含めます。 Webサービスを使用している場合は、プロキシファイルを必ず含めます。
次のJARファイルをプロジェクトのクラスパスに追加する必要があります。
これらのJARファイルは、SOAPエンドポイントを作成するために必要です。 ただし、SOAPエンドポイントを使用してサービスを呼び出す場合は、追加のJARファイルが必要です。 AEM FormsJARファイルについて詳しくは、AEM Forms Javaライブラリファイルを含めるを参照してください。
EndpointRegistry Clientオブジェクトの作成
プログラムによってSOAPエンドポイントをサービスに追加するには、EndpointRegistryClient
オブジェクトを作成する必要があります。
SOAPエンドポイント属性の設定
SOAPエンドポイントをサービスに追加するには、次の値を指定します。
SOAP
を指定します。*
)を指定します。 ただし、すべてのサービス操作を呼び出すのではなく、特定の操作を指定する場合は、ワイルドカード文字(*
)を使用するのではなく、操作の名前を指定します。SOAPエンドポイントの作成
SOAPエンドポイント属性を設定した後、SOAPエンドポイントを作成できます。
エンドポイントの有効化
新しいエンドポイントを作成したら、そのエンドポイントを有効にする必要があります。 エンドポイントが有効な場合は、サービスの呼び出しに使用できます。 エンドポイントを有効にすると、表示は管理コンソール内でエンドポイントを確認できます。
関連トピック
Java APIを追加使用したサービスへのSOAPエンドポイント:
プロジェクトファイルを含めます。
Javaプロジェクトのクラスパスに、adobe-livecycle-client.jarなどのクライアントJARファイルを含めます。
EndpointRegistry Clientオブジェクトを作成します。
ServiceClientFactory
オブジェクトを作成します。EndpointRegistryClient
オブジェクトを渡して、ServiceClientFactory
オブジェクトを作成します。SOAPエンドポイント属性を設定します。
CreateEndpointInfo
オブジェクトを作成します。CreateEndpointInfo
オブジェクトのsetConnectorId
メソッドを呼び出し、文字列値SOAP
を渡して、コネクタ識別子の値を指定します。CreateEndpointInfo
オブジェクトのsetDescription
メソッドを呼び出し、エンドポイントを説明する文字列値を渡して、エンドポイントの説明を指定します。CreateEndpointInfo
オブジェクトのsetName
メソッドを呼び出し、名前を指定する文字列値を渡して、エンドポイントの名前を指定します。CreateEndpointInfo
オブジェクトのsetServiceId
メソッドを呼び出し、サービス名を指定する文字列値を渡して、エンドポイントが属するサービスを指定します。CreateEndpointInfo
オブジェクトのsetOperationName
メソッドを呼び出し、操作名を指定する文字列値を渡して、呼び出す操作を指定します。 SOAPおよびEJBエンドポイントの場合は、ワイルドカード文字(*
)を指定します。これはすべての操作を意味します。SOAPエンドポイントを作成します。
EndpointRegistryClient
オブジェクトのcreateEndpoint
メソッドを呼び出し、CreateEndpointInfo
オブジェクトを渡して、エンドポイントを作成します。 このメソッドは、新しいSOAPエンドポイントを表すEndpoint
オブジェクトを返します。
エンドポイントを有効にします。
EndpointRegistryClient
オブジェクトのenableメソッドを呼び出し、createEndpoint
メソッドから返されたEndpoint
オブジェクトを渡して、エンドポイントを有効にします。
関連トピック
QuickStart:Java APIを使用したSOAPエンドポイントの追加
プログラムで監視フォルダーエンドポイントをサービスに追加するには、AEM FormsJava 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 FormsJavaライブラリファイルを含める」を参照してください。
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
という名前の1つの入力値があり、そのデータタイプはcom.adobe.idp.Document
です。 このプロセスの監視フォルダーエンドポイントを作成する場合(プロセスがアクティベートされると、サービスになります)、入力パラメーターの値を定義する必要があります。
監視フォルダーエンドポイントに必要な入力パラメーターの値を定義するには、次の値を指定します。
入力パラメーター名:入力パラメーターの名前。入力値の名前は、プロセスに対してWorkbenchで指定されます。 入力値がサービス操作(Workbenchで作成されたプロセスではないサービス)に属する場合、入力名はcomponent.xmlファイルで指定されます。 例えば、この節で紹介するプロセスの入力パラメーターの名前はInDoc
です。
マッピングの種類:サービス操作の呼び出しに必要な入力値を設定するために使用します。マッピングには次の2つのタイプがあります。
Literal
:監視フォルダーエンドポイントでは、フィールドに入力された値が表示どおりに使用されます。すべての基本 Java 型がサポートされます。例えば、String、long、int、Booleanなどの入力を使用するAPIの場合、文字列は適切な型に変換され、サービスが呼び出されます。Variable
:入力された値は、監視フォルダーが入力の選択に使用するファイルパターンです。例えば、マッピングの種類として「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\sourcefilename2.pdf(出力2)のようになります。データタイプ:戻り値のデータ型を指定します。例えば、この節で紹介するプロセスの戻り値のデータ型はcom.adobe.idp.Document
です。
監視フォルダーエンドポイントの作成
エンドポイントの属性、設定値を設定し、入力パラメーターと出力パラメーターの値を定義したら、監視フォルダーエンドポイントを作成する必要があります。
エンドポイントの有効化
監視フォルダーエンドポイントを作成したら、そのエンドポイントを有効にする必要があります。 エンドポイントが有効な場合は、サービスの呼び出しに使用できます。 エンドポイントを有効にした後、管理コンソール内で表示できます。
関連トピック
AEM Forms追加 Java APIを使用した監視フォルダーエンドポイント:
プロジェクトファイルを含めます。
Javaプロジェクトのクラスパスに、adobe-livecycle-client.jarなどのクライアントJARファイルを含めます。
EndpointRegistry Clientオブジェクトを作成します。
ServiceClientFactory
オブジェクトを作成します。EndpointRegistryClient
オブジェクトを渡して、ServiceClientFactory
オブジェクトを作成します。監視フォルダーエンドポイントの属性を設定します。
CreateEndpointInfo
オブジェクトを作成します。CreateEndpointInfo
オブジェクトのsetConnectorId
メソッドを呼び出し、文字列値WatchedFolder
を渡して、コネクタ識別子の値を指定します。CreateEndpointInfo
オブジェクトのsetDescription
メソッドを呼び出し、エンドポイントを説明する文字列値を渡して、エンドポイントの説明を指定します。CreateEndpointInfo
オブジェクトのsetName
メソッドを呼び出し、名前を指定する文字列値を渡して、エンドポイントの名前を指定します。CreateEndpointInfo
オブジェクトのsetServiceId
メソッドを呼び出し、サービス名を指定する文字列値を渡して、エンドポイントが属するサービスを指定します。CreateEndpointInfo
オブジェクトのsetOperationName
メソッドを呼び出し、操作名を指定する文字列値を渡して、呼び出す操作を指定します。 通常、Workbenchで作成されたプロセスから派生するサービスの監視フォルダーエンドポイントを作成する場合、操作の名前はinvokeです。設定値を指定します。
監視フォルダーエンドポイントに設定する設定値ごとに、CreateEndpointInfo
オブジェクトのsetConfigParameterAsText
メソッドを呼び出す必要があります。 例えば、url
設定値を設定するには、CreateEndpointInfo
オブジェクトのsetConfigParameterAsText
メソッドを呼び出し、次の文字列値を渡します。
url
設定値を設定する場合は、url
を指定します。url
設定値を設定する場合は、監視フォルダーの場所を指定します。EncryptDocumentサービスに設定されたすべての設定値を確認するには、QuickStartにある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
メソッドを呼び出し、createEndpoint
メソッドから返されたEndpoint
オブジェクトを渡して、エンドポイントを有効にします。
関連トピック
QuickStart:Java APIを使用した監視フォルダーエンドポイントの追加
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 FormsJava APIを使用して、プログラムで電子メールエンドポイントをサービスに追加できます。 電子メールエンドポイントを追加すると、1つ以上の添付ファイルが含まれた電子メールメッセージを、指定した電子メールアカウントに送信できます。 次に、configureサービス操作が呼び出され、ファイルが操作されます。 サービスが指定の操作を実行すると、送信者に電子メールメッセージが送信され、変更されたファイルが添付ファイルとして送信されます。
プログラムによって電子メールエンドポイントをサービスに追加する場合は、次の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 FormsJavaライブラリファイルを含める」を参照してください。
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 型がサポートされます。例えば、String、long、int および Boolean などの入力が使用される API の場合、文字列は適切な型に変換され、サービスが呼び出されます。Variable
:入力された値は、電子メールエンドポイントが入力の選択に使用するファイルパターンです。例えば、マッピングの種類として「Variable」を選択し、入力ドキュメントーをPDFファイルにする必要がある場合、マッピング値として*.pdf
を指定できます。マッピング値:マッピングタイプの値を指定します。例えば、変数のマッピングの種類を選択した場合、ファイルパターンとして*.pdf
を指定できます。
データタイプ:入力値のデータタイプを指定します。例えば、この節で紹介するプロセスの入力値のデータタイプはcom.adobe.idp.ドキュメントです。
出力パラメーター値の定義
電子メールエンドポイントを作成する場合は、出力パラメーターの値を定義する必要があります。 つまり、電子メールエンドポイントによって呼び出されるサービスから返される出力値を記述する必要があります。 例えば、このトピックで紹介したプロセスを考えてみましょう。 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\sourcefilename2.pdf(出力2)のようになります。データタイプ:戻り値のデータ型を指定します。例えば、この節で紹介するプロセスの戻り値のデータ型はcom.adobe.idp.Document
です。
電子メールエンドポイントの作成
電子メールエンドポイントの属性と設定値を設定し、入力パラメーターと出力パラメーターの値を定義した後、電子メールエンドポイントを作成する必要があります。
エンドポイントの有効化
電子メールエンドポイントを作成したら、そのエンドポイントを有効にする必要があります。 エンドポイントが有効な場合は、サービスの呼び出しに使用できます。 エンドポイントを有効にした後、管理コンソール内で表示できます。
関連トピック
Java APIを追加使用した電子メールエンドポイント:
プロジェクトファイルを含めます。
Javaプロジェクトのクラスパスに、adobe-livecycle-client.jarなどのクライアントJARファイルを含めます。
EndpointRegistry Clientオブジェクトを作成します。
ServiceClientFactory
オブジェクトを作成します。EndpointRegistryClient
オブジェクトを渡して、ServiceClientFactory
オブジェクトを作成します。電子メールエンドポイント属性を設定します。
CreateEndpointInfo
オブジェクトを作成します。CreateEndpointInfo
オブジェクトのsetConnectorId
メソッドを呼び出し、文字列値Email
を渡して、コネクタ識別子の値を指定します。CreateEndpointInfo
オブジェクトのsetDescription
メソッドを呼び出し、エンドポイントを説明する文字列値を渡して、エンドポイントの説明を指定します。CreateEndpointInfo
オブジェクトのsetName
メソッドを呼び出し、名前を指定する文字列値を渡して、エンドポイントの名前を指定します。CreateEndpointInfo
オブジェクトのsetServiceId
メソッドを呼び出し、サービス名を指定する文字列値を渡して、エンドポイントが属するサービスを指定します。CreateEndpointInfo
オブジェクトのsetOperationName
メソッドを呼び出し、操作名を指定する文字列値を渡して、呼び出す操作を指定します。 通常、Workbenchで作成されたプロセスから派生するサービスの電子メールエンドポイントを作成する場合、操作の名前はinvokeです。設定値を指定します。
電子メールエンドポイントに設定する設定値ごとに、CreateEndpointInfo
オブジェクトのsetConfigParameterAsText
メソッドを呼び出す必要があります。 例えば、smtpHost
設定値を設定するには、CreateEndpointInfo
オブジェクトのsetConfigParameterAsText
メソッドを呼び出し、次の値を渡します。
smtpHost
設定値を設定する場合は、smtpHost
を指定します。smtpHost
設定値を設定する場合は、SMTPサーバーの名前を指定するstring値を指定します。この節で紹介するEncryptDocumentサービスの設定値をすべて確認するには、QuickStartにある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
メソッドを呼び出し、createEndpoint
メソッドから返されたEndpoint
オブジェクトを渡して、エンドポイントを有効にします。
関連トピック
QuickStart:Java APIを使用した監視フォルダーエンドポイントの追加
QuickStart: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 RemotingAPI。
AEM FormsJava APIを使用すると、プログラムによってリモートエンドポイントをサービスに追加できます。 リモートエンドポイントを追加すると、Flexアプリケーションがリモート処理を使用してサービスを呼び出せるようになります。 (「AEM Formsの呼び出し(AEM formsでは廃止)」を参照)。AEM Formsリモート
プログラムによってリモートエンドポイントをサービスに追加する場合は、次のEncryptDocumentという短時間のみ有効なプロセスを検討してください。
このプロセスは、保護されていないPDFドキュメントを入力値として受け取り、保護されていないPDFドキュメントをEncryptionサービスのEncryptPDFUsingPassword
操作に渡します。 PDFドキュメントはパスワードを使用して暗号化され、パスワードを使用して暗号化されたPDFドキュメントはこのプロセスの出力値です。 入力値の名前(保護されていないPDFドキュメント)はInDoc
で、データタイプはcom.adobe.idp.Document
です。 出力値の名前(パスワードで暗号化されたPDFドキュメント)はSecuredDoc
で、データタイプはcom.adobe.idp.Document
です。
この節では、Remotingエンドポイントをサービスに追加する方法を示すために、EncryptDocumentという名前のサービスにリモートエンドポイントを追加します。
Webサービスを使用してリモートエンドポイントを追加することはできません。
エンドポイントをサービスから削除するには、次のタスクを実行します。
EndpointRegistryClient
オブジェクトを作成します。プロジェクトファイルを含める
必要なファイルを開発プロジェクトに含めます。 Javaを使用してクライアントアプリケーションを作成する場合は、必要なJARファイルを含めます。 Webサービスを使用している場合は、プロキシファイルを必ず含めます。
次のJARファイルをプロジェクトのクラスパスに追加する必要があります。
これらのJARファイルの場所について詳しくは、「AEM FormsJavaライブラリファイルを含める」を参照してください。
EndpointRegistry Clientオブジェクトの作成
プログラムによってリモートエンドポイントを追加するには、EndpointRegistryClient
オブジェクトを作成する必要があります。
リモートエンドポイント属性の設定
サービスのリモートエンドポイントを作成するには、次の値を指定します。
Remoting
を指定します。EncryptDocument
を指定します。リモートエンドポイントの作成
リモートエンドポイント属性を設定した後、サービスのリモートエンドポイントを作成できます。
エンドポイントの有効化
新しいエンドポイントを作成したら、そのエンドポイントを有効にする必要があります。 リモートエンドポイントが有効な場合、Flexクライアントがサービスを呼び出せるようにします。
関連トピック
Java APIを追加使用したリモートエンドポイント:
プロジェクトファイルを含めます。
Javaプロジェクトのクラスパスに、adobe-livecycle-client.jarなどのクライアントJARファイルを含めます。
EndpointRegistry Clientオブジェクトを作成します。
ServiceClientFactory
オブジェクトを作成します。EndpointRegistryClient
オブジェクトを渡して、ServiceClientFactory
オブジェクトを作成します。リモートエンドポイントの属性を設定します。
CreateEndpointInfo
オブジェクトを作成します。CreateEndpointInfo
オブジェクトのsetConnectorId
メソッドを呼び出し、文字列値Remoting
を渡して、コネクタ識別子の値を指定します。CreateEndpointInfo
オブジェクトのsetDescription
メソッドを呼び出し、エンドポイントを説明する文字列値を渡して、エンドポイントの説明を指定します。CreateEndpointInfo
オブジェクトのsetName
メソッドを呼び出し、名前を指定する文字列値を渡して、エンドポイントの名前を指定します。CreateEndpointInfo
オブジェクトのsetServiceId
メソッドを呼び出し、サービス名を指定する文字列値を渡して、エンドポイントが属するサービスを指定します。CreateEndpointInfo
オブジェクトのsetOperationName
メソッドによって呼び出される操作を指定し、操作名を指定する文字列値を渡します。 リモートエンドポイントには、ワイルドカード文字(*)を指定します。リモートエンドポイントを作成します。
EndpointRegistryClient
オブジェクトのcreateEndpoint
メソッドを呼び出し、CreateEndpointInfo
オブジェクトを渡して、エンドポイントを作成します。 このメソッドは、新しいリモートエンドポイントを表すEndpoint
オブジェクトを返します。
エンドポイントを有効にします。
EndpointRegistryClient
オブジェクトのenable
メソッドを呼び出し、createEndpoint
メソッドから返されたEndpoint
オブジェクトを渡して、エンドポイントを有効にします。
関連トピック
QuickStart:Java APIを使用したリモートエンドポイントの追加
プログラムでTaskManagerエンドポイントをサービスに追加するには、AEM FormsJava APIを使用します。 TaskManagerエンドポイントをサービスに追加することで、Workspaceユーザーがサービスを呼び出せるようにします。 つまり、Workspaceで作業しているユーザーは、対応するTaskManagerエンドポイントを持つプロセスを呼び出すことができます。
Webサービスを使用してTaskManagerエンドポイントを追加することはできません。
TaskManagerエンドポイントをサービスに追加するには、次のタスクを実行します。
EndpointRegistryClient
オブジェクトを作成します。プロジェクトファイルを含める
必要なファイルを開発プロジェクトに含めます。 Javaを使用してクライアントアプリケーションを作成する場合は、必要なJARファイルを含めます。 Webサービスを使用している場合は、プロキシファイルを必ず含めます。
次のJARファイルをプロジェクトのクラスパスに追加する必要があります。
これらのJARファイルの場所について詳しくは、「AEM FormsJavaライブラリファイルを含める」を参照してください。
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 Clientオブジェクトを作成します。
ServiceClientFactory
オブジェクトを作成します。EndpointRegistryClient
オブジェクトを渡して、ServiceClientFactory
オブジェクトを作成します。エンドポイントのカテゴリを作成します。
コンストラクターを使用し、次の値を渡して、CreateEndpointCategoryInfo
オブジェクトを作成します。
EndpointRegistryClient
オブジェクトのcreateEndpointCategory
メソッドを呼び出し、CreateEndpointCategoryInfo
オブジェクトを渡して、カテゴリを作成します。 このメソッドは、新しいカテゴリを表すEndpointCategory
オブジェクトを返します。
TaskManagerエンドポイント属性を設定します。
CreateEndpointInfo
オブジェクトを作成します。CreateEndpointInfo
オブジェクトのsetConnectorId
メソッドを呼び出し、文字列値TaskManagerConnector
を渡して、コネクタ識別子の値を指定します。CreateEndpointInfo
オブジェクトのsetDescription
メソッドを呼び出し、エンドポイントを説明する文字列値を渡して、エンドポイントの説明を指定します。CreateEndpointInfo
オブジェクトのsetName
メソッドを呼び出し、名前を指定する文字列値を渡して、エンドポイントの名前を指定します。CreateEndpointInfo
オブジェクトのsetServiceId
メソッドを呼び出し、サービス名を指定する文字列値を渡して、エンドポイントが属するサービスを指定します。CreateEndpointInfo
オブジェクトのsetCategoryId
メソッドを呼び出し、カテゴリ識別子の値を指定する文字列値を渡して、エンドポイントが属するカテゴリを指定します。 EndpointCategory
オブジェクトのgetId
メソッドを呼び出して、このカテゴリの識別子の値を取得できます。CreateEndpointInfo
オブジェクトのsetOperationName
メソッドを呼び出し、操作名を指定する文字列値を渡して、呼び出す操作を指定します。 通常、Workbenchで作成されたプロセスから派生するサービスのTaskManager
エンドポイントを作成する場合、操作の名前はinvoke
です。TaskManagerエンドポイントを作成します。
EndpointRegistryClient
オブジェクトのcreateEndpoint
メソッドを呼び出し、CreateEndpointInfo
オブジェクトを渡して、エンドポイントを作成します。 このメソッドは、新しいTaskManagerエンドポイントを表すEndpoint
オブジェクトを返します。
エンドポイントを有効にします。
EndpointRegistryClient
オブジェクトのenable
メソッドを呼び出し、createEndpoint
メソッドから返されたEndpoint
オブジェクトを渡して、エンドポイントを有効にします。
関連トピック
QuickStart:Java APIを使用したTaskManagerエンドポイントの追加
AEM FormsJava APIを使用して、既存のエンドポイントをプログラムで変更できます。 エンドポイントを変更すると、エンドポイントの動作を変更できます。 例えば、監視フォルダーとして使用されるフォルダーを指定する監視フォルダーエンドポイントがあるとします。 監視フォルダーエンドポイントに属する設定値をプログラムで変更すると、別のフォルダーが監視フォルダーとして機能するようになります。 監視フォルダーエンドポイントに属する設定値について詳しくは、「監視フォルダーエンドポイントの追加」を参照してください。
エンドポイントの変更方法を示すために、この節では、監視フォルダーとして動作するフォルダーを変更して監視フォルダーエンドポイントを変更します。
Webサービスを使用してエンドポイントを変更することはできません。
エンドポイントを変更するには、次のタスクを実行します。
EndpointRegistryClient
オブジェクトを作成します。プロジェクトファイルを含める
必要なファイルを開発プロジェクトに含めます。 Javaを使用してクライアントアプリケーションを作成する場合は、必要なJARファイルを含めます。 Webサービスを使用している場合は、プロキシファイルを必ず含めます。
次のJARファイルをプロジェクトのクラスパスに追加する必要があります。
これらのJARファイルの場所について詳しくは、「AEM FormsJavaライブラリファイルを含める」を参照してください。
EndpointRegistry Clientオブジェクトの作成
エンドポイントをプログラムで変更するには、EndpointRegistryClient
オブジェクトを作成する必要があります。
変更するエンドポイントの取得
エンドポイントを変更する前に、エンドポイントを取得する必要があります。 エンドポイントを取得するには、エンドポイントにアクセスできるユーザーとして接続する必要があります。 管理者として接続することをお勧めします。 (接続プロパティの設定を参照)。
エンドポイントのリストを取得するには、エンドポイントを取得します。 その後、削除する特定のエンドポイントを検索し、リストを繰り返し実行できます。 例えば、エンドポイントに対応するサービスとエンドポイントの種類を決定することで、エンドポイントを特定できます。 エンドポイントを見つけたら、そのエンドポイントを変更できます。
新しい設定値を指定する
エンドポイントを変更する場合は、新しい設定値を指定します。 例えば、監視フォルダーエンドポイントを変更するには、変更する値だけでなく、すべての監視フォルダーエンドポイントの設定値をリセットします。 監視フォルダーエンドポイントに属する設定値について詳しくは、「監視フォルダーエンドポイントの追加」を参照してください。
電子メールエンドポイントに属する設定値について詳しくは、電子メールエンドポイントの追加を参照してください。
エンドポイントによって呼び出されるサービスは変更できません。 サービスを変更しようとすると、例外が発生します。 特定のエンドポイントに関連付けられたサービスを変更するには、エンドポイントを削除し、新しいエンドポイントを作成します。 (「エンドポイントの削除」を参照)。
関連トピック
Java APIを使用してエンドポイントを変更します。
プロジェクトファイルを含めます。
Javaプロジェクトのクラスパスに、adobe-livecycle-client.jarなどのクライアントJARファイルを含めます。
EndpointRegistry Clientオブジェクトを作成します。
ServiceClientFactory
オブジェクトを作成します。EndpointRegistryClient
オブジェクトを渡して、ServiceClientFactory
オブジェクトを作成します。変更するエンドポイントを取得します。
EndpointRegistryClient
オブジェクトのgetEndpoints
メソッドを呼び出し、フィルターとして機能するPagingFilter
オブジェクトを渡します。 (PagingFilter)null
値を渡すと、すべてのエンドポイントを返すことができます。 このメソッドは、java.util.List
オブジェクトを返します。各要素はEndpoint
オブジェクトです。 PagingFilter
オブジェクトについて詳しくは、AEM FormsAPIリファレンスを参照してください。java.util.List
オブジェクトを繰り返し処理して、エンドポイントがあるかどうかを判断します。 エンドポイントが存在する場合、各要素はEndPoint
インスタンスになります。EndPoint
オブジェクトのgetServiceId
メソッドを呼び出して、エンドポイントに対応するサービスを特定します。 このメソッドは、サービス名を指定するstring値を返します。EndPoint
オブジェクトのgetConnectorId
メソッドを呼び出して、エンドポイントの種類を判断します。 このメソッドは、エンドポイントのタイプを指定するstring値を返します。 例えば、エンドポイントが監視フォルダーエンドポイントの場合、このメソッドはWatchedFolder
を返します。新しい設定値を指定します。
コンストラクターを呼び出して、ModifyEndpointInfo
オブジェクトを作成します。
設定する各設定値に対して、ModifyEndpointInfo
オブジェクトのsetConfigParameterAsText
メソッドを呼び出します。 例えば、url設定値を設定するには、ModifyEndpointInfo
オブジェクトのsetConfigParameterAsText
メソッドを呼び出し、次の値を渡します。
url
設定値を設定するには、url
を指定します。url
設定値の値を定義するには、監視フォルダーの場所を指定します。EndpointRegistryClient
オブジェクトのmodifyEndpoint
メソッドを呼び出し、ModifyEndpointInfo
オブジェクトを渡します。
関連トピック
QuickStart:Java APIを使用したエンドポイントの変更
AEM FormsJava APIを使用すると、プログラムによってエンドポイントをサービスから削除できます。 エンドポイントを削除すると、エンドポイントで有効になっている呼び出し方法を使用してサービスを呼び出すことはできません。 例えば、サービスからSOAPエンドポイントを削除する場合、SOAPモードを使用してサービスを呼び出すことはできません。
この節では、サービスからエンドポイントを削除する方法を示すために、EncryptDocumentという名前のサービスからEJBエンドポイントを削除します。
Webサービスを使用してエンドポイントを削除することはできません。
エンドポイントをサービスから削除するには、次のタスクを実行します。
EndpointRegistryClient
オブジェクトを作成します。プロジェクトファイルを含める
必要なファイルを開発プロジェクトに含めます。 Javaを使用してクライアントアプリケーションを作成する場合は、必要なJARファイルを含めます。 Webサービスを使用している場合は、プロキシファイルを必ず含めます。
次のJARファイルをプロジェクトのクラスパスに追加する必要があります。
これらのJARファイルの場所について詳しくは、「AEM FormsJavaライブラリファイルを含める」を参照してください。
EndpointRegistry Clientオブジェクトの作成
プログラムによってエンドポイントを削除するには、EndpointRegistryClient
オブジェクトを作成する必要があります。
削除するエンドポイントを取得します
エンドポイントを削除する前に、エンドポイントを取得する必要があります。 エンドポイントを取得するには、エンドポイントにアクセスできるユーザーとして接続する必要があります。 管理者として接続することをお勧めします。 (接続プロパティの設定を参照)。
エンドポイントのリストを取得するには、エンドポイントを取得します。 その後、削除する特定のエンドポイントを検索し、リストを繰り返し実行できます。 例えば、エンドポイントに対応するサービスとエンドポイントの種類を決定することで、エンドポイントを特定できます。 エンドポイントが見つかったら、削除できます。
エンドポイントの削除
新しいエンドポイントを作成したら、そのエンドポイントを有効にする必要があります。 エンドポイントが有効な場合は、サービスの呼び出しに使用できます。 エンドポイントを有効にした後、管理コンソール内で表示できます。
関連トピック
Java APIを使用したエンドポイントの削除:
プロジェクトファイルを含めます。
Javaプロジェクトのクラスパスに、adobe-livecycle-client.jarなどのクライアントJARファイルを含めます。
EndpointRegistry Clientオブジェクトを作成します。
ServiceClientFactory
オブジェクトを作成します。EndpointRegistryClient
オブジェクトを渡して、ServiceClientFactory
オブジェクトを作成します。削除するエンドポイントを取得します。
EndpointRegistryClient
オブジェクトのgetEndpoints
メソッドを呼び出し、フィルターとして機能するPagingFilter
オブジェクトを渡すことで、現在のユーザー(接続プロパティで指定)がアクセスできるすべてのエンドポイントのリストを取得します。 (PagingFilter)null
を渡すと、すべてのエンドポイントを返すことができます。 このメソッドは、java.util.List
オブジェクトを返します。各要素はEndpoint
オブジェクトです。java.util.List
オブジェクトを繰り返し処理して、エンドポイントがあるかどうかを判断します。 エンドポイントが存在する場合、各要素はEndPoint
インスタンスになります。EndPoint
オブジェクトのgetServiceId
メソッドを呼び出して、エンドポイントに対応するサービスを特定します。 このメソッドは、サービス名を指定するstring値を返します。EndPoint
オブジェクトのgetConnectorId
メソッドを呼び出して、エンドポイントの種類を判断します。 このメソッドは、エンドポイントのタイプを指定するstring値を返します。 例えば、エンドポイントがEJBエンドポイントの場合、このメソッドはEJB
を返します。エンドポイントを削除します。
EndpointRegistryClient
オブジェクトのremove
メソッドを呼び出し、削除するエンドポイントを表すEndPoint
オブジェクトを渡して、エンドポイントを削除します。
関連トピック
QuickStart:Java APIを使用したエンドポイントの削除
AEM FormsAPIを使用して、エンドポイントコネクタに関する情報をプログラムで取得できます。 コネクタは、エンドポイントが様々な呼び出し方法を使用してサービスを呼び出せるようにします。 例えば、監視フォルダーコネクターを使用すると、エンドポイントで監視フォルダーを使用したサービスの呼び出しが可能になります。 プログラムによってエンドポイントコネクタに関する情報を取得することで、必要な設定値や任意の設定値など、コネクタに関連付けられた設定値を取得できます。
エンドポイントコネクターに関する情報を取得する方法を説明するために、この節では監視フォルダーコネクターに関する情報を取得します。 (「監視フォルダーエンドポイントの追加」を参照)。
エンドポイントに関する情報は、Webサービスを使用して取得できません。
このトピックでは、ConnectorRegistryClient
APIを使用してエンドポイントコネクタに関する情報を取得します。 (「AEM FormsAPIリファレンス」を参照)。
エンドポイントコネクタ情報を取得するには、次のタスクを実行します。
ConnectorRegistryClient
オブジェクトを作成します。プロジェクトファイルを含める
必要なファイルを開発プロジェクトに含めます。 Javaを使用してクライアントアプリケーションを作成する場合は、必要なJARファイルを含めます。 Webサービスを使用している場合は、プロキシファイルを必ず含めます。
次のJARファイルをプロジェクトのクラスパスに追加する必要があります。
AEM FormsがJBoss以外のサポート対象のJ2EEアプリケーションサーバーにデプロイされている場合は、adobe-utilities.jarおよびjbossall-client.jarを、AEM FormsがデプロイされているJ2EEアプリケーションサーバーに固有のJARファイルに置き換えます。 すべてのAEM FormsJARファイルの場所については、「AEM FormsJavaライブラリファイルを含める」を参照してください。
ConnectorRegistry Clientオブジェクトの作成
プログラムによってエンドポイントコネクタ情報を取得するには、ConnectorRegistryClient
オブジェクトを作成します。
コネクタタイプを指定
情報を取得するコネクタの種類を指定します。 次のタイプのコネクタが存在します。
設定値の取得
コネクタの種類を指定すると、サポートされている設定値など、コネクタに関する情報を取得できます。 例えば、どのコネクタの設定値が必須でどの設定値がオプションかを指定できます。
関連トピック
Java APIを使用して、エンドポイントコネクタ情報を取得します。
プロジェクトファイルを含めます。.
Javaプロジェクトのクラスパスに、adobe-livecycle-client.jarなどのクライアントJARファイルを含めます。
ConnectorRegistry Clientオブジェクトを作成します。
ServiceClientFactory
オブジェクトを作成します。ConnectorRegistryClient
オブジェクトを渡すことによって、ServiceClientFactory
オブジェクトを作成します。コネクタタイプを指定します。
ConnectorRegistryClient
オブジェクトのgetEndpointDefinition
メソッドを呼び出し、コネクタの種類を指定する文字列値を渡して、コネクタの種類を指定します。 例えば、監視フォルダーのコネクタタイプを指定するには、文字列値WatchedFolder
を渡します。 このメソッドは、コネクタの種類に対応するEndpoint
オブジェクトを返します。
設定値を取得します。
Endpoint
オブジェクトのgetConfigParameters
メソッドを呼び出して、このエンドポイント内に関連付けられている設定値を取得します。 このメソッドは、ConfigParameter
オブジェクトの配列を返します。ConfigParameter
オブジェクトです。 例えば、ConfigParameter
オブジェクトのisRequired
メソッドを呼び出すことで、設定値が必須か任意かを判断できます。 設定値が必要な場合、このメソッドはtrue
を返します。関連トピック