org.springframework.integration.http.dsl.BaseHttpMessageHandlerSpec<S,E>

型パラメーター:: S - ターゲット BaseHttpMessageHandlerSpec 実装型。; E - ターゲット AbstractHttpRequestExecutingMessageHandler 実装型。

実装されているすべてのインターフェース:: Aware、BeanClassLoaderAware、BeanFactoryAware、DisposableBean、FactoryBean<E>、InitializingBean、Lifecycle、Phased、SmartLifecycle、ComponentsRegistration

既知の直属サブクラス: HttpMessageHandlerSpec, WebFluxMessageHandlerSpec

public abstract class BaseHttpMessageHandlerSpec<S extends BaseHttpMessageHandlerSpec<S,E>,E extends AbstractHttpRequestExecutingMessageHandler>
extends MessageHandlerSpec<S,E>
implements ComponentsRegistration

AbstractHttpRequestExecutingMessageHandler のベース MessageHandlerSpec。

導入:: 5.0
作成者:: Artem Bilan, Shiliang Li

フィールドのサマリー
クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたフィールド
PARSER, target
クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたフィールド
logger
インターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド
OBJECT_TYPE_ATTRIBUTE
インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
DEFAULT_PHASE
コンストラクターの概要
コンストラクター
コンストラクター説明
BaseHttpMessageHandlerSpec(E handler)

メソッドのサマリー

修飾子と型	メソッド	説明
`S`	`charset(StringSE charset)`	文字列型のペイロードをバイトに変換するために使用する文字セット名を指定します。
`S`	`encodingMode(DefaultUriBuilderFactory.EncodingMode encodingMode)`	uri 構築には `DefaultUriBuilderFactory.EncodingMode` を指定します。
`S`	`expectedResponseType(ClassSE<?> expectedResponseType)`	REST リクエストの予想されるレスポンス型を指定します。
`S`	`expectedResponseType(ParameterizedTypeReference<?> expectedResponseType)`	REST リクエストの予想されるレスポンス型に `ParameterizedTypeReference` を指定します。
`S`	`expectedResponseTypeExpression(Expression expectedResponseTypeExpression)`	SpEL `Expression` を指定して、期待されるレスポンスの型を判別します。式の戻り値は、完全修飾クラス名を表す `Class`SE または `String`SE のインスタンスである可能性があります。
`<P> S`	`expectedResponseTypeFunction(FunctionSE<Message<P>,?> expectedResponseTypeFunction)`	`Function`SE を指定して、予期されるレスポンスの型を判別します。式の戻り値は、完全修飾クラス名を表す `Class`SE または `String`SE のインスタンスである可能性があります。
`protected S`	`expectReply(boolean expectReply)`
`S`	`extractPayload(boolean extractPayload)`	リクエスト本文の準備時に送信メッセージのペイロードを抽出するかどうかを指定します。
`S`	`extractResponseBody(boolean extractResponseBody)`	応答メッセージのペイロード用に `ResponseEntity` の本文を抽出するフラグ。
`MapSE<ObjectSE,StringSE>`	`getComponentsToRegister()`
`S`	`headerMapper(HeaderMapper<HttpHeaders> headerMapper)`	HTTP ヘッダーと `MessageHeaders` の間のマッピング時に使用する `HeaderMapper` を設定します。
`S`	`httpMethod(HttpMethod httpMethod)`	リクエストには `HttpMethod` を指定します。
`S`	`httpMethodExpression(Expression httpMethodExpression)`	SpEL `Expression` を指定して、実行時に `HttpMethod` を決定します。
`<P> S`	`httpMethodFunction(FunctionSE<Message<P>,?> httpMethodFunction)`	`Function`SE を指定して、実行時に `HttpMethod` を決定します。
`protected abstract boolean`	`isClientSet()`
`S`	`mappedRequestHeaders(StringSE... patterns)`	マップするリクエストヘッダーのパターン配列を提供します。
`S`	`mappedResponseHeaders(StringSE... patterns)`	マップするレスポンスヘッダーのパターン配列を提供します。
`S`	`transferCookies(boolean transferCookies)`	レスポンスの `Set-Cookie` ヘッダーを、その後のメッセージの対話で `Cookie` ヘッダーとして転送する場合は、`true` に設定します。
`S`	`uriVariable(StringSE variable, StringSE expression)`	uri テンプレート変数の値 SpEL 式を指定します。
`<P> S`	`uriVariable(StringSE variable, FunctionSE<Message<P>,?> valueFunction)`	`Function`SE を指定して、uri テンプレート変数の値を評価します。
`S`	`uriVariable(StringSE variable, Expression expression)`	`Expression` を指定して、uri テンプレート変数の値を評価します。
`S`	`uriVariableExpressions(MapSE<StringSE,Expression> uriVariableExpressions)`	URI テンプレートの変数プレースホルダーを置き換えるときに、送信メッセージに対して評価するように URI 変数式のマップを設定します。
`S`	`uriVariablesExpression(StringSE uriVariablesExpression)`	SpEL 式を指定して、リクエストメッセージに対して実行時に URI 変数の `Map`SE を評価します。
`S`	`uriVariablesExpression(Expression uriVariablesExpression)`	SpEL 式を指定して、リクエストメッセージに対して実行時に URI 変数の `Map`SE を評価します。
`<P> S`	`uriVariablesFunction(FunctionSE<Message<P>,MapSE<StringSE,?>> uriVariablesFunction)`	`Function`SE を指定して、リクエストメッセージに対して実行時に URI 変数の `Map`SE を評価します。

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

_this, createInstance, destroyInstance, doGet, get, getId, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop

クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたメソッド

afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

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

clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

コンストラクターの詳細
- BaseHttpMessageHandlerSpec
  public BaseHttpMessageHandlerSpec(E handler)
メソッドの詳細
- expectReply
 protected S expectReply(boolean expectReply)
- encodingMode
 public S encodingMode(DefaultUriBuilderFactory.EncodingMode encodingMode)
 uri 構築には DefaultUriBuilderFactory.EncodingMode を指定します。
 パラメーター:
 encodingMode - uri の構築に使用します。
 戻り値:
 スペック
 導入:
 5.3
- httpMethodExpression
 public S httpMethodExpression(Expression httpMethodExpression)
 SpEL Expression を指定して、実行時に HttpMethod を決定します。
 パラメーター:
 httpMethodExpression - メソッド式。
 戻り値:
 スペック
- httpMethodFunction
 public S httpMethodFunction(FunctionSE<Message,?> httpMethodFunction)
 FunctionSE を指定して、実行時に HttpMethod を決定します。
 型パラメーター:
 P - ペイロード型。
 パラメーター:
 httpMethodFunction - HTTP メソッド FunctionSE。
 戻り値:
 スペック
- httpMethod
 public S httpMethod(HttpMethod httpMethod)
 リクエストには HttpMethod を指定します。デフォルトの方法は POST です。
 パラメーター:
 httpMethod - 使用する HttpMethod。
 戻り値:
 スペック
- extractPayload
 public S extractPayload(boolean extractPayload)
 リクエスト本文の準備時に送信メッセージのペイロードを抽出するかどうかを指定します。それ以外の場合、メッセージインスタンス自体は直列化されます。デフォルト値は true です。
 パラメーター:
 extractPayload - ペイロードを抽出する必要がある場合は true。
 戻り値:
 スペック
- charset
 public S charset(StringSE charset)
 文字列型のペイロードをバイトに変換するために使用する文字セット名を指定します。デフォルトは UTF-8 です。
 パラメーター:
 charset - 文字セット。
 戻り値:
 スペック
- expectedResponseType
 public S expectedResponseType(ClassSE<?> expectedResponseType)
 REST リクエストの予想されるレスポンス型を指定します。
 パラメーター:
 expectedResponseType - 期待される型。
 戻り値:
 スペック
- expectedResponseType
 public S expectedResponseType(ParameterizedTypeReference<?> expectedResponseType)
 REST リクエストの予想されるレスポンス型に ParameterizedTypeReference を指定します。
 パラメーター:
 expectedResponseType - 予想される型の ParameterizedTypeReference。
 戻り値:
 スペック
- expectedResponseTypeExpression
 public S expectedResponseTypeExpression(Expression expectedResponseTypeExpression)
 SpEL Expression を指定して、期待されるレスポンスの型を判別します。式の戻り値は、完全修飾クラス名を表す ClassSE または StringSE のインスタンスである可能性があります。
 パラメーター:
 expectedResponseTypeExpression - 予期されるレスポンス型の式。
 戻り値:
 スペック
- expectedResponseTypeFunction
 public S expectedResponseTypeFunction(FunctionSE<Message,?> expectedResponseTypeFunction)
 FunctionSE を指定して、予期されるレスポンスの型を判別します。式の戻り値は、完全修飾クラス名を表す ClassSE または StringSE のインスタンスである可能性があります。
 型パラメーター:
 P - ペイロード型。
 パラメーター:
 expectedResponseTypeFunction - 予想されるレスポンス型 FunctionSE。
 戻り値:
 スペック
- headerMapper
 public S headerMapper(HeaderMapper<HttpHeaders> headerMapper)
 HTTP ヘッダーと MessageHeaders の間のマッピング時に使用する HeaderMapper を設定します。
 パラメーター:
 headerMapper - ヘッダーマッパー。
 戻り値:
 スペック
- mappedRequestHeaders
 public S mappedRequestHeaders(StringSE... patterns)
 マップするリクエストヘッダーのパターン配列を提供します。
 パラメーター:
 patterns - マップするリクエストヘッダーのパターン。
 戻り値:
 スペック
 関連事項:
 DefaultHttpHeaderMapper.setOutboundHeaderNames(String[])
- mappedResponseHeaders
 public S mappedResponseHeaders(StringSE... patterns)
 マップするレスポンスヘッダーのパターン配列を提供します。
 パラメーター:
 patterns - マップするレスポンスヘッダーのパターン。
 戻り値:
 現在の仕様。
 関連事項:
 DefaultHttpHeaderMapper.setInboundHeaderNames(String[])
- uriVariableExpressions
 public S uriVariableExpressions(MapSE<StringSE,Expression> uriVariableExpressions)
 URI テンプレートの変数プレースホルダーを置き換えるときに、送信メッセージに対して評価するように URI 変数式のマップを設定します。
 パラメーター:
 uriVariableExpressions - URI 変数式。
 戻り値:
 現在の仕様。
 関連事項:
 AbstractHttpRequestExecutingMessageHandler.setUriVariableExpressions(Map)
- uriVariable
 public S uriVariable(StringSE variable, Expression expression)
 Expression を指定して、uri テンプレート変数の値を評価します。
 パラメーター:
 variable - uri テンプレート変数。
 expression - teuri テンプレート変数の値を評価する式。
 戻り値:
 現在の仕様。
 関連事項:
 AbstractHttpRequestExecutingMessageHandler.setUriVariableExpressions(Map), ValueExpression, LiteralExpression
- uriVariable
 public S uriVariable(StringSE variable, StringSE expression)
 uri テンプレート変数の値 SpEL 式を指定します。
 パラメーター:
 variable - uri テンプレート変数。
 expression - teuri テンプレート変数の値を評価する式。
 戻り値:
 現在の仕様。
 関連事項:
 AbstractHttpRequestExecutingMessageHandler.setUriVariableExpressions(Map)
- uriVariable
 public S uriVariable(StringSE variable, FunctionSE<Message,?> valueFunction)
 FunctionSE を指定して、uri テンプレート変数の値を評価します。
 型パラメーター:
 P - ペイロード型。
 パラメーター:
 variable - uri テンプレート変数。
 valueFunction - uri テンプレート変数の値を評価するための FunctionSE。
 戻り値:
 現在の仕様。
 関連事項:
 AbstractHttpRequestExecutingMessageHandler.setUriVariableExpressions(Map)
- uriVariablesExpression
 public S uriVariablesExpression(StringSE uriVariablesExpression)
 SpEL 式を指定して、リクエストメッセージに対して実行時に URI 変数の MapSE を評価します。
 パラメーター:
 uriVariablesExpression - 使用します。
 戻り値:
 現在の仕様。
 関連事項:
 AbstractHttpRequestExecutingMessageHandler.setUriVariablesExpression(Expression)
- uriVariablesExpression
 public S uriVariablesExpression(Expression uriVariablesExpression)
 SpEL 式を指定して、リクエストメッセージに対して実行時に URI 変数の MapSE を評価します。
 パラメーター:
 uriVariablesExpression - 使用します。
 戻り値:
 現在の仕様。
 関連事項:
 AbstractHttpRequestExecutingMessageHandler.setUriVariablesExpression(Expression)
- uriVariablesFunction
 public S uriVariablesFunction(FunctionSE<Message,MapSE<StringSE,?>> uriVariablesFunction)
 FunctionSE を指定して、リクエストメッセージに対して実行時に URI 変数の MapSE を評価します。
 型パラメーター:
 P - ペイロード型。
 パラメーター:
 uriVariablesFunction - 使用する FunctionSE。
 戻り値:
 現在の仕様。
 関連事項:
 AbstractHttpRequestExecutingMessageHandler.setUriVariablesExpression(Expression)
- transferCookies
 public S transferCookies(boolean transferCookies)
 レスポンスの Set-Cookie ヘッダーをメッセージの後続の対話で Cookie ヘッダーとして転送する場合は、true に設定します。デフォルトは false です。
 パラメーター:
 transferCookies - transferCookies を設定します。
 戻り値:
 現在の仕様。
- extractResponseBody
 public S extractResponseBody(boolean extractResponseBody)
 応答メッセージのペイロード用に ResponseEntity の本文を抽出するフラグ。デフォルトは true です。
 パラメーター:
 extractResponseBody - ResponseEntity 全体またはその本文のみを含む返信メッセージを作成します。
 戻り値:
 現在の仕様。
 導入:
 5.5
- getComponentsToRegister
 public MapSE<ObjectSE,StringSE> getComponentsToRegister()
 次で指定:
 インターフェース ComponentsRegistration の getComponentsToRegister
- isClientSet
 protected abstract boolean isClientSet()

クラス BaseHttpMessageHandlerSpec<S extends BaseHttpMessageHandlerSpec<S,​E>,​E extends AbstractHttpRequestExecutingMessageHandler>

フィールドのサマリー

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

クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたフィールド

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

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

コンストラクターの概要

メソッドのサマリー

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

クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたメソッド

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

コンストラクターの詳細

メソッドの詳細

クラス BaseHttpMessageHandlerSpec<S extends BaseHttpMessageHandlerSpec<S,E>,E extends AbstractHttpRequestExecutingMessageHandler>