AbstractMessageProducingHandler (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.handler.MessageHandlerSupport
  - - org.springframework.integration.handler.AbstractMessageHandler
    - - org.springframework.integration.handler.AbstractMessageProducingHandler

実装済みのインターフェース一覧:
org.reactivestreams.Subscriber<Message<?>>, Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ExpressionCapable, Orderable, MessageProducer, HeaderPropagationAware, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>
既知の直属サブクラス
AbstractCorrelatingMessageHandler, AbstractReplyProducingMessageHandler, FluxAggregatorMessageHandler, MessageHandlerChain, MockMessageHandler
```
public abstract class AbstractMessageProducingHandler
extends AbstractMessageHandler
implements MessageProducer, HeaderPropagationAware
```
MessageProducer の基本 AbstractMessageHandler 実装。
作成者:
David Liu, Artem Bilan, Gary Russell, Marius Bogoevici since 4.1

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

フィールド概要
フィールド
修飾子と型フィールドと説明
protected MessagingTemplate messagingTemplate
- クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド
  EXPRESSION_PARSER, logger
- インターフェース org.springframework.core.Ordered から継承されたフィールド
  HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド
  METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

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

コンストラクター概要
コンストラクター
コンストラクターと説明
AbstractMessageProducingHandler()

コンストラクター
コンストラクターと説明
`AbstractMessageProducingHandler()`

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`addNotPropagatedHeaders(StringSE... headers)` 既存のセットを上書きする代わりに、`shouldCopyRequestHeaders()` が true の場合に受信メッセージからコピーされないヘッダーパターン（"xxx"、"xxx"、"xxx" または "xxx* yyy"）を追加します。
`protected Message<?>`	`createOutputMessage(ObjectSE output, MessageHeaders requestHeaders)`
`CollectionSE<StringSE>`	`getNotPropagatedHeaders()` このハンドラーが伝播しないヘッダーパターンを取得します。
`MessageChannel`	`getOutputChannel()` 出力チャネルを返します。
`protected boolean`	`isAsync()`
`protected AbstractIntegrationMessageBuilder<?>`	`messageBuilderForReply(ObjectSE reply)`
`protected void`	`onInit()` サブクラスは、初期化ロジック用にこれを実装できます。
`protected void`	`produceOutput(ObjectSE replyArg, Message<?> requestMessage)`
`protected ObjectSE`	`resolveErrorChannel(MessageHeaders requestHeaders)`
`protected void`	`sendErrorMessage(Message<?> requestMessage, ThrowableSE ex)`
`protected void`	`sendOutput(ObjectSE output, ObjectSE replyChannelArg, boolean useArgChannel)` 出力メッセージを送信します。
`protected void`	`sendOutputs(ObjectSE result, Message<?> requestMessage)`
`void`	`setAsync(boolean async)` 非同期返信を許可します。
`void`	`setNotPropagatedHeaders(StringSE... headers)` `shouldCopyRequestHeaaders` が true の場合に受信メッセージからコピーされないヘッダーパターン（"xxx"、"xxx"、"xxx" または "xxx* yyy"）を設定します。
`void`	`setOutputChannel(MessageChannel outputChannel)` 生成されたメッセージの送信先となる `MessageChannel` を指定します。
`void`	`setOutputChannelName(StringSE outputChannelName)` 生成されたメッセージの送信先となる `MessageChannel` の Bean 名を指定します。
`void`	`setSendTimeout(long sendTimeout)` 返信メッセージ送信のタイムアウトを設定します。
`protected boolean`	`shouldCopyRequestHeaders()` サブクラスはこれをオーバーライドできます。
`protected boolean`	`shouldSplitOutput(IterableSE<?> reply)`
`protected void`	`updateNotPropagatedHeaders(StringSE[] headers, boolean merge)` 伝播されていないヘッダーを設定または置換します。

クラス org.springframework.integration.handler.AbstractMessageHandler から継承されたメソッド
handleMessage, handleMessageInternal, onComplete, onError, onNext, onSubscribe

クラス org.springframework.integration.handler.MessageHandlerSupport から継承されたメソッド
buildSendTimer, destroy, getComponentType, getIntegrationPatternType, getManagedName, getManagedType, getMetricsCaptor, getOrder, getOverrides, isLoggingEnabled, registerMetricsCaptor, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack

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

インターフェース reactor.core.CoreSubscriber から継承されたメソッド
currentContext

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

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

- フィールドの詳細
  - messagingTemplate
```
protected final MessagingTemplate messagingTemplate
```
- コンストラクターの詳細
  - AbstractMessageProducingHandler
```
public AbstractMessageProducingHandler()
```
- メソッドの詳細
  - setSendTimeout
```
public void setSendTimeout(long sendTimeout)
```
    返信メッセージ送信のタイムアウトを設定します。
    パラメーター:
    sendTimeout - 送信タイムアウト。
  - setOutputChannel
```
public void setOutputChannel(MessageChannel outputChannel)
```
    インターフェースからコピーされた説明: MessageProducer
    生成されたメッセージの送信先となる MessageChannel を指定します。
    次で指定:
    インターフェース MessageProducer の setOutputChannel
    パラメーター:
    outputChannel - 出力チャネル。
  - setOutputChannelName
```
public void setOutputChannelName(StringSE outputChannelName)
```
    インターフェースからコピーされた説明: MessageProducer
    生成されたメッセージの送信先となる MessageChannel の Bean 名を指定します。
    次で指定:
    インターフェース MessageProducer の setOutputChannelName
    パラメーター:
    outputChannelName - 出力チャネル Bean 名。
  - setAsync
```
public final void setAsync(boolean async)
```
    非同期返信を許可します。ハンドラー応答が ListenableFuture である場合、結果としてフューチャーを送信するのではなく、それが満たされたときに出力を送信します。ListenableFuture 以外の戻り値の型では無視されます。
    パラメーター:
    async - 許可する場合は true。
    導入:
    4.3
  - isAsync
```
protected boolean isAsync()
```
    戻り値:
    このハンドラーが非同期応答をサポートしている場合は true。
    導入:
    4.3
    関連事項:
    setAsync(boolean)
  - setNotPropagatedHeaders
```
public void setNotPropagatedHeaders(StringSE... headers)
```
    shouldCopyRequestHeaaders が true の場合に受信メッセージからコピーされないヘッダーパターン（"xxx*"、"*xxx"、"*xxx*" または "xxx* yyy"）を設定します。"*" として少なくとも 1 つのパターンは、ヘッダーをまったくコピーしないことを意味します。
    次で指定:
    インターフェース HeaderPropagationAware の setNotPropagatedHeaders
    パラメーター:
    headers - 受信メッセージから伝播しないヘッダー。
    導入:
    4.3.10
    関連事項:
    PatternMatchUtils
  - updateNotPropagatedHeaders
```
protected final void updateNotPropagatedHeaders(StringSE[] headers,
                                                boolean merge)
```
    伝播されていないヘッダーを設定または置換します。setNotPropagatedHeaders(String...) は final ではないため、サブクラスがコンストラクターで特定のヘッダーを設定できるように公開されます。
    パラメーター:
    headers - 伝播しないヘッダーパターン。
    merge - 既存のパターンとマージする場合は true。置き換える場合は false。
    導入:
    5.0.2
  - getNotPropagatedHeaders
```
public CollectionSE<StringSE> getNotPropagatedHeaders()
```
    このハンドラーが伝播しないヘッダーパターンを取得します。
    次で指定:
    インターフェース HeaderPropagationAware の getNotPropagatedHeaders
    戻り値:
    shouldCopyRequestHeaders() が true の場合に受信メッセージからコピーされないヘッダーの不変の CollectionSE。
    導入:
    4.3.10
    関連事項:
    setNotPropagatedHeaders(String...), PatternMatchUtils
  - addNotPropagatedHeaders
```
public void addNotPropagatedHeaders(StringSE... headers)
```
    既存のセットを上書きする代わりに、shouldCopyRequestHeaders() が true の場合に受信メッセージからコピーされないヘッダーパターン（"xxx*"、"*xxx"、"*xxx*" または "xxx* yyy"）を追加します。
    次で指定:
    インターフェース HeaderPropagationAware の addNotPropagatedHeaders
    パラメーター:
    headers - 受信メッセージから伝播しないヘッダー。
    導入:
    4.3.10
    関連事項:
    setNotPropagatedHeaders(String...)
  - onInit
```
protected void onInit()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスは、初期化ロジック用にこれを実装できます。
    オーバーライド:
    クラス IntegrationObjectSupport の onInit
  - getOutputChannel
```
@Nullable
public MessageChannel getOutputChannel()
```
    インターフェースからコピーされた説明: MessageProducer
    出力チャネルを返します。
    次で指定:
    インターフェース MessageProducer の getOutputChannel
    戻り値:
    チャンネル。
  - sendOutputs
```
protected void sendOutputs(ObjectSE result,
                           Message<?> requestMessage)
```
  - shouldSplitOutput
```
protected boolean shouldSplitOutput(IterableSE<?> reply)
```
  - produceOutput
```
protected void produceOutput(ObjectSE replyArg,
                             Message<?> requestMessage)
```
  - messageBuilderForReply
```
protected AbstractIntegrationMessageBuilder<?> messageBuilderForReply(ObjectSE reply)
```
  - createOutputMessage
```
protected Message<?> createOutputMessage(ObjectSE output,
                                         MessageHeaders requestHeaders)
```
  - sendOutput
```
protected void sendOutput(ObjectSE output,
                          @Nullable
                          ObjectSE replyChannelArg,
                          boolean useArgChannel)
```
    出力メッセージを送信します。このハンドラーの 'outputChannel' が null である場合にのみ 'replyChannel' が考慮されます。その場合、'replyChannel' の値は null であってはならず、String または MessageChannel のいずれかのインスタンスである必要があります。
    パラメーター:
    output - 送信する出力オブジェクト
    replyChannelArg - 元のリクエストの "replyChannel" 値
    useArgChannel - - 構成された出力チャネルではなく、replyChannel 引数 (null であってはなりません) を使用します。
  - shouldCopyRequestHeaders
```
protected boolean shouldCopyRequestHeaders()
```
    サブクラスはこれをオーバーライドできます。デフォルトでは true。
    戻り値:
    リクエストヘッダーをコピーする必要がある場合は true。
  - sendErrorMessage
```
protected void sendErrorMessage(Message<?> requestMessage,
                                ThrowableSE ex)
```
  - resolveErrorChannel
```
protected ObjectSE resolveErrorChannel(MessageHeaders requestHeaders)
```

クラス AbstractMessageProducingHandler

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

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

フィールド概要

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

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

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

コンストラクター概要

方法の概要

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

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

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

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

インターフェース reactor.core.CoreSubscriber から継承されたメソッド

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

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

フィールドの詳細

messagingTemplate

コンストラクターの詳細

AbstractMessageProducingHandler

メソッドの詳細

setSendTimeout

setOutputChannel

setOutputChannelName

setAsync

isAsync

setNotPropagatedHeaders

updateNotPropagatedHeaders

getNotPropagatedHeaders

addNotPropagatedHeaders

onInit

getOutputChannel

sendOutputs

shouldSplitOutput

produceOutput

messageBuilderForReply

createOutputMessage

sendOutput

shouldCopyRequestHeaders

sendErrorMessage

resolveErrorChannel