REST - HTTPサービスの呼び出し
HTTPメソッドを指定してHTTPサーバーとの通信を行います。SSL通信を行う場合、管理コンソールで登録された証明書を使用してPKI基盤に従って通信を行います。
■ストリーム情報
| 入力 | フォーマット | Binary,Text,HTML,ParameterList,CSV,FixedLength,MIME,XML |
|---|---|---|
| 接続数 | 1 | |
| 説明 | HTTPメソッドがGET、DELETE以外の場合は送信データとなります。 GET、DELETEの場合は使用されません。 入力ストリーム型にParameterListを使用した場合は、各パラメータがフォームフィールドとして送られます。 |
|
| 出力 | フォーマット | XML,CSV,FixedLength,Text,HTML,Binary,MIME |
出力ストリーム変数
| 名前 | データ型 | 説明 |
|---|---|---|
| StatusCode | int | HTTPレスポンスのステータスコード |
■コンポーネントプロパティ
| 名前 | プロパティ型 | マッピング | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| コネクションを使用 | boolean | - |
接続先に以下のコネクション名を使用するかどうか選択します。
|
||||||||||||
| コネクション名 | connection | - | コネクションを使用が「はい」の場合に接続先のHTTPサーバーを指定します。 コネクションペインまたは管理コンソールにて作成したHTTP接続名を選択します。 | ||||||||||||
| コネクション情報 | group | - | コネクションを使用プロパティが「いいえ」の場合に使用されるプロパティ群です。 | ||||||||||||
| URL | string | 入力＆出力 |
取得するロケーションとしてのURLを設定します。 指定するURLは「 http(s)://～ 」の形式でフルパス指定します。 コネクションを使用が「いいえ」の場合にこの設定が参照されます。 |
||||||||||||
| URLエンコーディング | choice | 入力＆出力 |
URLやボディにパラメータを設定する際のエンコーディングを指定します。 コネクションを使用が「いいえ」の場合にこの設定が参照されます。URLのエンコーディングについては、下記トピック「URLのエンコーディングについて」を参照してください。 |
||||||||||||
| タイムアウト（秒） | int | 入力＆出力 |
リクエスト時およびコネクション接続時のタイムアウトまでの時間を秒単位で指定します。 コネクションを使用が「いいえ」の場合にこの設定が参照されます。 |
||||||||||||
| 認証 | group | - | コネクションを使用が「いいえ」の場合に使用される認証プロパティ群です。
サポートしている認証方式は以下の3つです。
|
||||||||||||
| ユーザー名 | string | 入力＆出力 |
接続先のサーバーで認証を行う場合のユーザー名を設定します。 コネクションを使用が「いいえ」の場合にこの設定が参照されます。 |
||||||||||||
| パスワード | password | 入力＆出力 |
接続先のサーバーで認証を行う場合のパスワードを設定します。 コネクションを使用が「いいえ」の場合にこの設定が参照されます。 |
||||||||||||
| プロキシー設定を使用 | boolean | - |
管理コンソールで設定したプロキシー設定を使用するかどうかを指定します。 コネクションを使用が「いいえ」の場合にこの設定が参照されます。
|
||||||||||||
| パス | string | 入力＆出力 | 取得するロケーションとしてのURLを設定します。 ここで指定したURL文字列は上記のコネクション名で指定されているURLに付加する形でリクエスト時に使用されます。 コネクションを使用が「はい」の場合にこの設定が参照されます。 | ||||||||||||
| HTTPメソッド | choice | - |
リクエストに使用するHTTPのメソッドを指定します。GET、POST、PUT、DELETE以外のメソッドは直接入力して指定します。
|
||||||||||||
| HTTPボディ | choice | - |
HTTPボディを指定します。
|
||||||||||||
| HTTPのバージョン | choice | - |
リクエストに使用するHTTPのバージョンを指定します。 HTTP/1.1 の場合 ヘッダーに Connection:close がヘッダーに強制的に設定されます。
|
||||||||||||
| リトライ回数 | int | 入力＆出力 | リクエスト時にHTTPサーバーに接続できなかったときに自動的にリトライするカウントを指定します。リトライしない場合は0を指定します。 | ||||||||||||
| リトライ間隔（秒） | int | 入力＆出力 | 上記リトライ時に再度接続リクエストを送るまでの間隔を秒単位で指定します。 | ||||||||||||
| リダイレクトを処理 | boolean | - |
サーバーからリダイレクト先が返されたときの処理の方法を設定できます。
|
||||||||||||
| URLパラメータ | category | 入力 | URLパラメータタブで指定したパラメータをURLのクエリーパラメータとして追加します。 | ||||||||||||
| 送信ヘッダー | category | 入力 | 送信ヘッダータブで指定したパラメータをHTTPヘッダーに載せて、HTTPリクエストを発行します。 | ||||||||||||
| 受信ヘッダー | category | 出力 | HTTPサーバーからのレスポンスを受信した際に、受信ヘッダータブに指定したパラメータに一致するヘッダー属性がある場合、そのヘッダー属性の値を受信ヘッダータブの指定したパラメータに設定して返します。また、このプロパティは自動的にストリーム変数になります。本コンポーネントの後に連結したマッパーで、ストリーム変数として見えるようになっています。ストリーム変数については、「はじめに」-「詳細なトピック」-「フローの構成要素」-「変数」-「ストリーム変数」を参照してください。 |
■トランザクション処理
| コミット | 何もしません。 |
|---|---|
| ロールバック | 何もしません。 |
■エラー処理
| タイプ | パラ メータ | エラー処理フロー へのストリーム | エラー コード | 説明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 汎用 | なし | コンポーネントの入力ストリーム | なし | コネクション名に指定したコネクションが見つからない場合 | |||||||||
| なし | HTTPサーバーに接続できない場合 | ||||||||||||
| HTTPException |
| サーバーから返されたHTTPレスポンスのMIME | HTTPレスポンスのステータスコード | HTTPサーバーがエラーを返した場合 |
■HTTPGet, HTTPPostコンポーネントとの違い
本コンポーネントはHTTPGet, HTTPPostコンポーネントの機能をすべて含んでおり、代替させることができます。それらのコンポーネントとの相違点は以下の通りです。
- HTTPメソッドを選択することができPUTとDELETEのリクエストが発行できる
- URLパラメータをプロパティで指定することができる
- レスポンスがJSONの場合にXMLに変換して出力することができる
- テストが実行できる
HTTPPostコンポーネントは右クリックメニューのコンポーネントの置き換えで完全に元の動作を引き継ぐことができますが、入力ストリームとしてParameterListを受けているHTTPGetコンポーネントの場合はパラメータの設定を「URLパラメータ」プロパティに設定し直す必要があります。
■フローの強制終了
フローを強制終了すると、通常は実行中のコンポーネントの処理が終了してから次のコンポーネントに制御が遷移する時点でフローがアボートしますが、本コンポーネントでは実行中の処理を強制的に終了してフローがアボートします。
■URLのエンコーディングについて
例えば、入力ストリームのParameterListの「param」というフィールドに「あいう」という値が設定されている場合、URLエンコーディングにShift_JISを指定するとPOSTするデータは以下のようになります。param=%82%A0%82%A2%82%A4URLエンコーディングに指定するエンコーディングの詳細についてはRFC1738をご参照ください。
■コネクションを使用するケース
コネクションを使用しない場合は接続先のURLに関する情報をすべてコンポーネントで設定しなければなりませんが、
コネクションを使用する場合は接続先ホストの基本情報をコネクションとして定義しておき「パス」プロパティとの組み合わせでURLを組み立てることができます。
例えば、コネクション定義でURLとして
http://SERVERNAME
のようにホスト名だけを指定しておき「パス」プロパティに「/page1.html」を指定することで
http://SERVERNAME/page1.html
に対してリクエストを実行することができます。
同一Webサーバーに対して複数のHTTPコンポーネントからアクセスする必要がある場合に
- そのWebサーバーが認証を必要とする
- そのWebサーバーが別のホストに変更される可能性がある
ようなケースではコネクションを使用する方が便利です。
■備考
-
タイムアウト（秒）でコネクション接続時のタイムアウトまでの時間を設定できますが、OSの管理するタイムアウトまでの時間を越える値を設定してもOSの管理するタイムアウトが優先されます。
たとえばOSの管理するタイムアウトまでの時間が30秒である場合に、タイムアウト（秒）に60秒を設定したとしても30秒でタイムアウトとなります。
■HTTPリクエストのテスト
本コンポーネントでは右クリックメニューの「テストの実行」またはコンポーネントのダブルクリックからHTTPリクエストのテストを実行することができます。
テストの実行ダイアログは以下の構成要素からなります。
- インスペクタ
ダイアログの表示時にはコンポーネントで設定されているプロパティ値が反映されています。
ここで行ったプロパティの変更は「プロパティのインポート」ボタンをクリックしない限りコンポーネントには反映されません。 - 「Body」タブ
POST、PUT時に送信するボディをテキストで入力できます。 - 「Request」タブ
テスト実行したリクエストのMIMEが表示されます - 「Response」タブ
テスト実行したレスポンスのMIMEが表示されます - 「テストの実行」ボタン
インスペクタの内容に従ってHTTPリクエストを実行します。
実行結果は「Request」タブと「Response」タブに表示されます。 - 「プロパティのインポート」ボタン
インスペクタで設定したプロパティの内容をコンポーネントに反映させます。 - 「POSTパラメータの設定」ボタン
HTTPメソッドがPOSTで直前のコンポーネントの出力ストリームがParameterListの場合にのみ有効になります。
ParameterListに定義されたフィールドの入力画面を表示し、入力された内容を「application/x-www-form-urlencoded」形式で「Body」タブに設定します。 - 「XMLフィールド定義のインポート」ボタン
レスポンスがXMLまたはJSONの場合は、その内容を出力ストリームのフィールド定義に反映させます。
JSONの場合は「json」を文書要素としたXMLに変換した上でインポートされます。 - 「閉じる」ボタン
ダイアログを閉じます。
テストの注意事項
- 送信ヘッダーにContent-Typeが設定されていない場合、テストのContent-TypeはBodyの設定内容によって
- text/xml; charset=utf-8 (Bodyの内容がXMLの場合)
- application/x-www-form-urlencoded (HTTPメソッドがPOSTで直前のコンポーネントの出力ストリームがParameterListの場合)
- text/plain; charset=utf-8 (Bodyの内容がそれ以外の文字列の場合)
一方、実行時のContent-Typeは入力ストリームの型に応じて自動設定されるので、両者をそろえたい場合は明示的に送信ヘッダーにContent-Typeを設定してください。 - Cookieなど一部のヘッダはテスト実行と実行時で異なることがあります。
- テストではプロパティ式は使用できません。