MessageProducerSupport (Spring Integration API)

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, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent
既知の直属サブクラス
AbstractInternetProtocolReceivingChannelAdapter, AbstractMqttMessageDrivenChannelAdapter, AbstractXmppConnectionAwareEndpoint, AmqpInboundChannelAdapter, ExpressionMessageProducerSupport, FileTailingMessageProducerSupport, 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
```
出力チャネルに setter を提供し、メッセージを送信するための便利なメソッドを提供するプロデューサーエンドポイントのサポートクラス。
作成者:
Mark Fisher, Artem Bilan, Gary Russell

フィールドのサマリー
- クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたフィールド
  lifecycleCondition, lifecycleLock
- クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド
  EXPRESSION_PARSER, logger
- インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
  DEFAULT_PHASE

コンストラクターの概要
コンストラクター
修飾子コンストラクターと説明
protected MessageProducerSupport()

コンストラクター
修飾子	コンストラクターと説明
`protected`	`MessageProducerSupport()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterSingletonsInstantiated()`
`protected ErrorMessage`	`buildErrorMessage(Message<?> message, ExceptionSE exception)` 構成された `ErrorMessageStrategy` を使用して、例外とメッセージのエラーメッセージを作成します。
`protected void`	`doStart()` デフォルトでは何もしません。
`protected void`	`doStop()` デフォルトでは何もしません。
`MessageChannel`	`getErrorChannel()` エラーメッセージがルーティングされるエラーチャネル（提供されている場合）を返します。
`protected AttributeAccessor`	`getErrorMessageAttributes(Message<?> message)` `errorMessageStrategy` でエラーメッセージを作成するときに使用する `AttributeAccessor` を設定します。
`IntegrationPatternType`	`getIntegrationPatternType()` このコンポーネントが実装するパターン型を返します。
`protected MessagingTemplate`	`getMessagingTemplate()`
`MessageChannel`	`getOutputChannel()` 出力チャネルを返します。
`protected void`	`onInit()` サブクラスは、初期化ロジック用にこれを実装できます。
`protected boolean`	`sendErrorMessageIfNecessary(Message<?> message, ExceptionSE exception)` 例外とメッセージに基づいてエラーメッセージを送信します。
`protected void`	`sendMessage(Message<?> messageArg)`
`void`	`setErrorChannel(MessageChannel errorChannel)`
`void`	`setErrorChannelName(StringSE errorChannelName)` エラーチャネル名を設定します。
`void`	`setErrorMessageStrategy(ErrorMessageStrategy errorMessageStrategy)` 例外が発生したときにエラーメッセージを作成するために使用する `ErrorMessageStrategy` を設定します。
`void`	`setOutputChannel(MessageChannel outputChannel)` 生成されたメッセージの送信先となる `MessageChannel` を指定します。
`void`	`setOutputChannelName(StringSE outputChannelName)` 出力チャネル名を設定します。提供されている場合、`outputChannel` をオーバーライドします。
`void`	`setSendTimeout(long sendTimeout)` 送信操作に使用するデフォルトのタイムアウト値を構成します。
`void`	`setShouldTrack(boolean shouldTrack)`
`protected void`	`subscribeToPublisher(org.reactivestreams.Publisher<? extends Message<?>> publisher)`

クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたメソッド
destroy, 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, getComponentType, 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.context.NamedComponent から継承されたメソッド
getBeanName, getComponentName, getComponentType

- コンストラクターの詳細
  - 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 - ミリ秒単位の送信タイムアウト
    関連事項:
    GenericMessagingTemplate.setSendTimeout(long)
  - setShouldTrack
```
public void setShouldTrack(boolean shouldTrack)
```
    次で指定:
    インターフェース TrackableComponent の setShouldTrack
  - setErrorMessageStrategy
```
public final void setErrorMessageStrategy(ErrorMessageStrategy errorMessageStrategy)
```
    例外が発生したときにエラーメッセージを作成するために使用する ErrorMessageStrategy を設定します。デフォルトは DefaultErrorMessageStrategy です。
    パラメーター:
    errorMessageStrategy - ErrorMessageStrategy
    導入:
    4.3.10
  - getMessagingTemplate
```
protected MessagingTemplate getMessagingTemplate()
```
  - 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<?> messageArg)
```
  - 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

クラス MessageProducerSupport

フィールドのサマリー

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

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

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

コンストラクターの概要

メソッドのサマリー

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

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

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

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

コンストラクターの詳細

MessageProducerSupport

メソッドの詳細

setOutputChannel

setOutputChannelName

getOutputChannel

setErrorChannel

setErrorChannelName

getErrorChannel

setSendTimeout

setShouldTrack

setErrorMessageStrategy

getMessagingTemplate

getIntegrationPatternType

afterSingletonsInstantiated

onInit

doStart

doStop

sendMessage

subscribeToPublisher

sendErrorMessageIfNecessary

buildErrorMessage

getErrorMessageAttributes