MessagingGatewaySupport (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.endpoint.AbstractEndpoint
  - - org.springframework.integration.gateway.MessagingGatewaySupport

実装されているすべてのインターフェース:
Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, IntegrationPattern, NamedComponent, IntegrationInboundManagement, IntegrationManagement, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent
既知の直属サブクラス
AbstractWebServiceInboundGateway, AmqpInboundGateway, BaseHttpInboundEndpoint, JmsInboundGateway, KafkaInboundGateway, RedisQueueInboundGateway, RmiInboundGateway, RSocketInboundGateway, TcpInboundGateway
```
@IntegrationManagedResource
public abstract class MessagingGatewaySupport
extends AbstractEndpoint
implements TrackableComponent, IntegrationInboundManagement, IntegrationPattern
```
送信、受信、リクエスト / 応答操作のためにアプリケーションコードを MessageChannel に接続するための便利な基本クラス。リクエストと応答の MessageChannel を構成するための setter と、メッセージを送受信するためのタイムアウト値を公開します。
作成者:
Mark Fisher, Gary Russell, Artem Bilan

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

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
protected MessagingTemplate messagingTemplate
- クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたフィールド
  lifecycleCondition, lifecycleLock
- クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド
  EXPRESSION_PARSER, logger
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド
  METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME
- インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
  DEFAULT_PHASE

フィールド
修飾子と型	フィールドと説明
`protected MessagingTemplate`	`messagingTemplate`

コンストラクターの概要

コンストラクター
コンストラクターと説明
`MessagingGatewaySupport()` 応答がない場合に null を返すインスタンスを作成します。
`MessagingGatewaySupport(boolean errorOnTimeout)` errorOnTimeout が true の場合、応答が期待されても何も受信されない場合に、`MessageTimeoutException` ペイロードを含む `ErrorMessage` をエラーチャネルに送信するインスタンスを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected ErrorMessage`	`buildErrorMessage(Message<?> requestMessage, ThrowableSE throwable)` メッセージのエラーメッセージを作成し、構成済みの `ErrorMessageStrategy` を使用してスロー可能にします。
`protected TimerFacade`	`buildSendTimer(boolean success, StringSE exception)`
`void`	`destroy()`
`protected void`	`doStart()` サブクラスは、開始動作でこのメソッドを実装する必要があります。
`protected void`	`doStop()` サブクラスは、停止動作でこのメソッドを実装する必要があります。
`StringSE`	`getComponentType()` サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
`MessageChannel`	`getErrorChannel()` エラーメッセージがルーティングされるエラーチャネル（提供されている場合）を返します。
`protected AttributeAccessor`	`getErrorMessageAttributes(Message<?> message)` `errorMessageStrategy` でエラーメッセージを作成するときに使用する `AttributeAccessor` を設定します。
`IntegrationPatternType`	`getIntegrationPatternType()` このコンポーネントが実装するパターン型を返します。
`StringSE`	`getManagedName()`
`StringSE`	`getManagedType()`
`IntegrationManagement.ManagementOverrides`	`getOverrides()` オーバーライドを返します。
`MessageChannel`	`getReplyChannel()` このゲートウェイの応答チャネルがある場合はそれを返します。
`MessageChannel`	`getRequestChannel()` このゲートウェイのリクエストチャネルを返します。
`boolean`	`isLoggingEnabled()` ロギングが有効かどうかを返します。
`protected void`	`onInit()` サブクラスは、初期化ロジック用にこれを実装できます。
`protected ObjectSE`	`receive()`
`protected ObjectSE`	`receive(long timeout)`
`protected Message<?>`	`receiveMessage()`
`protected Message<?>`	`receiveMessage(long timeout)`
`void`	`registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister)` `MetricsCaptor` を注入する
`protected void`	`registerReplyMessageCorrelatorIfNecessary()`
`protected void`	`send(ObjectSE object)`
`protected ObjectSE`	`sendAndReceive(ObjectSE object)`
`protected Message<?>`	`sendAndReceiveMessage(ObjectSE object)`
`protected reactor.core.publisher.Mono<Message<?>>`	`sendAndReceiveMessageReactive(ObjectSE object)`
`protected TimerFacade`	`sendTimer()`
`void`	`setErrorChannel(MessageChannel errorChannel)` エラーチャンネルを設定します。
`void`	`setErrorChannelName(StringSE errorChannelName)` エラーチャネル名を設定します。
`void`	`setErrorMessageStrategy(ErrorMessageStrategy errorMessageStrategy)` 例外が発生したときにエラーメッセージを作成するために使用する `ErrorMessageStrategy` を設定します。
`void`	`setErrorOnTimeout(boolean errorOnTimeout)` errorOnTimeout が true の場合、応答が期待されても何も受信されない場合に、`MessageTimeoutException` ペイロードを含む `ErrorMessage` をエラーチャネルに送信するインスタンスを作成します。
`void`	`setLoggingEnabled(boolean enabled)` ロギングを有効にするかどうか。
`void`	`setManagedName(StringSE managedName)`
`void`	`setManagedType(StringSE managedType)`
`void`	`setReplyChannel(MessageChannel replyChannel)` 返信チャンネルを設定します。
`void`	`setReplyChannelName(StringSE replyChannelName)` 返信チャンネル名を設定します。
`void`	`setReplyMapper(OutboundMessageMapper<?> replyMapper)` 受信または sendAndReceive 操作で受信した応答メッセージからオブジェクトにマッピングするための `OutboundMessageMapper` を提供します。
`void`	`setReplyTimeout(long replyTimeout)` 応答メッセージを受信するためのタイムアウト値を設定します。
`void`	`setRequestChannel(MessageChannel requestChannel)` リクエストチャネルを設定します。
`void`	`setRequestChannelName(StringSE requestChannelName)` リクエストチャンネル名を設定します。
`void`	`setRequestMapper(InboundMessageMapper<?> requestMapper)` 送信または sendAndReceive 操作で渡された任意のオブジェクトからリクエストメッセージを作成するための `InboundMessageMapper` を提供します。
`void`	`setRequestTimeout(long requestTimeout)` リクエストメッセージを送信するためのタイムアウト値を設定します。
`void`	`setShouldTrack(boolean shouldTrack)` このゲートウェイを、送信または sendAndReceive 操作から生成されたメッセージのメッセージ履歴で追跡するかどうかを指定します。

クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたメソッド
doStop, getPhase, getRole, isAutoStartup, isRunning, setAutoStartup, setPhase, setRole, start, stop, stop

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

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

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

- フィールドの詳細
  - messagingTemplate
```
protected final MessagingTemplate messagingTemplate
```
- コンストラクターの詳細
  - MessagingGatewaySupport
```
public MessagingGatewaySupport()
```
    応答がない場合に null を返すインスタンスを作成します。
  - MessagingGatewaySupport
```
public MessagingGatewaySupport(boolean errorOnTimeout)
```
    errorOnTimeout が true の場合、応答が期待されても何も受信されない場合に、MessageTimeoutException ペイロードを含む ErrorMessage をエラーチャネルに送信するインスタンスを作成します。エラーチャネルが設定されていない場合、MessageTimeoutException がスローされます。
    パラメーター:
    errorOnTimeout - エラーメッセージを作成するには true。
    導入:
    4.2
    関連事項:
    setErrorOnTimeout(boolean)
- メソッドの詳細
  - setErrorOnTimeout
```
public void setErrorOnTimeout(boolean errorOnTimeout)
```
    errorOnTimeout が true の場合、応答が期待されても何も受信されない場合に、MessageTimeoutException ペイロードを含む ErrorMessage をエラーチャネルに送信するインスタンスを作成します。エラーチャネルが設定されていない場合、MessageTimeoutException がスローされます。
    パラメーター:
    errorOnTimeout - true の場合、応答タイムアウト時にエラーメッセージを作成します。
    導入:
    5.2.2
  - setRequestChannel
```
public void setRequestChannel(MessageChannel requestChannel)
```
    リクエストチャネルを設定します。
    パラメーター:
    requestChannel - リクエストメッセージの送信先のチャネル
  - setRequestChannelName
```
public void setRequestChannelName(StringSE requestChannelName)
```
    リクエストチャンネル名を設定します。
    パラメーター:
    requestChannelName - リクエストメッセージの送信先となるチャネル Bean 名
    導入:
    4.1
  - setReplyChannel
```
public void setReplyChannel(MessageChannel replyChannel)
```
    返信チャンネルを設定します。応答チャネルが提供されていない場合、このゲートウェイは常に匿名の一時チャネルを使用して応答を処理します。
    パラメーター:
    replyChannel - 返信メッセージの受信元のチャネル
  - setReplyChannelName
```
public void setReplyChannelName(StringSE replyChannelName)
```
    返信チャンネル名を設定します。応答チャネルが提供されていない場合、このゲートウェイは常に匿名の一時チャネルを使用して応答を処理します。
    パラメーター:
    replyChannelName - 応答メッセージの受信元となるチャネル Bean 名
    導入:
    4.1
  - setErrorChannel
```
public void setErrorChannel(MessageChannel errorChannel)
```
    エラーチャネルを設定します。エラーチャネルが指定されていない場合、このゲートウェイは呼び出し元に例外を伝播します。例外を完全に抑制するには、ここで "nullChannel" への参照を指定します。
    パラメーター:
    errorChannel - エラーチャネル。
  - setErrorChannelName
```
public void setErrorChannelName(StringSE errorChannelName)
```
    エラーチャネル名を設定します。エラーチャネルが指定されていない場合、このゲートウェイは呼び出し元に例外を伝播します。例外を完全に抑制するには、ここで "nullChannel" への参照を指定します。
    パラメーター:
    errorChannelName - エラーチャネル Bean 名。
    導入:
    4.1
  - setRequestTimeout
```
public void setRequestTimeout(long requestTimeout)
```
    リクエストメッセージを送信するためのタイムアウト値を設定します。明示的に設定されていない場合、デフォルトは 1 秒です。
    パラメーター:
    requestTimeout - ミリ秒単位のタイムアウト値
  - setReplyTimeout
```
public void setReplyTimeout(long replyTimeout)
```
    応答メッセージを受信するためのタイムアウト値を設定します。明示的に設定されていない場合、デフォルトは 1 秒です。
    パラメーター:
    replyTimeout - ミリ秒単位のタイムアウト値
  - setRequestMapper
```
public void setRequestMapper(@Nullable
                             InboundMessageMapper<?> requestMapper)
```
    送信または sendAndReceive 操作で渡された任意のオブジェクトからリクエストメッセージを作成するための InboundMessageMapper を提供します。
    パラメーター:
    requestMapper - リクエストマッパー。
  - setReplyMapper
```
public void setReplyMapper(OutboundMessageMapper<?> replyMapper)
```
    受信または sendAndReceive 操作で受信した応答メッセージからオブジェクトにマッピングするための OutboundMessageMapper を提供します。
    パラメーター:
    replyMapper - 返信マッパー。
  - setShouldTrack
```
public void setShouldTrack(boolean shouldTrack)
```
    このゲートウェイを、送信または sendAndReceive 操作から生成されたメッセージのメッセージ履歴で追跡するかどうかを指定します。
    次で指定:
    インターフェース TrackableComponent の setShouldTrack
  - getComponentType
```
public StringSE getComponentType()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
    次で指定:
    インターフェース NamedComponent の getComponentType
    オーバーライド:
    クラス IntegrationObjectSupport の getComponentType
  - setLoggingEnabled
```
public void setLoggingEnabled(boolean enabled)
```
    インターフェースからコピーされた説明: IntegrationManagement
    ロギングを有効にするかどうか。
    次で指定:
    インターフェース IntegrationManagement の setLoggingEnabled
    パラメーター:
    enabled - 無効にする dalse。
  - isLoggingEnabled
```
public boolean isLoggingEnabled()
```
    インターフェースからコピーされた説明: IntegrationManagement
    ロギングが有効かどうかを返します。
    次で指定:
    インターフェース IntegrationManagement の isLoggingEnabled
    戻り値:
    有効な場合は true。
  - setErrorMessageStrategy
```
public final void setErrorMessageStrategy(ErrorMessageStrategy errorMessageStrategy)
```
    例外が発生したときにエラーメッセージを作成するために使用する ErrorMessageStrategy を設定します。デフォルトは DefaultErrorMessageStrategy です。
    パラメーター:
    errorMessageStrategy - ErrorMessageStrategy
    導入:
    4.3.10
  - getOverrides
```
public IntegrationManagement.ManagementOverrides getOverrides()
```
    インターフェースからコピーされた説明: IntegrationManagement
    オーバーライドを返します。
    次で指定:
    インターフェース IntegrationManagement の getOverrides
    戻り値:
    オーバーライド。
  - setManagedType
```
public void setManagedType(StringSE managedType)
```
    次で指定:
    インターフェース IntegrationManagement の setManagedType
  - getManagedType
```
public StringSE getManagedType()
```
    次で指定:
    インターフェース IntegrationManagement の getManagedType
  - setManagedName
```
public void setManagedName(StringSE managedName)
```
    次で指定:
    インターフェース IntegrationManagement の setManagedName
  - getManagedName
```
public StringSE getManagedName()
```
    次で指定:
    インターフェース IntegrationManagement の getManagedName
  - getIntegrationPatternType
```
public IntegrationPatternType getIntegrationPatternType()
```
    インターフェースからコピーされた説明: IntegrationPattern
    このコンポーネントが実装するパターン型を返します。
    次で指定:
    インターフェース IntegrationPattern の getIntegrationPatternType
    戻り値:
    このコンポーネントが実装する IntegrationPatternType
  - registerMetricsCaptor
```
public void registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister)
```
    インターフェースからコピーされた説明: IntegrationManagement
    MetricsCaptor を注入する
    次で指定:
    インターフェース IntegrationManagement の registerMetricsCaptor
    パラメーター:
    metricsCaptorToRegister - キャプター。
  - onInit
```
protected void onInit()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスは、初期化ロジック用にこれを実装できます。
    オーバーライド:
    クラス AbstractEndpoint の onInit
  - getRequestChannel
```
@Nullable
public MessageChannel getRequestChannel()
```
    このゲートウェイのリクエストチャネルを返します。
    戻り値:
    チャンネル。
    導入:
    4.2
  - getReplyChannel
```
@Nullable
public MessageChannel getReplyChannel()
```
    このゲートウェイの応答チャネルがある場合はそれを返します。
    戻り値:
    応答チャネルインスタンス
    導入:
    5.1
  - getErrorChannel
```
@Nullable
public MessageChannel getErrorChannel()
```
    エラーメッセージがルーティングされるエラーチャネル（提供されている場合）を返します。
    戻り値:
    チャネルまたは null。
    導入:
    4.3
  - send
```
protected void send(ObjectSE object)
```
  - receive
```
@Nullable
protected ObjectSE receive()
```
  - receiveMessage
```
@Nullable
protected Message<?> receiveMessage()
```
  - receive
```
@Nullable
protected ObjectSE receive(long timeout)
```
  - receiveMessage
```
@Nullable
protected Message<?> receiveMessage(long timeout)
```
  - sendAndReceive
```
@Nullable
protected ObjectSE sendAndReceive(ObjectSE object)
```
  - sendAndReceiveMessage
```
@Nullable
protected Message<?> sendAndReceiveMessage(ObjectSE object)
```
  - sendAndReceiveMessageReactive
```
protected reactor.core.publisher.Mono<Message<?>> sendAndReceiveMessageReactive(ObjectSE object)
```
  - sendTimer
```
protected TimerFacade sendTimer()
```
  - buildSendTimer
```
protected TimerFacade buildSendTimer(boolean success,
                                     StringSE exception)
```
  - buildErrorMessage
```
protected final ErrorMessage buildErrorMessage(@Nullable
                                               Message<?> requestMessage,
                                               ThrowableSE throwable)
```
    メッセージのエラーメッセージを作成し、構成済みの ErrorMessageStrategy を使用してスロー可能にします。
    パラメーター:
    requestMessage - requestMessage。
    throwable - スローアブル。
    戻り値:
    エラーメッセージ。
    導入:
    4.3.10
  - getErrorMessageAttributes
```
protected AttributeAccessor getErrorMessageAttributes(@Nullable
                                                      Message<?> message)
```
    errorMessageStrategy でエラーメッセージを作成するときに使用する AttributeAccessor を設定します。
    パラメーター:
    message - メッセージ。
    戻り値:
    属性。
    導入:
    4.3.10
  - registerReplyMessageCorrelatorIfNecessary
```
protected void registerReplyMessageCorrelatorIfNecessary()
```
  - doStart
```
protected void doStart()
```
    クラスからコピーされた説明: AbstractEndpoint
    サブクラスは、開始動作でこのメソッドを実装する必要があります。このメソッドは、AbstractEndpoint.lifecycleLock を保持しているときに呼び出されます。
    次で指定:
    クラス AbstractEndpoint の doStart
  - doStop
```
protected void doStop()
```
    クラスからコピーされた説明: AbstractEndpoint
    サブクラスは、停止動作でこのメソッドを実装する必要があります。このメソッドは、AbstractEndpoint.lifecycleLock を保持しているときに呼び出されます。
    次で指定:
    クラス AbstractEndpoint の doStop
  - destroy
```
public void destroy()
```
    次で指定:
    インターフェース DisposableBean の destroy
    次で指定:
    インターフェース IntegrationManagement の destroy
    オーバーライド:
    クラス AbstractEndpoint の destroy

クラス MessagingGatewaySupport

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

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

フィールドのサマリー

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

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

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

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

コンストラクターの概要

メソッドのサマリー

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

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

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

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

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

フィールドの詳細

messagingTemplate

コンストラクターの詳細

MessagingGatewaySupport

MessagingGatewaySupport

メソッドの詳細

setErrorOnTimeout

setRequestChannel

setRequestChannelName

setReplyChannel

setReplyChannelName

setErrorChannel

setErrorChannelName

setRequestTimeout

setReplyTimeout

setRequestMapper

setReplyMapper

setShouldTrack

getComponentType

setLoggingEnabled

isLoggingEnabled

setErrorMessageStrategy

getOverrides

setManagedType

getManagedType

setManagedName

getManagedName

getIntegrationPatternType

registerMetricsCaptor

onInit

getRequestChannel

getReplyChannel

getErrorChannel

send

receive

receiveMessage

receive

receiveMessage

sendAndReceive

sendAndReceiveMessage

sendAndReceiveMessageReactive

sendTimer

buildSendTimer

buildErrorMessage

getErrorMessageAttributes

registerReplyMessageCorrelatorIfNecessary

doStart

doStop

destroy