HttpInboundEndpointSupportSpec (Spring Integration API)

java.lang.ObjectSE
- org.springframework.beans.factory.config.AbstractFactoryBean<T>
- - org.springframework.integration.dsl.IntegrationComponentSpec<S,G>
  - - org.springframework.integration.dsl.MessagingGatewaySpec<S,E>
    - - org.springframework.integration.http.dsl.HttpInboundEndpointSupportSpec<S,E>

実装されたすべてのインターフェース:
Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<E>, InitializingBean, Lifecycle, Phased, SmartLifecycle, ComponentsRegistration
既知の直属サブクラス
BaseHttpInboundEndpointSpec, WebFluxInboundEndpointSpec
```
public abstract class HttpInboundEndpointSupportSpec<S extends HttpInboundEndpointSupportSpec<S,E>,E extends BaseHttpInboundEndpoint>
extends MessagingGatewaySpec<S,E>
implements ComponentsRegistration
```
導入:
5.0
作成者:
Artem Bilan, Gary Russell

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

ネストされたクラス
修飾子と型	クラスと説明
`static class`	`HttpInboundEndpointSupportSpec.CrossOriginSpec` `CrossOrigin` の流れるような API。
`static class`	`HttpInboundEndpointSupportSpec.RequestMappingSpec` `RequestMapping` の流れるような API。

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`protected MapSE<StringSE, Expression>`	`headerExpressions`
`protected HeaderMapper<HttpHeaders>`	`headerMapper`
`protected RequestMapping`	`requestMapping`

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

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

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

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

コンストラクターの概要
コンストラクター
修飾子コンストラクターと説明
protected HttpInboundEndpointSupportSpec(E gateway, StringSE... path)

コンストラクター
修飾子	コンストラクターと説明
`protected`	`HttpInboundEndpointSupportSpec(E gateway, StringSE... path)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`S`	`crossOrigin(java.util.function.ConsumerSE<HttpInboundEndpointSupportSpec.CrossOriginSpec> crossOrigin)` `HttpInboundEndpointSupportSpec.CrossOriginSpec` を介して `CrossOrigin` を構成するための `Consumer`SE を提供します
`S`	`extractReplyPayload(boolean extractReplyPayload)` レスポンスメッセージのペイロードのみをレスポンスで渡すかどうかを指定します。
`MapSE<ObjectSE, StringSE>`	`getComponentsToRegister()`
`S`	`headerExpression(StringSE header, Expression expression)` 入力する提供されたヘッダーの SpEL 式を指定します。
`S`	`headerExpression(StringSE header, StringSE expression)` 入力する提供されたヘッダーの SpEL 式を指定します。
`S`	`headerExpressions(MapSE<StringSE, Expression> expressions)` メッセージヘッダーを生成するために評価する SpEL 式のマップを指定します。
`<P> S`	`headerFunction(StringSE header, java.util.function.FunctionSE<HttpEntity<P>,?> headerFunction)` 提供されたヘッダーに入力する `Function`SE を指定します。
`S`	`headerMapper(HeaderMapper<HttpHeaders> mapper)` HTTP ヘッダーと MessageHeaders の間のマッピング時に使用する `HeaderMapper` を設定します。
`S`	`mappedRequestHeaders(StringSE... patterns)` マップするリクエストヘッダーのパターン配列を提供します。
`S`	`mappedResponseHeaders(StringSE... patterns)` マップするレスポンスヘッダーのパターン配列を提供します。
`S`	`payloadExpression(Expression payloadExpression)` メッセージペイロードを生成するために評価する SpEL 式を指定します。
`S`	`payloadExpression(StringSE payloadExpression)` メッセージペイロードを生成するために評価する SpEL 式を指定します。
`<P> S`	`payloadFunction(java.util.function.FunctionSE<HttpEntity<P>,?> payloadFunction)` メッセージペイロードを生成するために評価する `Function`SE を指定します。
`S`	`requestMapping(java.util.function.ConsumerSE<HttpInboundEndpointSupportSpec.RequestMappingSpec> mapping)` `HttpInboundEndpointSupportSpec.RequestMappingSpec` を介して `RequestMapping` を構成するための `Consumer`SE を提供します
`S`	`requestPayloadType(ClassSE<?> requestPayloadType)` 受信 HTTP リクエストコンテンツが `HttpMessageConverter` によって読み取られるときに生成されるペイロードの型を指定します。
`S`	`requestPayloadType(ResolvableType requestPayloadType)` 受信 HTTP リクエストコンテンツが `HttpMessageConverter` によって読み取られるときに生成されるペイロードの型を指定します。
`S`	`statusCodeExpression(Expression statusCodeExpression)` `Expression` を指定して、レスポンスのステータスコードを解決し、タイムアウトのデフォルトの "200 OK" または "500 Internal Server Error" をオーバーライドします。
`S`	`statusCodeExpression(StringSE statusCodeExpression)` `Expression` を指定して、レスポンスのステータスコードを解決し、タイムアウトのデフォルトの "200 OK" または "500 Internal Server Error" をオーバーライドします。
`S`	`statusCodeFunction(java.util.function.FunctionSE<RequestEntity<?>,?> statusCodeFunction)` `Function`SE を指定して、レスポンスのステータスコードを解決し、タイムアウトのデフォルトの "200 OK" または "500 Internal Server Error" をオーバーライドします。
`S`	`validator(Validator validator)` `Validator` を指定して、リクエストから変換されたペイロードを検証します。

クラス org.springframework.integration.dsl.MessagingGatewaySpec から継承されたメソッド
autoStartup, errorChannel, errorChannel, errorOnTimeout, id, phase, replyChannel, replyChannel, replyMapper, replyTimeout, requestChannel, requestChannel, requestMapper, requestTimeout, shouldTrack

クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたメソッド
_this, createInstance, destroyInstance, doGet, get, getId, getObjectType, getPhase, isAutoStartup, isRunning, start, stop, stop

クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたメソッド
afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

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

- フィールドの詳細
  - requestMapping
```
protected final RequestMapping requestMapping
```
  - headerExpressions
```
protected final MapSE<StringSE,Expression> headerExpressions
```
  - headerMapper
```
protected final HeaderMapper<HttpHeaders> headerMapper
```
- コンストラクターの詳細
  - HttpInboundEndpointSupportSpec
```
protected HttpInboundEndpointSupportSpec(E gateway,
                                         StringSE... path)
```
- メソッドの詳細
  - requestMapping
```
public S requestMapping(java.util.function.ConsumerSE<HttpInboundEndpointSupportSpec.RequestMappingSpec> mapping)
```
    HttpInboundEndpointSupportSpec.RequestMappingSpec を介して RequestMapping を構成するための ConsumerSE を提供します
    パラメーター:
    mapping - HttpInboundEndpointSupportSpec.RequestMappingSpec を構成するための ConsumerSE。
    戻り値:
    スペック
    関連事項:
    RequestMapping
  - crossOrigin
```
public S crossOrigin(java.util.function.ConsumerSE<HttpInboundEndpointSupportSpec.CrossOriginSpec> crossOrigin)
```
    HttpInboundEndpointSupportSpec.CrossOriginSpec を介して CrossOrigin を構成するための ConsumerSE を提供します
    パラメーター:
    crossOrigin - HttpInboundEndpointSupportSpec.CrossOriginSpec を構成するための ConsumerSE。
    戻り値:
    スペック
    関連事項:
    CrossOrigin
  - payloadExpression
```
public S payloadExpression(StringSE payloadExpression)
```
    メッセージペイロードを生成するために評価する SpEL 式を指定します。
    パラメーター:
    payloadExpression - ペイロード式。
    戻り値:
    スペック
    関連事項:
    BaseHttpInboundEndpoint.setPayloadExpression(Expression)
  - payloadExpression
```
public S payloadExpression(Expression payloadExpression)
```
    メッセージペイロードを生成するために評価する SpEL 式を指定します。
    パラメーター:
    payloadExpression - ペイロード式。
    戻り値:
    スペック
    関連事項:
    BaseHttpInboundEndpoint.setPayloadExpression(Expression)
  - payloadFunction
```
public <P> S payloadFunction(java.util.function.FunctionSE<HttpEntity<P>,?> payloadFunction)
```
    メッセージペイロードを生成するために評価する FunctionSE を指定します。
    型パラメーター:
    P - 予想される HTTP リクエストの本文型。
    パラメーター:
    payloadFunction - ペイロード FunctionSE。
    戻り値:
    スペック
    関連事項:
    BaseHttpInboundEndpoint.setPayloadExpression(Expression)
  - headerExpressions
```
public S headerExpressions(MapSE<StringSE,Expression> expressions)
```
    メッセージヘッダーを生成するために評価する SpEL 式のマップを指定します。
    パラメーター:
    expressions - ヘッダーの SpEL 式の MapSE。
    戻り値:
    スペック
    関連事項:
    BaseHttpInboundEndpoint.setHeaderExpressions(Map)
  - headerExpression
```
public S headerExpression(StringSE header,
                          StringSE expression)
```
    入力する提供されたヘッダーの SpEL 式を指定します。
    パラメーター:
    header - 入力するヘッダー名。
    expression - ヘッダーの SpEL 式。
    戻り値:
    スペック
    関連事項:
    BaseHttpInboundEndpoint.setHeaderExpressions(Map)
  - headerExpression
```
public S headerExpression(StringSE header,
                          Expression expression)
```
    入力する提供されたヘッダーの SpEL 式を指定します。
    パラメーター:
    header - 入力するヘッダー名。
    expression - ヘッダーの SpEL 式。
    戻り値:
    スペック
    関連事項:
    BaseHttpInboundEndpoint.setHeaderExpressions(Map)
  - headerFunction
```
public <P> S headerFunction(StringSE header,
                            java.util.function.FunctionSE<HttpEntity<P>,?> headerFunction)
```
    提供されたヘッダーに入力する FunctionSE を指定します。
    型パラメーター:
    P - 予想される HTTP ボディ型。
    パラメーター:
    header - 追加するヘッダー名。
    headerFunction - HttpEntity に対してヘッダー値を評価する関数。
    戻り値:
    現在の仕様。
    関連事項:
    BaseHttpInboundEndpoint.setHeaderExpressions(Map)
  - headerMapper
```
public S headerMapper(HeaderMapper<HttpHeaders> mapper)
```
    HTTP ヘッダーと MessageHeaders の間のマッピング時に使用する HeaderMapper を設定します。
    パラメーター:
    mapper - ヘッダーマッパー。
    戻り値:
    現在の仕様。
  - mappedRequestHeaders
```
public S mappedRequestHeaders(StringSE... patterns)
```
    マップするリクエストヘッダーのパターン配列を提供します。
    パラメーター:
    patterns - マップするリクエストヘッダーのパターン。
    戻り値:
    現在の仕様。
    関連事項:
    DefaultHttpHeaderMapper.setOutboundHeaderNames(String[])
  - mappedResponseHeaders
```
public S mappedResponseHeaders(StringSE... patterns)
```
    マップするレスポンスヘッダーのパターン配列を提供します。
    パラメーター:
    patterns - マップするレスポンスヘッダーのパターン。
    戻り値:
    現在の仕様。
    関連事項:
    DefaultHttpHeaderMapper.setInboundHeaderNames(String[])
  - requestPayloadType
```
public S requestPayloadType(ClassSE<?> requestPayloadType)
```
    受信 HTTP リクエストコンテンツが HttpMessageConverter によって読み取られるときに生成されるペイロードの型を指定します。デフォルトでは、この値は null です。これは、実行時に「テキスト」Content-Type が String になり、他のすべてのデフォルトが byte[].class になることを意味します。
    パラメーター:
    requestPayloadType - ペイロード型。
    戻り値:
    現在の仕様。
  - requestPayloadType
```
public S requestPayloadType(ResolvableType requestPayloadType)
```
    受信 HTTP リクエストコンテンツが HttpMessageConverter によって読み取られるときに生成されるペイロードの型を指定します。デフォルトでは、この値は null です。これは、実行時に「テキスト」Content-Type が String になり、他のすべてのデフォルトが byte[].class になることを意味します。
    パラメーター:
    requestPayloadType - ペイロード型。
    戻り値:
    現在の仕様。
  - extractReplyPayload
```
public S extractReplyPayload(boolean extractReplyPayload)
```
    レスポンスメッセージのペイロードのみをレスポンスで渡すかどうかを指定します。これが false に設定されている場合、メッセージ全体がレスポンスの生成に使用されます。デフォルトは true です。
    パラメーター:
    extractReplyPayload - 応答ペイロードを抽出する場合は true。
    戻り値:
    現在の仕様。
  - statusCodeExpression
```
public S statusCodeExpression(StringSE statusCodeExpression)
```
    Expression を指定して、レスポンスのステータスコードを解決し、タイムアウトのデフォルトの "200 OK" または "500 Internal Server Error" をオーバーライドします。
    パラメーター:
    statusCodeExpression - ステータスコードの式。
    戻り値:
    現在の仕様。
    関連事項:
    BaseHttpInboundEndpoint.setStatusCodeExpression(Expression)
  - statusCodeExpression
```
public S statusCodeExpression(Expression statusCodeExpression)
```
    Expression を指定して、レスポンスのステータスコードを解決し、タイムアウトのデフォルトの "200 OK" または "500 Internal Server Error" をオーバーライドします。
    パラメーター:
    statusCodeExpression - ステータスコードの式。
    戻り値:
    現在の仕様。
    関連事項:
    BaseHttpInboundEndpoint.setStatusCodeExpression(Expression)
  - statusCodeFunction
```
public S statusCodeFunction(java.util.function.FunctionSE<RequestEntity<?>,?> statusCodeFunction)
```
    FunctionSE を指定して、レスポンスのステータスコードを解決し、タイムアウトのデフォルトの "200 OK" または "500 Internal Server Error" をオーバーライドします。
    パラメーター:
    statusCodeFunction - ステータスコード FunctionSE。
    戻り値:
    現在の仕様。
    関連事項:
    BaseHttpInboundEndpoint.setStatusCodeExpression(Expression)
  - validator
```
public S validator(Validator validator)
```
    Validator を指定して、リクエストから変換されたペイロードを検証します。
    パラメーター:
    validator - 使用する Validator。
    戻り値:
    スペック
    導入:
    5.2
  - getComponentsToRegister
```
public MapSE<ObjectSE,StringSE> getComponentsToRegister()
```
    次で指定:
    インターフェース ComponentsRegistration の getComponentsToRegister

クラス HttpInboundEndpointSupportSpec<S extends HttpInboundEndpointSupportSpec<S,E>,E extends BaseHttpInboundEndpoint>

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

フィールドのサマリー

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

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

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

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

コンストラクターの概要

メソッドのサマリー

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

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

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

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

フィールドの詳細

requestMapping

headerExpressions

headerMapper

コンストラクターの詳細

HttpInboundEndpointSupportSpec

メソッドの詳細

requestMapping

crossOrigin

payloadExpression

payloadExpression

payloadFunction

headerExpressions

headerExpression

headerExpression

headerFunction

headerMapper

mappedRequestHeaders

mappedResponseHeaders

requestPayloadType

requestPayloadType

extractReplyPayload

statusCodeExpression

statusCodeExpression

statusCodeFunction

validator

getComponentsToRegister