OperationInvokingMessageHandler (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.jmx.OperationInvokingMessageHandler

実装されたすべてのインターフェース:
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 OperationInvokingMessageHandler
extends AbstractReplyProducingMessageHandler
```
AbstractMessageHandler.handleMessage(Message) メソッドに送信されたメッセージに基づいて JMX 操作を呼び出すための MessageHandler 実装。MBean で呼び出される 'objectName' および 'operationName' を解決するときに、最初にメッセージヘッダーがチェックされます。これらの値は、それぞれ JmxHeaders.OBJECT_NAME および JmxHeaders.OPERATION_NAME として定義されたメッセージヘッダーで提供されます。いずれの場合も、ヘッダーが存在しない場合は、このインスタンスでそれぞれ setObjectName(String) および setOperationName(String) を介して構成されている場合は、値の解決はデフォルトにフォールバックします。
操作パラメーターがある場合は、処理するメッセージのペイロード内で使用できる必要があります。ターゲット操作が複数のパラメーターを予期している場合、リスト型またはマップ型のペイロードで提供できます。
導入:
2.0
作成者:
Mark Fisher, Oleg Zhurakousky, Gary Russell, 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

コンストラクターの概要

コンストラクター
コンストラクターと説明
`OperationInvokingMessageHandler(MBeanServerConnectionSE server)` 提供された `MBeanServerConnection`SE に基づいてインスタンスを構築します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`StringSE`	`getComponentType()` サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
`IntegrationPatternType`	`getIntegrationPatternType()` このコンポーネントが実装するパターン型を返します。
`protected ObjectSE`	`handleRequestMessage(Message<?> requestMessage)` サブクラスはこのメソッドを実装して、リクエストメッセージを処理する必要があります。
`void`	`setExpectReply(boolean expectReply)` 返信メッセージが必要かどうかを指定します。
`void`	`setObjectName(StringSE objectName)` 処理されるメッセージでそのようなヘッダーが使用できない場合に使用するデフォルトの ObjectName を指定します。
`void`	`setOperationName(StringSE operationName)` 処理中のメッセージに該当するヘッダーがない場合に呼び出される操作名を指定します。

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

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

- コンストラクターの詳細
  - OperationInvokingMessageHandler
```
public OperationInvokingMessageHandler(MBeanServerConnectionSE server)
```
    提供された MBeanServerConnectionSE に基づいてインスタンスを構築します。
    パラメーター:
    server - 使用する MBeanServerConnectionSE。
    導入:
    4.3.20
- メソッドの詳細
  - setObjectName
```
public void setObjectName(StringSE objectName)
```
    処理されるメッセージでそのようなヘッダーが使用できない場合に使用するデフォルトの ObjectName を指定します。
    パラメーター:
    objectName - オブジェクト名。
  - setOperationName
```
public void setOperationName(StringSE operationName)
```
    処理中のメッセージに該当するヘッダーがない場合に呼び出される操作名を指定します。
    パラメーター:
    operationName - 操作名。
  - setExpectReply
```
public void setExpectReply(boolean expectReply)
```
    返信メッセージが必要かどうかを指定します。そうでない場合、このハンドラーは、成功したレスポンスの場合は単に null を返すか、失敗したレスポンスの場合は例外をスローします。デフォルトは true です。
    パラメーター:
    expectReply - 応答が期待される場合は true。
    導入:
    4.3.20
  - getComponentType
```
public StringSE getComponentType()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
    次で指定:
    インターフェース NamedComponent の getComponentType
    オーバーライド:
    クラス MessageHandlerSupport の getComponentType
  - getIntegrationPatternType
```
public IntegrationPatternType getIntegrationPatternType()
```
    インターフェースからコピーされた説明: IntegrationPattern
    このコンポーネントが実装するパターン型を返します。
    次で指定:
    インターフェース IntegrationPattern の getIntegrationPatternType
    オーバーライド:
    クラス AbstractReplyProducingMessageHandler の getIntegrationPatternType
    戻り値:
    このコンポーネントが実装する IntegrationPatternType
  - handleRequestMessage
```
protected ObjectSE handleRequestMessage(Message<?> requestMessage)
```
    クラスからコピーされた説明: AbstractReplyProducingMessageHandler
    サブクラスはこのメソッドを実装して、リクエストメッセージを処理する必要があります。戻り値は、メッセージ、MessageBuilder、任意のプレーンオブジェクトです。基本クラスは、これらの開始点のいずれかからの返信メッセージの最終的な作成を処理します。戻り値が null の場合、メッセージフローはここで終了します。
    次で指定:
    クラス AbstractReplyProducingMessageHandler の handleRequestMessage
    パラメーター:
    requestMessage - リクエストメッセージ。
    戻り値:
    メッセージを処理した結果、または null

クラス OperationInvokingMessageHandler

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

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

コンストラクターの詳細

OperationInvokingMessageHandler

メソッドの詳細

setObjectName

setOperationName

setExpectReply

getComponentType

getIntegrationPatternType

handleRequestMessage