HttpRequestExecutingMessageHandler (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.handler.MessageHandlerSupport
  - - org.springframework.integration.handler.AbstractMessageHandler
    - - org.springframework.integration.handler.AbstractMessageProducingHandler
      - org.springframework.integration.handler.AbstractReplyProducingMessageHandler
        
        org.springframework.integration.http.outbound.AbstractHttpRequestExecutingMessageHandler
        
        org.springframework.integration.http.outbound.HttpRequestExecutingMessageHandler

実装されたすべてのインターフェース:
org.reactivestreams.Subscriber<Message<?>>, Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ExpressionCapable, Orderable, MessageProducer, HeaderPropagationAware, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>
```
public class HttpRequestExecutingMessageHandler
extends AbstractHttpRequestExecutingMessageHandler
```
RestTemplate インスタンスに委譲して HTTP リクエストを実行する MessageHandler 実装。'expectReply' フラグが true (デフォルト) に設定されている場合、HTTP レスポンスからレスポンスメッセージが生成されます。そのレスポンスに本文が含まれている場合は、それがレスポンスメッセージのペイロードとして使用されます。それ以外の場合、レスポンスメッセージのペイロードには、HttpStatus 列挙のインスタンスとしてレスポンスステータスが含まれます。レスポンス本文がある場合は、代わりに HttpStatus 列挙インスタンスがレスポンスの MessageHeaders にコピーされます。どちらの場合も、レスポンスヘッダーは、このハンドラーの HeaderMapper インスタンスによってレスポンスメッセージのヘッダーにマップされます。
導入:
2.0
作成者:
Mark Fisher, Oleg Zhurakousky, Gary Russell, Gunnar Hillert, Artem Bilan, Wallace Wadge, Shiliang Li

ネストされたクラスのサマリー
- クラス org.springframework.integration.handler.AbstractReplyProducingMessageHandler から継承されたネストクラス / インターフェース
  AbstractReplyProducingMessageHandler.RequestHandler
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース
  IntegrationManagement.ManagementOverrides

フィールドのサマリー
- クラス org.springframework.integration.http.outbound.AbstractHttpRequestExecutingMessageHandler から継承されたフィールド
  uriFactory
- クラス org.springframework.integration.handler.AbstractMessageProducingHandler から継承されたフィールド
  messagingTemplate
- クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド
  EXPRESSION_PARSER, logger
- インターフェース org.springframework.core.Ordered から継承されたフィールド
  HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド
  METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

コンストラクターの概要

コンストラクター
コンストラクターと説明
`HttpRequestExecutingMessageHandler(Expression uriExpression)` 提供された URI 式にリクエストを送信するハンドラーを作成します。
`HttpRequestExecutingMessageHandler(Expression uriExpression, RestTemplate restTemplate)` 提供された RestTemplate を使用して、提供された URI にリクエストを送信するハンドラーを作成します
`HttpRequestExecutingMessageHandler(StringSE uri)` 指定された URI にリクエストを送信するハンドラーを作成します。
`HttpRequestExecutingMessageHandler(StringSE uri, RestTemplate restTemplate)` 提供された RestTemplate を使用して、提供された URI にリクエストを送信するハンドラーを作成します
`HttpRequestExecutingMessageHandler(URISE uri)` 指定された URI にリクエストを送信するハンドラーを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected ObjectSE`	`exchange(ObjectSE uri, HttpMethod httpMethod, HttpEntity<?> httpRequest, ObjectSE expectedResponseType, Message<?> requestMessage, MapSE<StringSE,?> uriVariables)`
`StringSE`	`getComponentType()` サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
`void`	`setEncodingMode(DefaultUriBuilderFactory.EncodingMode encodingMode)` 使用するエンコードモードを設定します。
`void`	`setErrorHandler(ResponseErrorHandler errorHandler)` 基になる `RestTemplate` の `ResponseErrorHandler` を設定します。
`void`	`setMessageConverters(ListSE<HttpMessageConverter<?>> messageConverters)` 基礎となる `RestTemplate` で使用される `HttpMessageConverter` のリストを設定します。
`void`	`setRequestFactory(ClientHttpRequestFactory requestFactory)` 基になる `RestTemplate` の `ClientHttpRequestFactory` を設定します。

クラス org.springframework.integration.http.outbound.AbstractHttpRequestExecutingMessageHandler から継承されたメソッド
doInit, evaluateTypeFromExpression, getIntegrationPatternType, getReply, handleRequestMessage, isExpectReply, mapHeaders, setCharset, setEncodeUri, setExpectedResponseType, setExpectedResponseTypeExpression, setExpectReply, setExtractPayload, setHeaderMapper, setHttpMethod, setHttpMethodExpression, setTransferCookies, setTrustedSpel, setUriVariableExpressions, setUriVariablesExpression

クラス org.springframework.integration.handler.AbstractReplyProducingMessageHandler から継承されたメソッド
doInvokeAdvisedRequestHandler, getBeanClassLoader, getRequiresReply, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReply

クラス org.springframework.integration.handler.AbstractMessageProducingHandler から継承されたメソッド
addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, produceOutput, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, shouldCopyRequestHeaders, shouldSplitOutput, updateNotPropagatedHeaders

クラス org.springframework.integration.handler.AbstractMessageHandler から継承されたメソッド
handleMessage, onComplete, onError, onNext, onSubscribe

クラス org.springframework.integration.handler.MessageHandlerSupport から継承されたメソッド
buildSendTimer, destroy, getManagedName, getManagedType, getMetricsCaptor, getOrder, getOverrides, isLoggingEnabled, registerMetricsCaptor, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド
afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

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

インターフェース reactor.core.CoreSubscriber から継承されたメソッド
currentContext

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたメソッド
getThisAs

インターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド
getBeanName, getComponentName

- コンストラクターの詳細
  - HttpRequestExecutingMessageHandler
```
public HttpRequestExecutingMessageHandler(URISE uri)
```
    指定された URI にリクエストを送信するハンドラーを作成します。
    パラメーター:
    uri - URI。
  - HttpRequestExecutingMessageHandler
```
public HttpRequestExecutingMessageHandler(StringSE uri)
```
    指定された URI にリクエストを送信するハンドラーを作成します。
    パラメーター:
    uri - URI。
  - HttpRequestExecutingMessageHandler
```
public HttpRequestExecutingMessageHandler(Expression uriExpression)
```
    提供された URI 式にリクエストを送信するハンドラーを作成します。
    パラメーター:
    uriExpression - URI 式。
  - HttpRequestExecutingMessageHandler
```
public HttpRequestExecutingMessageHandler(StringSE uri,
                                          RestTemplate restTemplate)
```
    提供された RestTemplate を使用して、提供された URI にリクエストを送信するハンドラーを作成します
    パラメーター:
    uri - URI。
    restTemplate - Rest テンプレート。
  - HttpRequestExecutingMessageHandler
```
public HttpRequestExecutingMessageHandler(Expression uriExpression,
                                          @Nullable
                                          RestTemplate restTemplate)
```
    提供された RestTemplate を使用して、提供された URI にリクエストを送信するハンドラーを作成します
    パラメーター:
    uriExpression - メッセージオブジェクトおよび BeanFactory に対して解決できる SpEL 式。
    restTemplate - Rest テンプレート。
- メソッドの詳細
  - getComponentType
```
public StringSE getComponentType()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
    次で指定:
    インターフェース NamedComponent の getComponentType
    オーバーライド:
    クラス MessageHandlerSupport の getComponentType
  - setErrorHandler
```
public void setErrorHandler(ResponseErrorHandler errorHandler)
```
    基になる RestTemplate の ResponseErrorHandler を設定します。
    パラメーター:
    errorHandler - エラーハンドラー。
    関連事項:
    RestTemplate.setErrorHandler(ResponseErrorHandler)
  - setMessageConverters
```
public void setMessageConverters(ListSE<HttpMessageConverter<?>> messageConverters)
```
    基礎となる RestTemplate で使用される HttpMessageConverter のリストを設定します。この方法で構成されたコンバーターは、デフォルトのコンバーターをオーバーライドします。
    パラメーター:
    messageConverters - メッセージコンバーター。
    関連事項:
    RestTemplate.setMessageConverters(java.util.List)
  - setRequestFactory
```
public void setRequestFactory(ClientHttpRequestFactory requestFactory)
```
    基になる RestTemplate の ClientHttpRequestFactory を設定します。
    パラメーター:
    requestFactory - リクエストファクトリ。
    関連事項:
    InterceptingHttpAccessor.setRequestFactory(ClientHttpRequestFactory)
  - setEncodingMode
```
public void setEncodingMode(DefaultUriBuilderFactory.EncodingMode encodingMode)
```
    クラスからコピーされた説明: AbstractHttpRequestExecutingMessageHandler
    使用するエンコードモードを設定します。デフォルトでは、これは DefaultUriBuilderFactory.EncodingMode#TEMPLATE_AND_VALUES に設定されています。より複雑なシナリオでは、外部から提供された RestTemplate で UriTemplateHandler を構成することを検討してください。
    オーバーライド:
    クラス AbstractHttpRequestExecutingMessageHandler の setEncodingMode
    パラメーター:
    encodingMode - uri エンコーディングに使用するモード
  - exchange
```
@Nullable
protected ObjectSE exchange(ObjectSE uri,
                                    HttpMethod httpMethod,
                                    HttpEntity<?> httpRequest,
                                    ObjectSE expectedResponseType,
                                    Message<?> requestMessage,
                                    MapSE<StringSE,?> uriVariables)
```
    次で指定:
    クラス AbstractHttpRequestExecutingMessageHandler の exchange

クラス HttpRequestExecutingMessageHandler

ネストされたクラスのサマリー

クラス org.springframework.integration.handler.AbstractReplyProducingMessageHandler から継承されたネストクラス / インターフェース

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース

フィールドのサマリー

クラス org.springframework.integration.http.outbound.AbstractHttpRequestExecutingMessageHandler から継承されたフィールド

クラス org.springframework.integration.handler.AbstractMessageProducingHandler から継承されたフィールド

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド

インターフェース org.springframework.core.Ordered から継承されたフィールド

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.integration.http.outbound.AbstractHttpRequestExecutingMessageHandler から継承されたメソッド

クラス org.springframework.integration.handler.AbstractReplyProducingMessageHandler から継承されたメソッド

クラス org.springframework.integration.handler.AbstractMessageProducingHandler から継承されたメソッド

クラス org.springframework.integration.handler.AbstractMessageHandler から継承されたメソッド

クラス org.springframework.integration.handler.MessageHandlerSupport から継承されたメソッド

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド

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

インターフェース reactor.core.CoreSubscriber から継承されたメソッド

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたメソッド

インターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド

コンストラクターの詳細

HttpRequestExecutingMessageHandler

HttpRequestExecutingMessageHandler

HttpRequestExecutingMessageHandler

HttpRequestExecutingMessageHandler

HttpRequestExecutingMessageHandler

メソッドの詳細

getComponentType

setErrorHandler

setMessageConverters

setRequestFactory

setEncodingMode

exchange