パッケージ org.springframework.integration.endpoint

クラス MessageProducerSupport

java.lang.ObjectSE
org.springframework.integration.context.IntegrationObjectSupport
org.springframework.integration.endpoint.AbstractEndpoint
org.springframework.integration.endpoint.MessageProducerSupport
実装されたすべてのインターフェース:
Aware、BeanFactoryAware、BeanNameAware、DisposableBean、InitializingBean、SmartInitializingSingleton、ApplicationContextAware、Lifecycle、Phased、SmartLifecycle、ExpressionCapable、MessageProducer、IntegrationPattern、NamedComponent、IntegrationInboundManagement、IntegrationManagement、ManageableLifecycle、ManageableSmartLifecycle、TrackableComponent
既知の直属サブクラス
AbstractHazelcastMessageProducer、AbstractInternetProtocolReceivingChannelAdapter、AbstractMqttMessageDrivenChannelAdapter、AbstractXmppConnectionAwareEndpoint、AmqpInboundChannelAdapter、DebeziumMessageProducer、ExpressionMessageProducerSupport、FileTailingMessageProducerSupport、HazelcastClusterMonitorMessageProducer、ImapIdleChannelAdapter、JmsMessageDrivenEndpoint、KafkaMessageDrivenChannelAdapter、MongoDbChangeStreamMessageProducer、NotificationListeningMessageProducer、ReactiveMessageSourceProducer、ReactiveRedisStreamMessageProducer、RedisInboundChannelAdapter、RedisQueueMessageDrivenEndpoint、StompInboundChannelAdapter、SyslogReceivingChannelAdapterSupport、TcpReceivingChannelAdapter、WebSocketInboundChannelAdapter、ZeroMqMessageProducer
public abstract class MessageProducerSupport extends AbstractEndpoint implements MessageProducer, TrackableComponent, SmartInitializingSingleton, IntegrationPattern, IntegrationInboundManagement
出力チャネルに setter を提供し、メッセージを送信するための便利なメソッドを提供するプロデューサーエンドポイントのサポートクラス。
作成者:
Mark Fisher, Artem Bilan, Gary Russell

  • コンストラクターの詳細

    • MessageProducerSupport

      protected MessageProducerSupport()

  • メソッドの詳細

    • setOutputChannel

      public void setOutputChannel(MessageChannel outputChannel)
      インターフェースからコピーされた説明: MessageProducer
      生成されたメッセージの送信先となる MessageChannel を指定します。
      次で指定:
      インターフェース MessageProducer の setOutputChannel 
      パラメーター:
      outputChannel - 出力チャネル。

    • setOutputChannelName

      public void setOutputChannelName(StringSE outputChannelName)
      出力チャネル名を設定します。提供されている場合、outputChannel をオーバーライドします。
      次で指定:
      インターフェース MessageProducer の setOutputChannelName 
      パラメーター:
      outputChannelName - チャンネル名。
      導入:
      4.3

    • getOutputChannel

      public MessageChannel getOutputChannel()
      インターフェースからコピーされた説明: MessageProducer
      出力チャネルを返します。
      次で指定:
      インターフェース MessageProducer の getOutputChannel 
      戻り値:
      チャンネル。

    • setErrorChannel

      public void setErrorChannel(MessageChannel errorChannel)

    • setErrorChannelName

      public void setErrorChannelName(StringSE errorChannelName)
      エラーチャネル名を設定します。エラーチャネルが提供されていない場合、このエンドポイントは例外をメッセージ駆動型ソースに伝播します。例外を完全に抑制するには、ここで "nullChannel" への参照を提供します。
      パラメーター:
      errorChannelName - エラーチャネル Bean 名。
      導入:
      4.3

    • getErrorChannel

      @Nullable public MessageChannel getErrorChannel()
      エラーメッセージがルーティングされるエラーチャネル（提供されている場合）を返します。
      戻り値:
      チャネルまたは null。
      導入:
      4.3

    • setSendTimeout

      public void setSendTimeout(long sendTimeout)
      送信操作に使用するデフォルトのタイムアウト値を構成します。個々のメッセージに対してオーバーライドされる場合があります。
      パラメーター:
      sendTimeout - 「送信」操作のタイムアウト (ミリ秒)
      関連事項:

    • setShouldTrack

      public void setShouldTrack(boolean shouldTrack)
      次で指定:
      インターフェース TrackableComponent の setShouldTrack 

    • setErrorMessageStrategy

      public final void setErrorMessageStrategy(ErrorMessageStrategy errorMessageStrategy)
      例外が発生したときにエラーメッセージを作成するために使用する ErrorMessageStrategy を設定します。デフォルトは DefaultErrorMessageStrategy です。
      パラメーター:
      errorMessageStrategy - ErrorMessageStrategy
      導入:
      4.3.10

    • getErrorMessageStrategy

      protected ErrorMessageStrategy getErrorMessageStrategy()
      例外が発生したときにエラーメッセージを作成するために使用する ErrorMessageStrategy を取得します。デフォルトは DefaultErrorMessageStrategy です。
      戻り値:
      エラーメッセージ戦略
      導入:
      6.0

    • getMessagingTemplate

      protected MessagingTemplate getMessagingTemplate()

    • setObservationConvention

      public void setObservationConvention(@Nullable MessageReceiverObservationConvention observationConvention)
      IntegrationObservation.HANDLER にカスタム MessageReceiverObservationConvention を設定します。このコンポーネントに対して ObservationRegistry が構成されていない場合は無視されます。
      パラメーター:
      observationConvention - 使用する MessageReceiverObservationConvention。
      導入:
      6.0

    • 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。

    • getIntegrationPatternType

      public IntegrationPatternType getIntegrationPatternType()
      インターフェースからコピーされた説明: IntegrationPattern
      このコンポーネントが実装するパターン型を返します。
      次で指定:
      インターフェース IntegrationPattern の getIntegrationPatternType 
      戻り値:
      このコンポーネントが実装する IntegrationPatternType

    • afterSingletonsInstantiated

      public void afterSingletonsInstantiated()
      次で指定:
      インターフェース SmartInitializingSingleton の afterSingletonsInstantiated 

    • onInit

      protected void onInit()
      クラスからコピーされた説明: IntegrationObjectSupport
      サブクラスは、初期化ロジック用にこれを実装できます。
      オーバーライド:
      クラス AbstractEndpoint の onInit 

    • doStart

      protected void doStart()
      デフォルトでは何もしません。サブクラスは、ライフサイクル管理の動作が必要な場合、これをオーバーライドできます。"lifecycleLock" によって保護されています。
      次で指定:
      クラス AbstractEndpoint の doStart 

    • doStop

      protected void doStop()
      デフォルトでは何もしません。サブクラスは、ライフサイクル管理の動作が必要な場合、これをオーバーライドできます。
      次で指定:
      クラス AbstractEndpoint の doStop 

    • sendMessage

      protected void sendMessage(Message<?> message)

    • subscribeToPublisher

      protected void subscribeToPublisher(org.reactivestreams.Publisher<? extends Message<?>> publisher)

    • sendErrorMessageIfNecessary

      protected final boolean sendErrorMessageIfNecessary(@Nullable Message<?> message, ExceptionSE exception)
      例外とメッセージに基づいてエラーメッセージを送信します。
      パラメーター:
      message - メッセージ。
      exception - 例外。
      戻り値:
      エラーチャネルが利用可能で、メッセージが送信された場合は true。
      導入:
      4.3.10

    • buildErrorMessage

      protected final ErrorMessage buildErrorMessage(@Nullable Message<?> message, ExceptionSE exception)
      構成された ErrorMessageStrategy を使用して、例外とメッセージのエラーメッセージを作成します。
      パラメーター:
      message - メッセージ。
      exception - 例外。
      戻り値:
      エラーメッセージ。
      導入:
      4.3.10

    • getErrorMessageAttributes

      protected AttributeAccessor getErrorMessageAttributes(@Nullable Message<?> message)
      errorMessageStrategy でエラーメッセージを作成するときに使用する AttributeAccessor を設定します。
      パラメーター:
      message - メッセージ。
      戻り値:
      属性。
      導入:
      4.3.10