クラス MessagingGatewaySupport
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
、RSocketInboundGateway
、TcpInboundGateway
@IntegrationManagedResource
public abstract class MessagingGatewaySupport
extends AbstractEndpoint
implements TrackableComponent, IntegrationInboundManagement, IntegrationPattern
送信、受信、リクエスト / 応答操作のためにアプリケーションコードを
MessageChannel
に接続するための便利な基本クラス。リクエストと応答の MessageChannel
を構成するための setter と、メッセージを送受信するためのタイムアウト値を公開します。- 作成者:
- Mark Fisher, Gary Russell, Artem Bilan, Trung Pham, Christian Tzolov
ネストされたクラスのサマリー
ネストされたクラス修飾子と型クラス説明protected static class
監視コンテキストからリクエストメッセージにアクセスできるようにMessagingGatewaySupport.ConvertingMessagingTemplate.doConvert(Object, Map, MessagePostProcessor)
の可視性を高めるMessagingTemplate
拡張機能。インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース
IntegrationManagement.ManagementOverrides
フィールドサマリー
フィールドクラス 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
コンストラクターのサマリー
コンストラクターコンストラクター説明応答がない場合に null を返すインスタンスを作成します。MessagingGatewaySupport
(boolean errorOnTimeout) errorOnTimeout が true の場合、応答が期待されても何も受信されない場合に、MessageTimeoutException
ペイロードを含むErrorMessage
をエラーチャネルに送信するインスタンスを作成します。メソッドのサマリー
修飾子と型メソッド説明protected final ErrorMessage
buildErrorMessage
(Message<?> requestMessage, ThrowableSE throwable) メッセージのエラーメッセージを作成し、構成済みのErrorMessageStrategy
を使用してスロー可能にします。protected TimerFacade
buildSendTimer
(boolean success, StringSE exception) void
destroy()
protected void
doStart()
サブクラスは、開始動作でこのメソッドを実装する必要があります。protected void
doStop()
サブクラスは、停止動作でこのメソッドを実装する必要があります。サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。エラーメッセージがルーティングされるエラーチャネル(提供されている場合)を返します。protected AttributeAccessor
getErrorMessageAttributes
(Message<?> message) errorMessageStrategy
でエラーメッセージを作成するときに使用するAttributeAccessor
を設定します。protected ErrorMessageStrategy
例外が発生したときにエラーメッセージを作成するために使用するErrorMessageStrategy
を取得します。このコンポーネントが実装するパターン型を返します。オーバーライドを返します。このゲートウェイの応答チャネルがある場合はそれを返します。このゲートウェイのリクエストチャネルを返します。boolean
ロギングが有効かどうかを返します。boolean
この実装がObservationRegistry.NOOP
インスタンス以外のレジストリを処理する場合は true。protected void
onInit()
サブクラスは、初期化ロジック用にこれを実装できます。protected ObjectSE
receive()
protected ObjectSE
receive
(long timeout) protected Message<?>
protected Message<?>
receiveMessage
(long timeout) void
registerMetricsCaptor
(MetricsCaptor metricsCaptorToRegister) MetricsCaptor
を注入します。void
registerObservationRegistry
(io.micrometer.observation.ObservationRegistry observationRegistry) ObservationRegistry
を注入します。protected void
protected void
protected ObjectSE
sendAndReceive
(ObjectSE object) protected Message<?>
sendAndReceiveMessage
(ObjectSE object) protected reactor.core.publisher.Mono<Message<?>>
protected TimerFacade
void
setErrorChannel
(MessageChannel errorChannel) エラーチャンネルを設定します。void
setErrorChannelName
(StringSE errorChannelName) エラーチャネル名を設定します。final 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
setObservationConvention
(MessageRequestReplyReceiverObservationConvention observationConvention) void
setReceiverObservationConvention
(MessageReceiverObservationConvention receiverObservationConvention) void
setReplyChannel
(MessageChannel replyChannel) 返信チャンネルを設定します。void
setReplyChannelName
(StringSE replyChannelName) 返信チャンネル名を設定します。void
setReplyMapper
(OutboundMessageMapper<?> replyMapper) receive または sendAndReceive 操作で受信した応答メッセージからオブジェクトにマッピングするためのOutboundMessageMapper
を提供します。void
setReplyTimeout
(long replyTimeout) 応答メッセージを受信するためのタイムアウト値を設定します。void
setRequestChannel
(MessageChannel requestChannel) リクエストチャネルを設定します。void
setRequestChannelName
(StringSE requestChannelName) リクエストチャンネル名を設定します。void
setRequestMapper
(InboundMessageMapper<?> requestMapper) void
setRequestTimeout
(long requestTimeout) リクエストメッセージを送信するためのタイムアウト値を設定します。void
setShouldTrack
(boolean shouldTrack) このゲートウェイを、送信操作または sendAndReceive 操作から発信されたメッセージのメッセージ履歴で追跡する必要があるかどうかを指定します。クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたメソッド
doStop, getPhase, getRole, isActive, 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, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSE
インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたメソッド
getThisAs
インターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド
getBeanName, getComponentName
フィールドの詳細
messagingTemplate
コンストラクターの詳細
MessagingGatewaySupport
public MessagingGatewaySupport()応答がない場合に null を返すインスタンスを作成します。MessagingGatewaySupport
public MessagingGatewaySupport(boolean errorOnTimeout) errorOnTimeout が true の場合、応答が期待されても何も受信されない場合に、MessageTimeoutException
ペイロードを含むErrorMessage
をエラーチャネルに送信するインスタンスを作成します。エラーチャネルが設定されていない場合、MessageTimeoutException
がスローされます。- パラメーター:
errorOnTimeout
- エラーメッセージを作成するには true。- 導入:
- 4.2
- 関連事項:
メソッドの詳細
setErrorOnTimeout
public void setErrorOnTimeout(boolean errorOnTimeout) errorOnTimeout が true の場合、応答が期待されても何も受信されない場合に、MessageTimeoutException
ペイロードを含むErrorMessage
をエラーチャネルに送信するインスタンスを作成します。エラーチャネルが設定されていない場合、MessageTimeoutException
がスローされます。- パラメーター:
errorOnTimeout
- true の場合、応答タイムアウト時にエラーメッセージを作成します。- 導入:
- 5.2.2
setRequestChannel
リクエストチャネルを設定します。- パラメーター:
requestChannel
- リクエストメッセージの送信先のチャネル
setRequestChannelName
リクエストチャンネル名を設定します。- パラメーター:
requestChannelName
- リクエストメッセージの送信先となるチャネル Bean 名- 導入:
- 4.1
setReplyChannel
返信チャンネルを設定します。応答チャネルが提供されていない場合、このゲートウェイは常に匿名の一時チャネルを使用して応答を処理します。- パラメーター:
replyChannel
- 返信メッセージの受信元のチャネル
setReplyChannelName
返信チャンネル名を設定します。応答チャネルが提供されていない場合、このゲートウェイは常に匿名の一時チャネルを使用して応答を処理します。- パラメーター:
replyChannelName
- 応答メッセージの受信元となるチャネル Bean 名- 導入:
- 4.1
setErrorChannel
エラーチャンネルを設定します。エラーチャネルが提供されていない場合、このゲートウェイは例外を呼び出し元に伝達します。例外を完全に抑制するには、ここで "nullChannel" への参照を提供します。- パラメーター:
errorChannel
- エラーチャネル。
setErrorChannelName
エラーチャネル名を設定します。エラーチャネルが提供されていない場合、このゲートウェイは例外を呼び出し元に伝達します。例外を完全に抑制するには、ここで "nullChannel" への参照を提供します。- パラメーター:
errorChannelName
- エラーチャネル Bean 名。- 導入:
- 4.1
setRequestTimeout
public void setRequestTimeout(long requestTimeout) リクエストメッセージを送信するためのタイムアウト値を設定します。明示的に設定されていない場合、デフォルトは 1 秒です。- パラメーター:
requestTimeout
- ミリ秒単位のタイムアウト値
setReplyTimeout
public void setReplyTimeout(long replyTimeout) 応答メッセージを受信するためのタイムアウト値を設定します。明示的に設定されていない場合、デフォルトは 1 秒です。- パラメーター:
replyTimeout
- ミリ秒単位のタイムアウト値
setRequestMapper
- パラメーター:
requestMapper
- リクエストマッパー。
setReplyMapper
receive または sendAndReceive 操作で受信した応答メッセージからオブジェクトにマッピングするためのOutboundMessageMapper
を提供します。- パラメーター:
replyMapper
- 返信マッパー。
setShouldTrack
public void setShouldTrack(boolean shouldTrack) このゲートウェイを、送信操作または sendAndReceive 操作から発信されたメッセージのメッセージ履歴で追跡する必要があるかどうかを指定します。- 次で指定:
- インターフェース
TrackableComponent
のsetShouldTrack
getComponentType
クラスからコピーされた説明:IntegrationObjectSupport
サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。- 次で指定:
- インターフェース
NamedComponent
のgetComponentType
- オーバーライド:
- クラス
IntegrationObjectSupport
のgetComponentType
setLoggingEnabled
public void setLoggingEnabled(boolean enabled) インターフェースからコピーされた説明:IntegrationManagement
ロギングを有効にするかどうか。- 次で指定:
- インターフェース
IntegrationManagement
のsetLoggingEnabled
- パラメーター:
enabled
- 無効にする場合は false。
isLoggingEnabled
public boolean isLoggingEnabled()インターフェースからコピーされた説明:IntegrationManagement
ロギングが有効かどうかを返します。- 次で指定:
- インターフェース
IntegrationManagement
のisLoggingEnabled
- 戻り値:
- 有効な場合は true。
setErrorMessageStrategy
例外が発生したときにエラーメッセージを作成するために使用するErrorMessageStrategy
を設定します。デフォルトはDefaultErrorMessageStrategy
です。- パラメーター:
errorMessageStrategy
-ErrorMessageStrategy
- 導入:
- 4.3.10
getErrorMessageStrategy
例外が発生したときにエラーメッセージを作成するために使用するErrorMessageStrategy
を取得します。デフォルトはDefaultErrorMessageStrategy
です。- 戻り値:
- エラーメッセージ戦略。
- 導入:
- 6.0
getOverrides
インターフェースからコピーされた説明:IntegrationManagement
オーバーライドを返します。- 次で指定:
- インターフェース
IntegrationManagement
のgetOverrides
- 戻り値:
- オーバーライド。
setManagedType
- 次で指定:
- インターフェース
IntegrationManagement
のsetManagedType
getManagedType
- 次で指定:
- インターフェース
IntegrationManagement
のgetManagedType
setManagedName
- 次で指定:
- インターフェース
IntegrationManagement
のsetManagedName
getManagedName
- 次で指定:
- インターフェース
IntegrationManagement
のgetManagedName
getIntegrationPatternType
インターフェースからコピーされた説明:IntegrationPattern
このコンポーネントが実装するパターン型を返します。- 次で指定:
- インターフェース
IntegrationPattern
のgetIntegrationPatternType
- 戻り値:
- このコンポーネントが実装する
IntegrationPatternType
registerMetricsCaptor
インターフェースからコピーされた説明:IntegrationManagement
MetricsCaptor
を注入します。ObservationRegistry
が指定されている場合は無視されます。- 次で指定:
- インターフェース
IntegrationManagement
のregisterMetricsCaptor
- パラメーター:
metricsCaptorToRegister
- キャプター。- 関連事項:
registerObservationRegistry
public void registerObservationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry) インターフェースからコピーされた説明:IntegrationManagement
ObservationRegistry
を注入します。指定された場合、MetricsCaptor
は無視されます。メーターのキャプチャーは、提供されたObservationRegistry
でObservationHandler
として構成する必要があります。- 次で指定:
- インターフェース
IntegrationManagement
のregisterObservationRegistry
- パラメーター:
observationRegistry
- コンポーネントからの観察結果を公開するObservationRegistry
。- 関連事項:
isObserved
public boolean isObserved()インターフェースからコピーされた説明:IntegrationManagement
この実装がObservationRegistry.NOOP
インスタンス以外のレジストリを処理する場合は true。- 次で指定:
- インターフェース
IntegrationManagement
のisObserved
- 戻り値:
- この実装が
ObservationRegistry.NOOP
インスタンス以外のレジストリを処理する場合は true。
setObservationConvention
public void setObservationConvention(@Nullable MessageRequestReplyReceiverObservationConvention observationConvention) setReceiverObservationConvention
public void setReceiverObservationConvention(MessageReceiverObservationConvention receiverObservationConvention) onInit
protected void onInit()クラスからコピーされた説明:IntegrationObjectSupport
サブクラスは、初期化ロジック用にこれを実装できます。- オーバーライド:
- クラス
AbstractEndpoint
のonInit
getRequestChannel
このゲートウェイのリクエストチャネルを返します。- 戻り値:
- チャンネル。
- 導入:
- 4.2
getReplyChannel
このゲートウェイの応答チャネルがある場合はそれを返します。- 戻り値:
- 応答チャネルインスタンス
- 導入:
- 5.1
getErrorChannel
エラーメッセージがルーティングされるエラーチャネル(提供されている場合)を返します。- 戻り値:
- チャネルまたは null。
- 導入:
- 4.3
send
receive
receiveMessage
receive
receiveMessage
sendAndReceive
sendAndReceiveMessage
sendAndReceiveMessageReactive
sendTimer
buildSendTimer
buildErrorMessage
protected final ErrorMessage buildErrorMessage(@Nullable Message<?> requestMessage, ThrowableSE throwable) メッセージのエラーメッセージを作成し、構成済みのErrorMessageStrategy
を使用してスロー可能にします。- パラメーター:
requestMessage
- requestMessage。throwable
- スローアブル。- 戻り値:
- エラーメッセージ。
- 導入:
- 4.3.10
getErrorMessageAttributes
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