コンストラクタの概要

HttpClient (Object [parameters])
コンストラクタ。HttpClient を作成します。

プロパティの概要

プロパティ名 アクセス権
HttpClientCookie[] cookieStore
クッキーストア。
通常

メソッドの概要

返却値の型 メソッド名
Boolean close ()
関連するすべてのリソースを解放します。
HttpClientResult doDelete (String url, Object [parameters])
DELETE リクエストを実行します。
HttpClientResult get (String url, Object [parameters])
GET リクエストを実行します。
HttpClientResult head (String url, Object [parameters])
HEAD リクエストを実行します。
HttpClientResult options (String url, Object [parameters])
OPTIONS リクエストを実行します。
HttpClientResult patch (String url, Object [parameters])
PATCH リクエストを実行します。
HttpClientResult post (String url, Object [parameters])
POST リクエストを実行します。
HttpClientResult put (String url, Object [parameters])
PUT リクエストを実行します。

コンストラクタの詳細

HttpClient (Object [parameters])
コンストラクタ。HttpClient を作成します。
以下のようにして、パラメータを指定してください。
var client = new HttpClient({
  'connection-request-timeout-millis': 30 * 1000, // 省略可
  'connect-timeout-millis': 30 * 1000, // 省略可
  'socket-timeout-millis': 30 * 1000, // 省略可
  'redirects-enabled': true, // 省略可
  'max-redirects': 10, // 省略可
  'ignore-ssl-errors': true // 省略可
});
connection-request-timeout-millis
接続を要求する際のタイムアウト値(単位:ミリ秒)
connect-timeout-millis
コネクションタイムアウト値(単位:ミリ秒)
socket-timeout-millis
ソケットタイムアウト値(単位:ミリ秒)
redirects-enabled
リダイレクトを有効化するかどうか
max-redirects
リダイレクトの最大数
ignore-ssl-errors
true を指定した場合、SSL 証明書のエラーを無視します
このパラメータは intra-mart Accel Platform 2016 Summer (Nirvana) 以降で利用可能です
パラメータ
[parameters] : Object
パラメータ

プロパティの詳細

HttpClientCookie[] cookieStore 通常
クッキーストア。

メソッドの詳細

Boolean close ()
関連するすべてのリソースを解放します。
返却値
Boolean
Boolean 失敗した場合は false。
HttpClientResult doDelete (String url, Object [parameters])
DELETE リクエストを実行します。
パラメータ
url : String
リクエストを送信するURL
[parameters] : Object
パラメータ
{
    headers: { // ヘッダーを送信したい場合、headers プロパティーにキーバリュー形式で値を設定してください。省略可。
        'Authorization': 'Basic dXNlcjpwYXNzd29yZA==',
        'x-my-request-header': 'my-request-header-value'
    },
    body: { // パラメータを送信したい場合、body プロパティーにキーバリュー形式で値を設定してください。省略可。
        'api_key': 'my api key',
        'my_value': 'my value'
    },
    'default-charset': 'Shift_JIS' // リクエストの文字コードを明示的に指定する場合。省略可。
}
返却値
HttpClientResult
HttpClientResult 結果
HttpClientResult get (String url, Object [parameters])
GET リクエストを実行します。
パラメータ
url : String
リクエストを送信するURL
[parameters] : Object
パラメータ
{
    headers: { // ヘッダーを送信したい場合、headers プロパティーにキーバリュー形式で値を設定してください。省略可。
        'Authorization': 'Basic dXNlcjpwYXNzd29yZA==',
        'x-my-request-header': 'my-request-header-value'
    },
    body: { // パラメータを送信したい場合、body プロパティーにキーバリュー形式で値を設定してください。省略可。
        'api_key': 'my api key',
        'my_value': 'my value'
    },
    'default-charset': 'Shift_JIS' // リクエストの文字コードを明示的に指定する場合。省略可。
}
返却値
HttpClientResult
HttpClientResult 結果
HttpClientResult head (String url, Object [parameters])
HEAD リクエストを実行します。
パラメータ
url : String
リクエストを送信するURL
[parameters] : Object
パラメータ
{
    headers: { // ヘッダーを送信したい場合、headers プロパティーにキーバリュー形式で値を設定してください。省略可。
        'Authorization': 'Basic dXNlcjpwYXNzd29yZA==',
        'x-my-request-header': 'my-request-header-value'
    },
    body: { // パラメータを送信したい場合、body プロパティーにキーバリュー形式で値を設定してください。省略可。
        'api_key': 'my api key',
        'my_value': 'my value'
    },
    'default-charset': 'Shift_JIS' // リクエストの文字コードを明示的に指定する場合。省略可。
}
返却値
HttpClientResult
HttpClientResult 結果
HttpClientResult options (String url, Object [parameters])
OPTIONS リクエストを実行します。
パラメータ
url : String
リクエストを送信するURL
[parameters] : Object
パラメータ。以下のようなオブジェクトを指定します。
{
    headers: { // ヘッダーを送信したい場合、headers プロパティーにキーバリュー形式で値を設定してください。省略可。
        'Authorization': 'Basic dXNlcjpwYXNzd29yZA==',
        'x-my-request-header': 'my-request-header-value'
    },
    body: { // パラメータを送信したい場合、body プロパティーにキーバリュー形式で値を設定してください。省略可。
        'api_key': 'my api key',
        'my_value': 'my value'
    },
    'default-charset': 'Shift_JIS' // リクエストの文字コードを明示的に指定する場合。省略可。
}
返却値
HttpClientResult
HttpClientResult 結果
HttpClientResult patch (String url, Object [parameters])
PATCH リクエストを実行します。
パラメータ
url : String
リクエストを送信するURL
[parameters] : Object
パラメータ
  • 非マルチパートな場合(application/json の例)
    {
        headers: { // ヘッダーを送信したい場合、headers プロパティーにキーバリュー形式で値を設定してください。省略可。
            'Content-Type': 'application/json' // Content-Type: application/json でリクエストを送信します。default-charset プロパティではなく、こちらに「'Content-Type': 'application/json; charset=UTF-8'」などと指定することで、リクエストの文字コードを指定することも可能です。
        },
        body: ImJson.toJSONString({ // 文字列を送信したい場合、body プロパティーに文字列を設定してください。省略可。
            'api_key': 'my api key',
            'my_value': '値'
        }),
        'default-charset': 'UTF-8' // 非マルチパートなリクエストのデフォルトの文字コードを指定。省略可。
    }
  • 非マルチパートな場合(application/x-www-form-urlencoded の例)
    {
        headers: { // ヘッダーを送信したい場合、headers プロパティーにキーバリュー形式で値を設定してください。省略可。
            'x-my-request-header': 'my header value' // body にマップを渡した場合、「Content-Type: application/x-www-form-urlencoded」ヘッダーは自動で付与されます
        },
        body: { // body にキーバリュー形式でマップを渡した場合、application/x-www-form-urlencoded 形式でリクエストを送信します。省略可。
            'api_key': 'my api key', // 値には文字列か、
            'my_values': ['値1', '値2', '値3'] // 文字列の配列を指定できます
        },
        'default-charset': 'UTF-8' // 非マルチパートなリクエストのデフォルトの文字コードを指定。省略可。
    }
  • マルチパートな場合(multipart/form-data の例)
    {
        headers: { // ヘッダーを送信したい場合、headers プロパティーにキーバリュー形式で値を設定してください。省略可。
            'x-my-request-header': 'my header value' // multipart なリクエストの場合、「Content-Type: multipart/form-data」ヘッダーは自動で付与されます
        },
        body: {
            text_part1: 'テキスト1',
            text_part2: ['テキスト2', 'text/plain'], // [テキスト, Content-Type] の形式で指定できます
            text_part3: ['テキスト3', 'text/plain; charset=UTF-8'], // [テキスト, Content-Type] の形式で指定できます。文字コードを指定したい場合このように Content-Type に指定してください
            binary_part1: new PublicStorage('test1.bin'), // Storage インスタンスを渡せます
            binary_part2: new PublicStorage('test2.bin').openAsBinary(), // ByteReader インスタンスを渡せます
            binary_part3: [new PublicStorage('test3.bin'), 'application/octet-stream', 'test3.bin'], // [Storage もしくは File インスタンス, Content-Type, ファイル名] の形式で指定できます
            binary_part4: new File('/tmp/test4.bin') // File インスタンスも渡せます
        },
        multipart: true // マルチパートリクエスト時にこのフラグを true に設定してください
    }
  • 返却値
    HttpClientResult
    HttpClientResult 結果
    HttpClientResult post (String url, Object [parameters])
    POST リクエストを実行します。
    パラメータ
    url : String
    リクエストを送信するURL
    [parameters] : Object
    パラメータ
  • 非マルチパートな場合(application/json の例)
    {
        headers: { // ヘッダーを送信したい場合、headers プロパティーにキーバリュー形式で値を設定してください。省略可。
            'Content-Type': 'application/json' // Content-Type: application/json でリクエストを送信します。default-charset プロパティではなく、こちらに「'Content-Type': 'application/json; charset=UTF-8'」などと指定することで、リクエストの文字コードを指定することも可能です。
        },
        body: ImJson.toJSONString({ // 文字列を送信したい場合、body プロパティーに文字列を設定してください。省略可。
            'api_key': 'my api key',
            'my_value': '値'
        }),
        'default-charset': 'UTF-8' // 非マルチパートなリクエストのデフォルトの文字コードを指定。省略可。
    }
  • 非マルチパートな場合(application/x-www-form-urlencoded の例)
    {
        headers: { // ヘッダーを送信したい場合、headers プロパティーにキーバリュー形式で値を設定してください。省略可。
            'x-my-request-header': 'my header value' // body にマップを渡した場合、「Content-Type: application/x-www-form-urlencoded」ヘッダーは自動で付与されます
        },
        body: { // body にキーバリュー形式でマップを渡した場合、application/x-www-form-urlencoded 形式でリクエストを送信します。省略可。
            'api_key': 'my api key', // 値には文字列か、
            'my_values': ['値1', '値2', '値3'] // 文字列の配列を指定できます
        },
        'default-charset': 'UTF-8' // 非マルチパートなリクエストのデフォルトの文字コードを指定。省略可。
    }
  • マルチパートな場合(multipart/form-data の例)
    {
        headers: { // ヘッダーを送信したい場合、headers プロパティーにキーバリュー形式で値を設定してください。省略可。
            'x-my-request-header': 'my header value' // multipart なリクエストの場合、「Content-Type: multipart/form-data」ヘッダーは自動で付与されます
        },
        body: {
            text_part1: 'テキスト1',
            text_part2: ['テキスト2', 'text/plain'], // [テキスト, Content-Type] の形式で指定できます
            text_part3: ['テキスト3', 'text/plain; charset=UTF-8'], // [テキスト, Content-Type] の形式で指定できます。文字コードを指定したい場合このように Content-Type に指定してください
            binary_part1: new PublicStorage('test1.bin'), // Storage インスタンスを渡せます
            binary_part2: new PublicStorage('test2.bin').openAsBinary(), // ByteReader インスタンスを渡せます
            binary_part3: [new PublicStorage('test3.bin'), 'application/octet-stream', 'test3.bin'], // [Storage もしくは File インスタンス, Content-Type, ファイル名] の形式で指定できます
            binary_part4: new File('/tmp/test4.bin') // File インスタンスも渡せます
        },
        multipart: true // マルチパートリクエスト時にこのフラグを true に設定してください
    }
  • 返却値
    HttpClientResult
    HttpClientResult 結果
    HttpClientResult put (String url, Object [parameters])
    PUT リクエストを実行します。
    パラメータ
    url : String
    リクエストを送信するURL
    [parameters] : Object
    パラメータ
  • 非マルチパートな場合(application/json の例)
    {
        headers: { // ヘッダーを送信したい場合、headers プロパティーにキーバリュー形式で値を設定してください。省略可。
            'Content-Type': 'application/json' // Content-Type: application/json でリクエストを送信します。default-charset プロパティではなく、こちらに「'Content-Type': 'application/json; charset=UTF-8'」などと指定することで、リクエストの文字コードを指定することも可能です。
        },
        body: ImJson.toJSONString({ // 文字列を送信したい場合、body プロパティーに文字列を設定してください。省略可。
            'api_key': 'my api key',
            'my_value': '値'
        }),
        'default-charset': 'UTF-8' // 非マルチパートなリクエストのデフォルトの文字コードを指定。省略可。
    }
  • 非マルチパートな場合(application/x-www-form-urlencoded の例)
    {
        headers: { // ヘッダーを送信したい場合、headers プロパティーにキーバリュー形式で値を設定してください。省略可。
            'x-my-request-header': 'my header value' // body にマップを渡した場合、「Content-Type: application/x-www-form-urlencoded」ヘッダーは自動で付与されます
        },
        body: { // body にキーバリュー形式でマップを渡した場合、application/x-www-form-urlencoded 形式でリクエストを送信します。省略可。
            'api_key': 'my api key', // 値には文字列か、
            'my_values': ['値1', '値2', '値3'] // 文字列の配列を指定できます
        },
        'default-charset': 'UTF-8' // 非マルチパートなリクエストのデフォルトの文字コードを指定。省略可。
    }
  • マルチパートな場合(multipart/form-data の例)
    {
        headers: { // ヘッダーを送信したい場合、headers プロパティーにキーバリュー形式で値を設定してください。省略可。
            'x-my-request-header': 'my header value' // multipart なリクエストの場合、「Content-Type: multipart/form-data」ヘッダーは自動で付与されます
        },
        body: {
            text_part1: 'テキスト1',
            text_part2: ['テキスト2', 'text/plain'], // [テキスト, Content-Type] の形式で指定できます
            text_part3: ['テキスト3', 'text/plain; charset=UTF-8'], // [テキスト, Content-Type] の形式で指定できます。文字コードを指定したい場合このように Content-Type に指定してください
            binary_part1: new PublicStorage('test1.bin'), // Storage インスタンスを渡せます
            binary_part2: new PublicStorage('test2.bin').openAsBinary(), // ByteReader インスタンスを渡せます
            binary_part3: [new PublicStorage('test3.bin'), 'application/octet-stream', 'test3.bin'], // [Storage もしくは File インスタンス, Content-Type, ファイル名] の形式で指定できます
            binary_part4: new File('/tmp/test4.bin') // File インスタンスも渡せます
        },
        multipart: true // マルチパートリクエスト時にこのフラグを true に設定してください
    }
  • 返却値
    HttpClientResult
    HttpClientResult 結果