AbstractHttpRequestExecutingMessageHandler (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.reactivestreams.Subscriber<Message<?>>, Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ExpressionCapable, Orderable, MessageProducer, HeaderPropagationAware, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>
既知の直属サブクラス
HttpRequestExecutingMessageHandler, WebFluxRequestExecutingMessageHandler
```
public abstract class AbstractHttpRequestExecutingMessageHandler
extends AbstractReplyProducingMessageHandler
```
http 送信アダプター / ゲートウェイの基本クラス。
導入:
5.0
作成者:
Mark Fisher, Oleg Zhurakousky, Gary Russell, Gunnar Hillert, Artem Bilan, Wallace Wadge, Shiliang Li, Florian Sch ö ffl

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

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
protected DefaultUriBuilderFactory 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

フィールド
修飾子と型	フィールドと説明
`protected DefaultUriBuilderFactory`	`uriFactory`

コンストラクターの概要
コンストラクター
コンストラクターと説明
AbstractHttpRequestExecutingMessageHandler(Expression uriExpression)

コンストラクター
コンストラクターと説明
`AbstractHttpRequestExecutingMessageHandler(Expression uriExpression)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド非推奨のメソッド
修飾子と型	メソッドと説明
`protected void`	`doInit()`
`protected ObjectSE`	`evaluateTypeFromExpression(Message<?> requestMessage, Expression expression, StringSE property)`
`protected abstract ObjectSE`	`exchange(ObjectSE uri, HttpMethod httpMethod, HttpEntity<?> httpRequest, ObjectSE expectedResponseType, Message<?> requestMessage, MapSE<StringSE,?> uriVariables)`
`IntegrationPatternType`	`getIntegrationPatternType()` このコンポーネントが実装するパターン型を返します。
`protected ObjectSE`	`getReply(ResponseEntity<?> httpResponse)`
`protected ObjectSE`	`handleRequestMessage(Message<?> requestMessage)` サブクラスはこのメソッドを実装して、リクエストメッセージを処理する必要があります。
`boolean`	`isExpectReply()`
`protected HttpHeaders`	`mapHeaders(Message<?> message)`
`void`	`setCharset(StringSE charset)` 文字列型のペイロードをバイトに変換するために使用する文字セット名を指定します。
`void`	`setEncodeUri(boolean encodeUri)` 使用すべきではありません。 5.3 以降、`setEncodingMode(org.springframework.web.util.DefaultUriBuilderFactory.EncodingMode)` を推奨
`void`	`setEncodingMode(DefaultUriBuilderFactory.EncodingMode encodingMode)` 使用するエンコードモードを設定します。
`void`	`setExpectedResponseType(ClassSE<?> expectedResponseType)` REST リクエストに予想されるレスポンス型を指定します。指定しない場合、デフォルトのレスポンス型は `ResponseEntity` であり、レスポンスメッセージのペイロードとして返されます。
`void`	`setExpectedResponseTypeExpression(Expression expectedResponseTypeExpression)` `Expression` を指定して、予期されるレスポンスの型を判別します。式の戻り値は、完全修飾クラス名を表す `Class`SE または `String`SE のインスタンスである可能性があります。
`void`	`setExpectReply(boolean expectReply)` 返信メッセージが必要かどうかを指定します。
`void`	`setExtractPayload(boolean extractPayload)` リクエスト本文の準備時に送信メッセージのペイロードを抽出するかどうかを指定します。
`void`	`setHeaderMapper(HeaderMapper<HttpHeaders> headerMapper)` HTTP ヘッダーと MessageHeaders の間のマッピング時に使用する `HeaderMapper` を設定します。
`void`	`setHttpMethod(HttpMethod httpMethod)` リクエストには `HttpMethod` を指定します。
`void`	`setHttpMethodExpression(Expression httpMethodExpression)` SpEL `Expression` を指定して、実行時に `HttpMethod` を決定します。
`void`	`setTransferCookies(boolean transferCookies)` レスポンスの "Set-Cookie" ヘッダーをメッセージの後続の対話で "Cookie" ヘッダーとして転送する場合は、true に設定します。
`void`	`setTrustedSpel(boolean trustedSpel)` URI 変数の評価に使用される SpEL 式のソースを信頼する場合は、true に設定します。
`void`	`setUriVariableExpressions(MapSE<StringSE, Expression> uriVariableExpressions)` URI テンプレートの変数プレースホルダーを置き換えるときに、送信メッセージに対して評価するように URI 変数式のマップを設定します。
`void`	`setUriVariablesExpression(Expression uriVariablesExpression)` 送信メッセージに対して評価するように `Expression` を設定します。式は、URI テンプレートの変数プレースホルダーを置き換えるときに、送信メッセージに対して評価するために、URI 変数式のマップに評価される必要があります。

クラス 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, getComponentType, 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

- フィールドの詳細
  - uriFactory
```
protected final DefaultUriBuilderFactory uriFactory
```
- コンストラクターの詳細
  - AbstractHttpRequestExecutingMessageHandler
```
public AbstractHttpRequestExecutingMessageHandler(Expression uriExpression)
```
- メソッドの詳細
  - setEncodeUri
```
@DeprecatedSE
public void setEncodeUri(boolean encodeUri)
```
    非推奨。5.3 から setEncodingMode(org.springframework.web.util.DefaultUriBuilderFactory.EncodingMode) に移行
    uriVariables の展開後、RestTemplate を介してリクエストを送信する前に、実際の URI をエンコードするかどうかを指定します。デフォルト値は true です。
    パラメーター:
    encodeUri - URI をエンコードする必要がある場合は true。
    関連事項:
    UriComponentsBuilder
  - setEncodingMode
```
public void setEncodingMode(DefaultUriBuilderFactory.EncodingMode encodingMode)
```
    使用するエンコードモードを設定します。デフォルトでは、これは DefaultUriBuilderFactory.EncodingMode#TEMPLATE_AND_VALUES に設定されています。より複雑なシナリオでは、外部から提供された RestTemplate で UriTemplateHandler を構成することを検討してください。
    パラメーター:
    encodingMode - uri エンコーディングに使用するモード
    導入:
    5.3
  - setHttpMethodExpression
```
public void setHttpMethodExpression(Expression httpMethodExpression)
```
    SpEL Expression を指定して、実行時に HttpMethod を決定します。
    パラメーター:
    httpMethodExpression - メソッド式。
  - setHttpMethod
```
public void setHttpMethod(HttpMethod httpMethod)
```
    リクエストには HttpMethod を指定します。デフォルトの方法は POST です。
    パラメーター:
    httpMethod - メソッド。
  - setExtractPayload
```
public void setExtractPayload(boolean extractPayload)
```
    リクエスト本文の準備時に送信メッセージのペイロードを抽出するかどうかを指定します。それ以外の場合、メッセージインスタンス自体は直列化されます。デフォルト値は true です。
    パラメーター:
    extractPayload - ペイロードを抽出する必要がある場合は true。
  - setCharset
```
public void setCharset(StringSE charset)
```
    文字列型のペイロードをバイトに変換するために使用する文字セット名を指定します。デフォルトは UTF-8 です。
    パラメーター:
    charset - 文字セット。
  - isExpectReply
```
public boolean isExpectReply()
```
    戻り値:
    返信メッセージが期待されるかどうか。
    関連事項:
    setExpectReply(boolean)
  - setExpectReply
```
public void setExpectReply(boolean expectReply)
```
    返信メッセージが必要かどうかを指定します。そうでない場合、このハンドラーは、成功したレスポンスの場合は単に null を返すか、失敗したレスポンスの場合は例外をスローします。デフォルトは true です。
    パラメーター:
    expectReply - 応答が期待される場合は true。
  - setExpectedResponseType
```
public void setExpectedResponseType(ClassSE<?> expectedResponseType)
```
    REST リクエストに予想されるレスポンス型を指定します。指定しない場合、デフォルトのレスポンス型は ResponseEntity であり、レスポンスメッセージのペイロードとして返されます。このアダプターに登録されている HttpMessageConverters を利用するには、別の型を提供してください）。
    パラメーター:
    expectedResponseType - 予想される型。setExpectedResponseTypeExpression(Expression) も参照してください
  - setExpectedResponseTypeExpression
```
public void setExpectedResponseTypeExpression(Expression expectedResponseTypeExpression)
```
    Expression を指定して、予期されるレスポンスの型を判別します。式の戻り値は、完全修飾クラス名を表す ClassSE または StringSE のインスタンスである可能性があります。
    パラメーター:
    expectedResponseTypeExpression - 期待されるレスポンス型の式。setExpectedResponseType(java.lang.Class<?>) も参照してください
  - setHeaderMapper
```
public void setHeaderMapper(HeaderMapper<HttpHeaders> headerMapper)
```
    HTTP ヘッダーと MessageHeaders の間のマッピング時に使用する HeaderMapper を設定します。
    パラメーター:
    headerMapper - ヘッダーマッパー。
  - setUriVariableExpressions
```
public void setUriVariableExpressions(MapSE<StringSE,Expression> uriVariableExpressions)
```
    URI テンプレートの変数プレースホルダーを置き換えるときに、送信メッセージに対して評価するように URI 変数式のマップを設定します。
    パラメーター:
    uriVariableExpressions - URI 変数式。
  - setUriVariablesExpression
```
public void setUriVariablesExpression(Expression uriVariablesExpression)
```
    送信メッセージに対して評価するように Expression を設定します。式は、URI テンプレートの変数プレースホルダーを置き換えるときに、送信メッセージに対して評価するために、URI 変数式のマップに評価される必要があります。
    パラメーター:
    uriVariablesExpression - URI 変数式。
  - setTransferCookies
```
public void setTransferCookies(boolean transferCookies)
```
    レスポンスの "Set-Cookie" ヘッダーをメッセージの後続の対話で "Cookie" ヘッダーとして転送する場合は、true に設定します。
    パラメーター:
    transferCookies - transferCookies を設定します。
  - setTrustedSpel
```
public void setTrustedSpel(boolean trustedSpel)
```
    URI 変数の評価に使用される SpEL 式のソースを信頼する場合は、true に設定します。デフォルトは false です。これは、SimpleEvaluationContext がそのような式の評価に使用されることを意味し、一部の SpEL 機能の使用を制限します。
    パラメーター:
    trustedSpel - 信頼するのは本当です。
    導入:
    4.3.15.
  - getIntegrationPatternType
```
public IntegrationPatternType getIntegrationPatternType()
```
    インターフェースからコピーされた説明: IntegrationPattern
    このコンポーネントが実装するパターン型を返します。
    次で指定:
    インターフェース IntegrationPattern の getIntegrationPatternType
    オーバーライド:
    クラス AbstractReplyProducingMessageHandler の getIntegrationPatternType
    戻り値:
    このコンポーネントが実装する IntegrationPatternType
  - doInit
```
protected void doInit()
```
    オーバーライド:
    クラス AbstractReplyProducingMessageHandler の doInit
  - handleRequestMessage
```
@Nullable
protected ObjectSE handleRequestMessage(Message<?> requestMessage)
```
    クラスからコピーされた説明: AbstractReplyProducingMessageHandler
    サブクラスはこのメソッドを実装して、リクエストメッセージを処理する必要があります。戻り値は、メッセージ、MessageBuilder、任意のプレーンオブジェクトです。基本クラスは、これらの開始点のいずれかからの返信メッセージの最終的な作成を処理します。戻り値が null の場合、メッセージフローはここで終了します。
    次で指定:
    クラス AbstractReplyProducingMessageHandler の handleRequestMessage
    パラメーター:
    requestMessage - リクエストメッセージ。
    戻り値:
    メッセージを処理した結果、または null
  - exchange
```
@Nullable
protected abstract ObjectSE exchange(ObjectSE uri,
                                             HttpMethod httpMethod,
                                             HttpEntity<?> httpRequest,
                                             ObjectSE expectedResponseType,
                                             Message<?> requestMessage,
                                             MapSE<StringSE,?> uriVariables)
```
  - getReply
```
protected ObjectSE getReply(ResponseEntity<?> httpResponse)
```
  - mapHeaders
```
protected HttpHeaders mapHeaders(Message<?> message)
```
  - evaluateTypeFromExpression
```
@Nullable
protected ObjectSE evaluateTypeFromExpression(Message<?> requestMessage,
                                                      @Nullable
                                                      Expression expression,
                                                      StringSE property)
```

クラス AbstractHttpRequestExecutingMessageHandler

ネストされたクラスの要約

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

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

フィールドのサマリー

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

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

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

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

コンストラクターの概要

メソッドのサマリー

クラス 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 から継承されたメソッド

フィールドの詳細

uriFactory

コンストラクターの詳細

AbstractHttpRequestExecutingMessageHandler

メソッドの詳細

setEncodeUri

setEncodingMode

setHttpMethodExpression

setHttpMethod

setExtractPayload

setCharset

isExpectReply

setExpectReply

setExpectedResponseType

setExpectedResponseTypeExpression

setHeaderMapper

setUriVariableExpressions

setUriVariablesExpression

setTransferCookies

setTrustedSpel

getIntegrationPatternType

doInit

handleRequestMessage

exchange

getReply

mapHeaders

evaluateTypeFromExpression