cRESTの標準プロパティ - Cloud - 8.0

Apache CXF (メディエーション)

Version
Cloud
8.0
Language
日本語
Product
Talend Data Fabric
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Real-Time Big Data Platform
Module
Talend Studio
Content
ジョブデザインと開発 > サードパーティーシステム > Apache CXFコンポーネント(メディエーション)
データガバナンス > サードパーティーシステム > Apache CXFコンポーネント(メディエーション)
データクオリティとプレパレーション > サードパーティーシステム > Apache CXFコンポーネント(メディエーション)
Last publication date
2024-02-22

これらのプロパティは、標準ジョブのフレームワークで実行されているcRESTを設定するために使われます。

Standard cRESTコンポーネントはConnectivityファミリーに属しています。

基本設定

[API Definition / Definition] (API定義 / 定義)

API定義の設定方法を選択します。

  • [Built-In] (組み込み): このコンポーネント用にAPI定義がローカルに設定されます。関連するすべての接続のプロパティ値を手動で指定する必要があります。

  • [Repository] (リポジトリー): [Repository] (リポジトリー) > [REST API Definitions] (REST API定義)に一元的に保存されているAPI定義がこのコンポーネントによって再利用されます。

    このチェックボックスの横にある[...]ボタンをクリックし、表示された [Repository Content] (リポジトリーの内容)ダイアログボックスで、再利用するAPI定義を選択すると、関連するすべてのプロパティに値が自動的に入力されます。

Talendが提供するR2023-05以降のTalend Studioマンスリーアップデートをインストール済みである場合は、[Repository] (リポジトリー)ツリービューのMetadataノードからデザインワークスペースにREST API定義をドラッグ&ドロップすることでcRESTコンポーネントを作成できます。

[Endpoint] (エンドポイント)

RESTサービスが提供されるサービスエンドポイントURL。"http://localhost:8088/services/customers"のように明示的なポート番号を指定するか、Talendのデフォルトポートを使い、"/services/customers"のように相対パスのみを指定します。

デフォルトポートは、ビルドタイプや、サービスを実行する場所によって異なります。
  • Talend Studio内でサービスを実行するには: 8090
  • Talend Runtime Container内でサービスを実行するには: HTTP 8040はすべてのサービスに使われるためです。また、HTTPSが Talend Runtimeで有効な場合、サービスは9001でも公開されます。
  • サービスをMicroserviceとして実行するには: 8065

エンドポイントはコンテキスト変数を使って定義できます。Talend Studioマンスリーアップデートの詳細は、管理者にお問い合わせください。

タイプ

RESTサービスを提供するために使うタイプを選択します。[Manual] (手動)またはresourceClassのいずれか。

[Manual] (手動): cRESTがサービスプロバイダーとして使われている場合は、REST APIマッピングをテーブルで手動で決定するか、コンポーネントがサービスコンシューマーとして使われている場合は、HTTPメソッドとその他のパラメーターを設定します。

resourceClass: RESTサービスとしてエクスポートするリソースクラスを提供するには、このタイプを選択します。

[REST API mapping] (REST APIマッピング)

このテーブルは、[Manual] (手動)サービスタイプが選択され、cRESTがサービスプロバイダーとして使われている場合に表示されます。

テーブルの下にある[+]をクリックして必要な数の行を追加し、HTTPリクエストを指定します。

[Output Flow] (出力フロー): 出力フローの名前を指定します。

[HTTP Verb] (HTTP動詞): リスト内のGETPOSTPUTDELETEOPTIONSHEADPATCHからHTTPメソッドを選択します。

[URI pattern] (URIパターン): リソースを説明するREST URIをこのフィルターに入力します。

[Consumes] (コンシューム): [HTTP Verb] (HTTP動詞)POSTまたはPUTPATCHの場合は、コンポーネントが使うコンシュームコンテンツの形式タイプを、[XML or JSON] (XMLまたはJSON)XMLJSONFormMultipartAnyから選択します。

[Produces] (プロデュース): HTTP VerbGETPOSTPUT、またはDELETEPATCH場合は、コンポーネントが使うプロデュースコンテンツの形式タイプを、[XML or JSON] (XMLまたはJSON)XMLJSONHTMLAnyから選択します。

[Bean class] (Beanクラス): [HTTP Verb] (HTTP動詞)POSTPUTPATCHのいずれかであり、コンシュームコンテンツの形式が[XML or JSON] (XMLまたはJSON)XMLJSONのいずれかである場合は、Beanクラスを設定します。

[Resource Class] (リソースクラス)

このフィールドは、resourceClassサービスタイプを選択すると表示されます。RESTサービスとしてエクスポートするリソースクラスの名前を入力します。

[Operation] (操作)

このフィールドは、resourceClassサービスタイプを選択し、サービスコンシューマーとしてcRESTを使っている場合に表示されます。操作の名前を入力します。

[Relative Path] (相対パス)

このフィールドは、[Manual] (手動)サービスタイプを選択し、サービスコンシューマーとしてcRESTを使っている場合に表示されます。呼び出すRESTサーバーの相対パスを入力します。

[HTTP Method] (HTTPメソッド)

このオプションは、[Manual] (手動)サービスタイプを選択し、サービスコンシューマーとしてcRESTを使っている場合に表示されます。リスト内のGETPOSTPUTDELETEPATCHHEADOPTIONSからHTTPメソッドを選択します。
警告:

POSTメソッドを使ってオブジェクトを作成する場合、デフォルトでは、作成されたオブジェクトIDはヘッダーから返されません。デフォルトでは、cRESTはシステムヘッダーを除くすべてのヘッダーをフィルタリングします。作成されたオブジェクトIDを取得するには、javax.ws.rs.core.Responseをレスポンスクラスとして設定する必要があります 。

[Content Type] (コンテンツタイプ)

このオプションは、[Manual] (手動)サービスタイプを選択し、サービスコンシューマーとしてcRESTを使っている場合に表示されます。

サーバーエンドにアップロードするコンテンツのメディアタイプに応じて、[XML][JSON][FORM]のいずれかを選択します。このリストは、[HTTP Method] (HTTPメソッド)リストでPOSTPUTPATCHのいずれかを選択した場合にのみ表示されます。

[Accept Type] (許可タイプ)

このフィールドは、[Manual] (手動)サービスタイプを選択し、サービスコンシューマーとしてcRESTを使っている場合に表示されます。

クライアントエンドで、サーバーエンドからの受信を許可するレスポンスのメディアタイプを選択します。オプションには、[XML][JSON][ANY] (すべて)があります。[ANY] (すべて)を選択すると、すべてのタイプのレスポンスメールを受け入れ、文字列に変換します。このリストは、DELETEメソッドを選択した場合は表示されません。

[Response Class] (レスポンスクラス)

このフィールドは、[Manual] (手動)サービスタイプを選択し、サービスコンシューマーとしてcRESTを使っている場合に表示されます。レスポンスクラスの名前を入力します。

[Skip incoming data unmarshalling] (受信データのマーシャリング解除を省略)

このチェックボックスをオンにすると、サーバーレスポンスデータのマーシャリング解除を省略できます。このオプションは、ルートが動作できるデータをサーバーが既に提供し、型変換の必要性を回避できる場合に使われます。

Service Locatorを使用

このチェックボックスをオンにすると、Service Locatorが有効になります。サービスネームスペースとサービス名をそれぞれのフィールドに指定します。

Service Activity Monitoringを有効化

サービスアクティビティモニタリングを有効にするには、このチェックボックスをオンにします。

このオプションはランタイムでのみ使えます。Talend Studioでルートを実行する場合は、このチェックボックスをオフにすることをお勧めします。オンにしていると、実行コンソールに警告が表示されます。

[Use Authentication] (認証を使用)

認証オプションを有効にするには、このチェックボックスをオンにします。認証タイプを以下から選択します。

  • [HTTP Basic] (HTTPベーシック): HTTPヘッダーに標準フィールドを使ってWebリソースへのアクセス制御を強制する最も単純な手法です。
  • [SAML Token (ESB runtime only)] (SAMLトークン (ESB Runtimeのみ)): IDプロバイダーとサービスプロバイダーの間で認証データを交換するための、XMLベースでオープン標準のデータ形式。
  • [Open ID Connect] (ID接続を開く): OAuth2の拡張機能で、クライアントは認証サーバーによって実行される認証に基づいてエンドユーザーのIDを確認したり、エンドユーザーに関する基本的なプロファイル情報を相互運用可能なRESTに類似した方法で入手したりできます。詳細は、Talend Identity and Access ManagementおよびESBリソースと認証の管理をご覧ください。

cRESTコンポーネントがコンシューマーとして使われている場合は、必要に応じてユーザー名とパスワードをそれぞれのフィールドに入力します。パスワードを入力するには、パスワードフィールドの横にある[...]ボタンをクリックし、ポップアップダイアログボックスにパスワードを二重引用符の間に入力し、[OK] をクリックして設定を保存します。

[Use Authorization] (認証サービスを使用)

このオプションは、Talend Enterprise ESBソリューションをサブスクライブしている場合のみ利用可能です。[Use Authentication] (認証を使用)リストで[SAML Token (ESB runtime only)] (SAMLトークン(ESB Runtimeのみ))を選択すると表示されます。

cRESTコンポーネントをサービスプロバイダーとして使う場合は、このチェックボックスをオンにして認証を有効にします。

cRESTコンポーネントをサービスコンシューマーとして使う場合は、このチェックボックスをオンにして許可された呼び出しを有効にし、[Role] (ロール)フィールドにクライアントのロールを指定します。

[Use Business Correlation] (ビジネスコリレーションを使用)

このチェックボックスをオンにしてこのコンポーネントにコリレーションIDを作成します。

コリレーションIDは[Correlation Value] (コリレーション値)フィールドで指定できます。

詳細設定

[Log messages] (ログメッセージ)

ルートのメッセージ交換を記録するには、このチェックボックスをオンにします。

引数 オプションの引数を対応するテーブルに設定します。[+]を必要な回数だけクリックして、テーブルに引数を追加します。次に、対応する[Value] (値)フィールドをクリックして、値を入力します。利用可能なURIオプションは、http://camel.apache.org/cxfrs.htmlを参照してください。

使用方法

使用ルール

cRESTは、サービスプロバイダーとしてルートの開始コンポーネント、またはサービスコンシューマーとして中間または終了コンポーネントにできます。

制限事項

ライセンスの互換性の問題のため、このコンポーネントの使用に必要な1つ以上のJARが提供されていません。この特定のコンポーネントに不足しているJARをインストールするには、Component (コンポーネント)タブビューの[Install] (インストール)ボタンをクリックします。Talend StudioIntegrationパースペクティブにある[Modules] (モジュール)タブでも、不足しているすべてのJARを簡単に見つけて追加できます。詳細は、外部モジュールをインストールをご覧ください。