StoredProcOutboundGateway (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.springframework.integration.handler.AbstractReplyProducingMessageHandler
        
        org.springframework.integration.jdbc.StoredProcOutboundGateway

実装されたすべてのインターフェース:
org.reactivestreams.Subscriber<Message<?>>, Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ExpressionCapable, Orderable, MessageProducer, HeaderPropagationAware, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>
```
public class StoredProcOutboundGateway
extends AbstractReplyProducingMessageHandler
```
結果を返す RDBMS ストアドプロシージャを実行するための AbstractReplyProducingMessageHandler 実装。
導入:
2.1
作成者:
Gunnar Hillert, Artem Bilan

ネストされたクラスのサマリー
- クラス org.springframework.integration.handler.AbstractReplyProducingMessageHandler から継承されたネストクラス / インターフェース
  AbstractReplyProducingMessageHandler.RequestHandler
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース
  IntegrationManagement.ManagementOverrides

フィールドのサマリー
- クラス org.springframework.integration.handler.AbstractMessageProducingHandler から継承されたフィールド
  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

コンストラクターの概要
コンストラクター
コンストラクターと説明
StoredProcOutboundGateway(StoredProcExecutor storedProcExecutor)
StoredProcExecutor をとるコンストラクター。

コンストラクター
コンストラクターと説明
`StoredProcOutboundGateway(StoredProcExecutor storedProcExecutor)` `StoredProcExecutor` をとるコンストラクター。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected void`	`doInit()`
`StringSE`	`getComponentType()` サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
`protected ObjectSE`	`handleRequestMessage(Message<?> requestMessage)` サブクラスはこのメソッドを実装して、リクエストメッセージを処理する必要があります。
`void`	`setExpectSingleResult(boolean expectSingleResult)` このパラメーターは、ストアードプロシージャー / 関数呼び出しから 1 つの結果オブジェクトのみが返されることを示します。
`void`	`setRequiresReply(boolean requiresReply)` 返信が必要かどうかのフラグ。

クラス org.springframework.integration.handler.AbstractReplyProducingMessageHandler から継承されたメソッド
doInvokeAdvisedRequestHandler, getBeanClassLoader, getIntegrationPatternType, getRequiresReply, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader

クラス org.springframework.integration.handler.AbstractMessageProducingHandler から継承されたメソッド
addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, produceOutput, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, shouldCopyRequestHeaders, shouldSplitOutput, updateNotPropagatedHeaders

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

クラス org.springframework.integration.handler.MessageHandlerSupport から継承されたメソッド
buildSendTimer, destroy, 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

- コンストラクターの詳細
  - StoredProcOutboundGateway
```
public StoredProcOutboundGateway(StoredProcExecutor storedProcExecutor)
```
    StoredProcExecutor をとるコンストラクター。
    パラメーター:
    storedProcExecutor - null であってはなりません。
- メソッドの詳細
  - setRequiresReply
```
public void setRequiresReply(boolean requiresReply)
```
    クラスからコピーされた説明: AbstractReplyProducingMessageHandler
    返信が必要かどうかのフラグ。true の場合、受信メッセージは応答メッセージの送信につながる必要があります。false の場合、受信メッセージにより、返信メッセージが送信される場合があります。デフォルトは false です。
    オーバーライド:
    クラス AbstractReplyProducingMessageHandler の setRequiresReply
    パラメーター:
    requiresReply - 返信が必要な場合は true。
  - setExpectSingleResult
```
public void setExpectSingleResult(boolean expectSingleResult)
```
    このパラメーターは、ストアードプロシージャー / 関数呼び出しから 1 つの結果オブジェクトのみが返されることを示します。true に設定すると、1 つの要素のみを含む resultMap は、その 1 つの要素を抽出し、ペイロードとして返します。
    resultMap に複数の要素と expectSingleResult == true が含まれている場合、MessagingException がスローされます。
    それ以外の場合は、完全な resultMap が Message ペイロードとして返されます。
    重要な注意点: H2 などのいくつかのデータベースは完全にはサポートされていません。たとえば、H2 データベースは CallableStatementSE セマンティクスを完全にはサポートしておらず、H2 に対して関数呼び出しを実行すると、単一の値ではなく結果リストが返されます。
    expectSingleResult = true を設定しても、コレクションが返される場合があります。
    true に設定すると、setRequiresReply(boolean) も true で呼び出されます。これは、正確に単一の結果が期待され、null が適切な値ではないことを示します。null の結果の場合、ReplyRequiredException がスローされます。
    パラメーター:
    expectSingleResult - 単一の結果が期待される場合は true。
  - getComponentType
```
public StringSE getComponentType()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
    次で指定:
    インターフェース NamedComponent の getComponentType
    オーバーライド:
    クラス MessageHandlerSupport の getComponentType
  - doInit
```
protected void doInit()
```
    オーバーライド:
    クラス AbstractReplyProducingMessageHandler の doInit
  - handleRequestMessage
```
protected ObjectSE handleRequestMessage(Message<?> requestMessage)
```
    クラスからコピーされた説明: AbstractReplyProducingMessageHandler
    サブクラスはこのメソッドを実装して、リクエストメッセージを処理する必要があります。戻り値は、メッセージ、MessageBuilder、任意のプレーンオブジェクトです。基本クラスは、これらの開始点のいずれかからの返信メッセージの最終的な作成を処理します。戻り値が null の場合、メッセージフローはここで終了します。
    次で指定:
    クラス AbstractReplyProducingMessageHandler の handleRequestMessage
    パラメーター:
    requestMessage - リクエストメッセージ。
    戻り値:
    メッセージを処理した結果、または null

クラス StoredProcOutboundGateway

ネストされたクラスのサマリー

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

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

フィールドのサマリー

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

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

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

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

コンストラクターの概要

メソッドのサマリー

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

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

クラス 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 から継承されたメソッド

コンストラクターの詳細

StoredProcOutboundGateway

メソッドの詳細

setRequiresReply

setExpectSingleResult

getComponentType

doInit

handleRequestMessage