HttpComponentsHttpInvokerRequestExecutor (Spring Framework 5.2.9.RELEASE API)

java.lang.ObjectSE
- org.springframework.remoting.httpinvoker.AbstractHttpInvokerRequestExecutor
- - org.springframework.remoting.httpinvoker.HttpComponentsHttpInvokerRequestExecutor

実装されているすべてのインターフェース:
Aware, BeanClassLoaderAware, HttpInvokerRequestExecutor
```
public class HttpComponentsHttpInvokerRequestExecutor
extends AbstractHttpInvokerRequestExecutor
```
Apache HttpComponents HttpClient を使用して POST リクエストを実行する HttpInvokerRequestExecutor 実装。
事前に構成された HttpClient インスタンスを使用できるようにします。認証、HTTP 接続プールなどを使用することもできます。また、特定のテンプレートメソッドを提供して、サブクラス化が容易になるように設計されています。
Spring 4.1 の時点で、このリクエスト実行者には Apache HttpComponents 4.3 以上が必要です。
導入:
3.1
作成者:
Juergen Hoeller, Stephane Nicoll
関連事項:
SimpleHttpInvokerRequestExecutor

フィールドのサマリー
- クラス org.springframework.remoting.httpinvoker.AbstractHttpInvokerRequestExecutor から継承されたフィールド
  CONTENT_TYPE_SERIALIZED_OBJECT, ENCODING_GZIP, HTTP_HEADER_ACCEPT_ENCODING, HTTP_HEADER_ACCEPT_LANGUAGE, HTTP_HEADER_CONTENT_ENCODING, HTTP_HEADER_CONTENT_LENGTH, HTTP_HEADER_CONTENT_TYPE, HTTP_METHOD_POST, logger

コンストラクターの概要

コンストラクター
コンストラクターと説明
`HttpComponentsHttpInvokerRequestExecutor()` デフォルトの `org.apache.http.impl.conn.PoolingClientConnectionManager` を使用するデフォルトの `HttpClient` を使用して、HttpComponentsHttpInvokerRequestExecutor の新しいインスタンスを作成します。
`HttpComponentsHttpInvokerRequestExecutor(HttpClient httpClient)` 指定された `HttpClient` インスタンスを使用して、HttpComponentsClientHttpRequestFactory の新しいインスタンスを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected HttpPost`	`createHttpPost(HttpInvokerClientConfiguration config)` 指定された構成の HttpPost を作成します。
`protected RequestConfig`	`createRequestConfig(HttpInvokerClientConfiguration config)` 指定された構成の `RequestConfig` を作成します。
`protected RemoteInvocationResult`	`doExecuteRequest(HttpInvokerClientConfiguration config, ByteArrayOutputStreamSE baos)` HttpClient を介して指定されたリクエストを実行します。
`protected org.apache.http.HttpResponse`	`executeHttpPost(HttpInvokerClientConfiguration config, HttpClient httpClient, HttpPost httpPost)` 指定された HttpPost インスタンスを実行します。
`HttpClient`	`getHttpClient()` このリクエストエグゼキュータが使用する `HttpClient` インスタンスを返します。
`protected InputStreamSE`	`getResponseBody(HttpInvokerClientConfiguration config, org.apache.http.HttpResponse httpResponse)` 指定された実行済みのリモート呼び出しリクエストからレスポンス本文を抽出します。
`protected boolean`	`isGzipResponse(org.apache.http.HttpResponse httpResponse)` 指定されたレスポンスが GZIP レスポンスを示しているかどうかを判別します。
`void`	`setConnectionRequestTimeout(int connectionRequestTimeout)` 基礎となる HttpClient を使用して接続マネージャーから接続をリクエストするときに使用されるタイムアウトをミリ秒単位で設定します。
`void`	`setConnectTimeout(int timeout)` 基になる HttpClient の接続タイムアウトを設定します。
`void`	`setHttpClient(HttpClient httpClient)` このリクエストエグゼキュータに使用する `HttpClient` インスタンスを設定します。
`void`	`setReadTimeout(int timeout)` 基になる HttpClient のソケット読み取りタイムアウトを設定します。
`protected void`	`setRequestBody(HttpInvokerClientConfiguration config, HttpPost httpPost, ByteArrayOutputStreamSE baos)` 指定された直列化されたリモート呼び出しをリクエスト本文として設定します。
`protected void`	`validateResponse(HttpInvokerClientConfiguration config, org.apache.http.HttpResponse response)` 指定されたレスポンスを HttpPost オブジェクトに含まれているものとして検証し、成功した HTTP レスポンスに対応していない場合は例外をスローします。

クラス org.springframework.remoting.httpinvoker.AbstractHttpInvokerRequestExecutor から継承されたメソッド
createObjectInputStream, decorateInputStream, decorateOutputStream, doReadRemoteInvocationResult, doWriteRemoteInvocation, executeRequest, getBeanClassLoader, getByteArrayOutputStream, getContentType, isAcceptGzipEncoding, readRemoteInvocationResult, setAcceptGzipEncoding, setBeanClassLoader, setContentType, writeRemoteInvocation

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - HttpComponentsHttpInvokerRequestExecutor
```
public HttpComponentsHttpInvokerRequestExecutor()
```
    デフォルトの org.apache.http.impl.conn.PoolingClientConnectionManager を使用するデフォルトの HttpClient を使用して、HttpComponentsHttpInvokerRequestExecutor の新しいインスタンスを作成します。
  - HttpComponentsHttpInvokerRequestExecutor
```
public HttpComponentsHttpInvokerRequestExecutor(HttpClient httpClient)
```
    指定された HttpClient インスタンスを使用して、HttpComponentsClientHttpRequestFactory の新しいインスタンスを作成します。
    パラメーター:
    httpClient - このリクエストエグゼキュータに使用する HttpClient インスタンス
- メソッドの詳細
  - setHttpClient
```
public void setHttpClient(HttpClient httpClient)
```
    このリクエストエグゼキュータに使用する HttpClient インスタンスを設定します。
  - getHttpClient
```
public HttpClient getHttpClient()
```
    このリクエストエグゼキュータが使用する HttpClient インスタンスを返します。
  - setConnectTimeout
```
public void setConnectTimeout(int timeout)
```
    基になる HttpClient の接続タイムアウトを設定します。タイムアウト値 0 は、無限のタイムアウトを指定します。
    カスタム HttpClient で RequestConfig インスタンスを指定することにより、追加のプロパティを設定できます。
    パラメーター:
    timeout - ミリ秒単位のタイムアウト値
    関連事項:
    RequestConfig.getConnectTimeout()
  - setConnectionRequestTimeout
```
public void setConnectionRequestTimeout(int connectionRequestTimeout)
```
    基礎となる HttpClient を使用して接続マネージャーから接続をリクエストするときに使用されるタイムアウトをミリ秒単位で設定します。タイムアウト値 0 は、無限のタイムアウトを指定します。
    カスタム HttpClient で RequestConfig インスタンスを指定することにより、追加のプロパティを設定できます。
    パラメーター:
    connectionRequestTimeout - ミリ秒単位の接続をリクエストするタイムアウト値
    関連事項:
    RequestConfig.getConnectionRequestTimeout()
  - setReadTimeout
```
public void setReadTimeout(int timeout)
```
    基になる HttpClient のソケット読み取りタイムアウトを設定します。タイムアウト値 0 は、無限のタイムアウトを指定します。
    カスタム HttpClient で RequestConfig インスタンスを指定することにより、追加のプロパティを設定できます。
    パラメーター:
    timeout - ミリ秒単位のタイムアウト値
    関連事項:
    DEFAULT_READ_TIMEOUT_MILLISECONDS, RequestConfig.getSocketTimeout()
  - doExecuteRequest
```
protected RemoteInvocationResult doExecuteRequest(HttpInvokerClientConfiguration config,
                                                  ByteArrayOutputStreamSE baos)
                                           throws IOExceptionSE,
                                                  ClassNotFoundExceptionSE
```
    HttpClient を介して指定されたリクエストを実行します。
    このメソッドは、基本的な処理ワークフローを実装します。実際の作業は、このクラスのテンプレートメソッドで行われます。
    次で指定:
    クラス AbstractHttpInvokerRequestExecutor の doExecuteRequest
    パラメーター:
    config - ターゲットサービスを指定する HTTP インボーカー構成
    baos - 直列化された RemoteInvocation オブジェクトを含む ByteArrayOutputStream
    戻り値:
    RemoteInvocationResult オブジェクト
    例外:
    IOExceptionSE - I/O 操作によってスローされた場合
    ClassNotFoundExceptionSE - 逆直列化中にスローされた場合
    関連事項:
    createHttpPost(org.springframework.remoting.httpinvoker.HttpInvokerClientConfiguration), setRequestBody(org.springframework.remoting.httpinvoker.HttpInvokerClientConfiguration, org.apache.http.client.methods.HttpPost, java.io.ByteArrayOutputStream), executeHttpPost(org.springframework.remoting.httpinvoker.HttpInvokerClientConfiguration, org.apache.http.client.HttpClient, org.apache.http.client.methods.HttpPost), validateResponse(org.springframework.remoting.httpinvoker.HttpInvokerClientConfiguration, org.apache.http.HttpResponse), getResponseBody(org.springframework.remoting.httpinvoker.HttpInvokerClientConfiguration, org.apache.http.HttpResponse)
  - createHttpPost
```
protected HttpPost createHttpPost(HttpInvokerClientConfiguration config)
                           throws IOExceptionSE
```
    指定された構成の HttpPost を作成します。
    デフォルトの実装では、"application/x-java-serialized-object" を "Content-Type" ヘッダーとして持つ標準の HttpPost が作成されます。
    パラメーター:
    config - ターゲットサービスを指定する HTTP インボーカー構成
    戻り値:
    HttpPost インスタンス
    例外:
    IOExceptionSE - I/O メソッドによってスローされた場合
  - createRequestConfig
```
@Nullable
protected RequestConfig createRequestConfig(HttpInvokerClientConfiguration config)
```
    指定された構成の RequestConfig を作成します。null を返して、カスタムリクエスト構成を設定せず、HttpClient のデフォルトを使用する必要があることを示すことができます。
    デフォルトの実装では、クライアントのデフォルトとインスタンスのローカルカスタマイズ（ある場合）をマージしようとします。
    パラメーター:
    config - ターゲットサービスを指定する HTTP インボーカー構成
    戻り値:
    使用する RequestConfig
  - setRequestBody
```
protected void setRequestBody(HttpInvokerClientConfiguration config,
                              HttpPost httpPost,
                              ByteArrayOutputStreamSE baos)
                       throws IOExceptionSE
```
    指定された直列化されたリモート呼び出しをリクエスト本文として設定します。
    デフォルトの実装では、直列化された呼び出しを HttpPost のリクエスト本文として設定するだけです。これは、たとえば、特定のエンコーディングを記述したり、適切な HTTP リクエストヘッダーを設定したりするためにオーバーライドできます。
    パラメーター:
    config - ターゲットサービスを指定する HTTP インボーカー構成
    httpPost - リクエスト本文を設定する HttpPost
    baos - 直列化された RemoteInvocation オブジェクトを含む ByteArrayOutputStream
    例外:
    IOExceptionSE - I/O メソッドによってスローされた場合
  - executeHttpPost
```
protected org.apache.http.HttpResponse executeHttpPost(HttpInvokerClientConfiguration config,
                                                       HttpClient httpClient,
                                                       HttpPost httpPost)
                                                throws IOExceptionSE
```
    指定された HttpPost インスタンスを実行します。
    パラメーター:
    config - ターゲットサービスを指定する HTTP インボーカー構成
    httpClient - 実行する HttpClient
    httpPost - 実行する HttpPost
    戻り値:
    結果の HttpResponse
    例外:
    IOExceptionSE - I/O メソッドによってスローされた場合
  - validateResponse
```
protected void validateResponse(HttpInvokerClientConfiguration config,
                                org.apache.http.HttpResponse response)
                         throws IOExceptionSE
```
    指定されたレスポンスを HttpPost オブジェクトに含まれているものとして検証し、成功した HTTP レスポンスに対応していない場合は例外をスローします。
    デフォルトの実装では、2xx を超える HTTP ステータスコードはすべて拒否されます。これにより、レスポンス本文の解析や破損したストリームからの逆直列化の試行が回避されます。
    パラメーター:
    config - ターゲットサービスを指定する HTTP インボーカー構成
    response - 検証する結果の HttpResponse
    例外:
    IOExceptionSE - 検証に失敗した場合
  - getResponseBody
```
protected InputStreamSE getResponseBody(HttpInvokerClientConfiguration config,
                                      org.apache.http.HttpResponse httpResponse)
                               throws IOExceptionSE
```
    指定された実行済みのリモート呼び出しリクエストからレスポンス本文を抽出します。
    デフォルトの実装では、単に HttpPost のレスポンス本文ストリームをフェッチします。レスポンスが GZIP レスポンスとして認識されると、InputStream は GZIPInputStream にラップされます。
    パラメーター:
    config - ターゲットサービスを指定する HTTP インボーカー構成
    httpResponse - 結果の HttpResponse からレスポンス本体を読み取る
    戻り値:
    レスポンス本文の InputStream
    例外:
    IOExceptionSE - I/O メソッドによってスローされた場合
    関連事項:
    isGzipResponse(org.apache.http.HttpResponse), GZIPInputStreamSE
  - isGzipResponse
```
protected boolean isGzipResponse(org.apache.http.HttpResponse httpResponse)
```
    指定されたレスポンスが GZIP レスポンスを示しているかどうかを判別します。
    デフォルトの実装では、HTTP の "Content-Encoding" ヘッダーに "gzip" が含まれているかどうかを確認します（大文字と小文字を区別）。
    パラメーター:
    httpResponse - チェックする結果の HttpResponse
    戻り値:
    指定されたレスポンスが GZIP レスポンスを示すかどうか

クラス HttpComponentsHttpInvokerRequestExecutor

フィールドのサマリー

クラス org.springframework.remoting.httpinvoker.AbstractHttpInvokerRequestExecutor から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.remoting.httpinvoker.AbstractHttpInvokerRequestExecutor から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

コンストラクターの詳細

HttpComponentsHttpInvokerRequestExecutor

HttpComponentsHttpInvokerRequestExecutor

メソッドの詳細

setHttpClient

getHttpClient

setConnectTimeout

setConnectionRequestTimeout

setReadTimeout

doExecuteRequest

createHttpPost

createRequestConfig

setRequestBody

executeHttpPost

validateResponse

getResponseBody

isGzipResponse