JmsMessageDrivenEndpoint (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.endpoint.AbstractEndpoint
  - - org.springframework.integration.endpoint.MessageProducerSupport
    - - org.springframework.integration.jms.JmsMessageDrivenEndpoint

実装されたすべてのインターフェース:
Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, SmartInitializingSingleton, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, OrderlyShutdownCapable, MessageProducer, IntegrationPattern, NamedComponent, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent
```
public class JmsMessageDrivenEndpoint
extends MessageProducerSupport
implements OrderlyShutdownCapable
```
JMS メッセージを受信し、Spring Integration メッセージに変換して、結果をチャネルに送信するメッセージ駆動型エンドポイント。
作成者:
Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan

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

コンストラクターの概要

コンストラクター
コンストラクターと説明
`JmsMessageDrivenEndpoint(AbstractMessageListenerContainer listenerContainer, ChannelPublishingJmsMessageListener listener)` 外部で構成されたコンテナーを使用してインスタンスを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`int`	`afterShutdown()` スケジューラー、エグゼキューターなどの通常のシャットダウンの後、シャットダウン遅延が経過した後、残りのアクティブなスケジューラー / エグゼキュータースレッドの強制シャットダウンの前に呼び出されます。オプションで、まだ処理中のアクティブなメッセージの数を返すことができます。
`void`	`afterSingletonsInstantiated()`
`int`	`beforeShutdown()` シャットダウンが始まる前に呼び出されます。
`void`	`destroy()`
`protected void`	`doStart()` デフォルトでは何もしません。
`protected void`	`doStop()` デフォルトでは何もしません。
`StringSE`	`getComponentType()` サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
`ChannelPublishingJmsMessageListener`	`getListener()`
`protected void`	`onInit()` サブクラスは、初期化ロジック用にこれを実装できます。
`void`	`setApplicationContext(ApplicationContext applicationContext)`
`void`	`setErrorChannel(MessageChannel errorChannel)`
`void`	`setErrorChannelName(StringSE errorChannelName)` エラーチャネル名を設定します。
`void`	`setOutputChannel(MessageChannel outputChannel)` 生成されたメッセージの送信先となる `MessageChannel` を指定します。
`void`	`setOutputChannelName(StringSE outputChannelName)` 出力チャネル名を設定します。提供されている場合、`outputChannel` をオーバーライドします。
`void`	`setSendTimeout(long sendTimeout)` 送信操作に使用するデフォルトのタイムアウト値を構成します。
`void`	`setSessionAcknowledgeMode(StringSE sessionAcknowledgeMode)` リスナーコンテナーにセッション確認応答モードを設定します。
`void`	`setShouldTrack(boolean shouldTrack)`
`void`	`setShutdownContainerOnStop(boolean shutdownContainerOnStop)` エンドポイントが停止したときにリスナーコンテナーがシャットダウンしないようにするには、false に設定します。

クラス org.springframework.integration.endpoint.MessageProducerSupport から継承されたメソッド
buildErrorMessage, getErrorChannel, getErrorMessageAttributes, getIntegrationPatternType, getMessagingTemplate, getOutputChannel, sendErrorMessageIfNecessary, sendMessage, setErrorMessageStrategy, subscribeToPublisher

クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたメソッド
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, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, 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

- コンストラクターの詳細
  - JmsMessageDrivenEndpoint
```
public JmsMessageDrivenEndpoint(AbstractMessageListenerContainer listenerContainer,
                                ChannelPublishingJmsMessageListener listener)
```
    外部で構成されたコンテナーを使用してインスタンスを作成します。
    パラメーター:
    listenerContainer - コンテナー。
    listener - リスナー。
- メソッドの詳細
  - setSessionAcknowledgeMode
```
public void setSessionAcknowledgeMode(StringSE sessionAcknowledgeMode)
```
    リスナーコンテナーでセッション確認モードを設定します。外部コンテナーが提供されている場合でも、コンテナー設定を上書きします。外部コンテナーが提供されている場合はデフォルトで null（コンテナーを変更しない）、またはフレームワークが暗黙の DefaultMessageListenerContainer を作成する場合は `transacted`。
    パラメーター:
    sessionAcknowledgeMode - 確認モード。
  - setOutputChannel
```
public void setOutputChannel(MessageChannel outputChannel)
```
    インターフェースからコピーされた説明: MessageProducer
    生成されたメッセージの送信先となる MessageChannel を指定します。
    次で指定:
    インターフェース MessageProducer の setOutputChannel
    オーバーライド:
    クラス MessageProducerSupport の setOutputChannel
    パラメーター:
    outputChannel - 出力チャネル。
  - setOutputChannelName
```
public void setOutputChannelName(StringSE outputChannelName)
```
    クラスからコピーされた説明: MessageProducerSupport
    出力チャネル名を設定します。提供されている場合、outputChannel をオーバーライドします。
    次で指定:
    インターフェース MessageProducer の setOutputChannelName
    オーバーライド:
    クラス MessageProducerSupport の setOutputChannelName
    パラメーター:
    outputChannelName - チャンネル名。
  - setErrorChannel
```
public void setErrorChannel(MessageChannel errorChannel)
```
    オーバーライド:
    クラス MessageProducerSupport の setErrorChannel
  - setErrorChannelName
```
public void setErrorChannelName(StringSE errorChannelName)
```
    クラスからコピーされた説明: MessageProducerSupport
    エラーチャネル名を設定します。エラーチャネルが指定されていない場合、このエンドポイントは例外をメッセージ駆動型ソースに伝播します。例外を完全に抑制するには、ここで "nullChannel" への参照を指定します。
    オーバーライド:
    クラス MessageProducerSupport の setErrorChannelName
    パラメーター:
    errorChannelName - エラーチャネル Bean 名。
  - setSendTimeout
```
public void setSendTimeout(long sendTimeout)
```
    クラスからコピーされた説明: MessageProducerSupport
    送信操作に使用するデフォルトのタイムアウト値を構成します。個々のメッセージに対してオーバーライドされる場合があります。
    オーバーライド:
    クラス MessageProducerSupport の setSendTimeout
    パラメーター:
    sendTimeout - ミリ秒単位の送信タイムアウト
    関連事項:
    GenericMessagingTemplate.setSendTimeout(long)
  - setShouldTrack
```
public void setShouldTrack(boolean shouldTrack)
```
    次で指定:
    インターフェース TrackableComponent の setShouldTrack
    オーバーライド:
    クラス MessageProducerSupport の setShouldTrack
  - setShutdownContainerOnStop
```
public void setShutdownContainerOnStop(boolean shutdownContainerOnStop)
```
    エンドポイントが停止したときにリスナーコンテナーがシャットダウンしないようにするには、false に設定します。次に、そのように構成されている場合、コンテナー内のキャッシュされたコンシューマーは残ります。それ以外の場合、共有接続は閉じられ、リスナー呼び出し元はシャットダウンします。この動作は、バージョン 5.1 から新しく追加されました。デフォルト: true。
    パラメーター:
    shutdownContainerOnStop - シャットダウンしない場合は false。
    導入:
    5.1
  - getListener
```
public ChannelPublishingJmsMessageListener getListener()
```
  - setApplicationContext
```
public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException
```
    次で指定:
    インターフェース ApplicationContextAware の setApplicationContext
    オーバーライド:
    クラス IntegrationObjectSupport の setApplicationContext
    例外:
    BeansException
  - getComponentType
```
public StringSE getComponentType()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
    次で指定:
    インターフェース NamedComponent の getComponentType
    オーバーライド:
    クラス IntegrationObjectSupport の getComponentType
  - afterSingletonsInstantiated
```
public void afterSingletonsInstantiated()
```
    次で指定:
    インターフェース SmartInitializingSingleton の afterSingletonsInstantiated
    オーバーライド:
    クラス MessageProducerSupport の afterSingletonsInstantiated
  - onInit
```
protected void onInit()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスは、初期化ロジック用にこれを実装できます。
    オーバーライド:
    クラス MessageProducerSupport の onInit
  - doStart
```
protected void doStart()
```
    クラスからコピーされた説明: MessageProducerSupport
    デフォルトでは何も実行されません。ライフサイクル管理された動作が必要な場合、サブクラスはこれをオーバーライドできます。'lifecycleLock' によって保護されています。
    オーバーライド:
    クラス MessageProducerSupport の doStart
  - doStop
```
protected void doStop()
```
    クラスからコピーされた説明: MessageProducerSupport
    デフォルトでは何もしません。サブクラスは、ライフサイクル管理の動作が必要な場合、これをオーバーライドできます。
    オーバーライド:
    クラス MessageProducerSupport の doStop
  - destroy
```
public void destroy()
```
    次で指定:
    インターフェース DisposableBean の destroy
    オーバーライド:
    クラス AbstractEndpoint の destroy
  - beforeShutdown
```
public int beforeShutdown()
```
    インターフェースからコピーされた説明: OrderlyShutdownCapable
    シャットダウンが始まる前に呼び出されます。実装は、新しいメッセージの受け入れを停止する必要があります。オプションで、処理中のアクティブなメッセージの数を返すことができます。
    次で指定:
    インターフェース OrderlyShutdownCapable の beforeShutdown
    戻り値:
    使用可能な場合、アクティブなメッセージの数。
  - afterShutdown
```
public int afterShutdown()
```
    インターフェースからコピーされた説明: OrderlyShutdownCapable
    スケジューラー、エグゼキューターなどの通常のシャットダウンの後、シャットダウン遅延が経過した後、残りのアクティブなスケジューラー / エグゼキュータースレッドの強制シャットダウンの前に呼び出されます。オプションで、まだ処理中のアクティブなメッセージの数を返すことができます。
    次で指定:
    インターフェース OrderlyShutdownCapable の afterShutdown
    戻り値:
    使用可能な場合、アクティブなメッセージの数。

クラス JmsMessageDrivenEndpoint

フィールドのサマリー

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

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

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

コンストラクターの概要

メソッドのサマリー

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

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

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

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

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

コンストラクターの詳細

JmsMessageDrivenEndpoint

メソッドの詳細

setSessionAcknowledgeMode

setOutputChannel

setOutputChannelName

setErrorChannel

setErrorChannelName

setSendTimeout

setShouldTrack

setShutdownContainerOnStop

getListener

setApplicationContext

getComponentType

afterSingletonsInstantiated

onInit

doStart

doStop

destroy

beforeShutdown

afterShutdown