RedisQueueMessageDrivenEndpoint (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.endpoint.AbstractEndpoint
  - - org.springframework.integration.endpoint.MessageProducerSupport
    - - org.springframework.integration.redis.inbound.RedisQueueMessageDrivenEndpoint

実装されているすべてのインターフェース:
Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, SmartInitializingSingleton, ApplicationContextAware, ApplicationEventPublisherAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, MessageProducer, IntegrationPattern, NamedComponent, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent
```
@ManagedResource
 @IntegrationManagedResource
public class RedisQueueMessageDrivenEndpoint
extends MessageProducerSupport
implements ApplicationEventPublisherAware, BeanClassLoaderAware
```
導入:
3.0
作成者:
Mark Fisher, Gunnar Hillert, Artem Bilan, Gary Russell, Rainer Frey, Matthias Jeschke

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
static long DEFAULT_RECEIVE_TIMEOUT
static long DEFAULT_RECOVERY_INTERVAL
- クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたフィールド
  lifecycleCondition, lifecycleLock
- クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド
  EXPRESSION_PARSER, logger
- インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
  DEFAULT_PHASE

フィールド
修飾子と型	フィールドと説明
`static long`	`DEFAULT_RECEIVE_TIMEOUT`
`static long`	`DEFAULT_RECOVERY_INTERVAL`

コンストラクターの概要
コンストラクター
コンストラクターと説明
RedisQueueMessageDrivenEndpoint(StringSE queueName, RedisConnectionFactory connectionFactory)

コンストラクター
コンストラクターと説明
`RedisQueueMessageDrivenEndpoint(StringSE queueName, RedisConnectionFactory connectionFactory)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`clearQueue()` `boundListOperations` で指定された Redis キューをクリアします。
`protected void`	`doStart()` デフォルトでは何もしません。
`protected void`	`doStop()` デフォルトでは何もしません。
`protected void`	`doStop(RunnableSE callback)` コンポーネントを停止し、コールバックを呼び出します。
`StringSE`	`getComponentType()` サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
`long`	`getQueueSize()` `boundListOperations` で指定されたキューのサイズを返します。
`boolean`	`isListening()`
`protected void`	`onInit()` サブクラスは、初期化ロジック用にこれを実装できます。
`void`	`setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)`
`void`	`setBeanClassLoader(ClassLoaderSE beanClassLoader)`
`void`	`setExpectMessage(boolean expectMessage)` データが Redis キューから取得されるとき、返されるデータはメッセージのペイロードのみを表しますか、それともデータは直列化された `Message` を表しますか？
`void`	`setReceiveTimeout(long receiveTimeout)` このタイムアウト（ミリ秒）は、`boundListOperations` で指定されたキューから要素を取得するときに使用されます。
`void`	`setRecoveryInterval(long recoveryInterval)`
`void`	`setRightPop(boolean rightPop)` Redis リストからの `POP` 操作を `BRPOP` または `BLPOP` にするかどうかを指定します。
`void`	`setSerializer(RedisSerializer<?> serializer)`
`void`	`setTaskExecutor(ExecutorSE taskExecutor)`

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

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

- フィールドの詳細
  - DEFAULT_RECEIVE_TIMEOUT
```
public static final long DEFAULT_RECEIVE_TIMEOUT
```
    関連事項:
    定数フィールド値
  - DEFAULT_RECOVERY_INTERVAL
```
public static final long DEFAULT_RECOVERY_INTERVAL
```
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - RedisQueueMessageDrivenEndpoint
```
public RedisQueueMessageDrivenEndpoint(StringSE queueName,
                                       RedisConnectionFactory connectionFactory)
```
    パラメーター:
    queueName - 空の文字列であってはなりません
    connectionFactory - null であってはなりません
- メソッドの詳細
  - setApplicationEventPublisher
```
public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
```
    次で指定:
    インターフェース ApplicationEventPublisherAware の setApplicationEventPublisher
  - setBeanClassLoader
```
public void setBeanClassLoader(ClassLoaderSE beanClassLoader)
```
    次で指定:
    インターフェース BeanClassLoaderAware の setBeanClassLoader
  - setSerializer
```
public void setSerializer(RedisSerializer<?> serializer)
```
  - setExpectMessage
```
public void setExpectMessage(boolean expectMessage)
```
    データが Redis キューから取得されるとき、返されるデータはメッセージのペイロードのみを表しますか、それともデータは直列化された Message を表しますか？ expectMessage のデフォルトは false です。これは、取得したデータが新しい Spring Integration メッセージのペイロードとして使用されることを意味します。それ以外の場合、データは Spring Integration メッセージとして逆直列化されます。
    パラメーター:
    expectMessage - デフォルトは false です
  - setReceiveTimeout
```
public void setReceiveTimeout(long receiveTimeout)
```
    このタイムアウト（ミリ秒）は、boundListOperations で指定されたキューから要素を取得するときに使用されます。
    キューに要素が含まれている場合、データはすぐに取得されます。ただし、キューが空の場合、要素をキューから取得できるか、指定されたタイムアウトが経過するまで、Redis 接続はブロックされます。
    ゼロのタイムアウトは、無期限にブロックするために使用できます。明示的に設定されていない場合、タイムアウト値はデフォルトで 1000 になります
    関連事項: https://redis.io/commands/brpop
    パラメーター:
    receiveTimeout - 負でない必要があります。ミリ秒で指定されます。
  - setTaskExecutor
```
public void setTaskExecutor(ExecutorSE taskExecutor)
```
  - setRecoveryInterval
```
public void setRecoveryInterval(long recoveryInterval)
```
  - setRightPop
```
public void setRightPop(boolean rightPop)
```
    Redis リストからの POP 操作を BRPOP または BLPOP にするかどうかを指定します。
    パラメーター:
    rightPop - BRPOP フラグ。デフォルトは true です。
    導入:
    4.3
  - onInit
```
protected void onInit()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスは、初期化ロジック用にこれを実装できます。
    オーバーライド:
    クラス MessageProducerSupport の onInit
  - getComponentType
```
public StringSE getComponentType()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
    次で指定:
    インターフェース NamedComponent の getComponentType
    オーバーライド:
    クラス IntegrationObjectSupport の getComponentType
  - doStart
```
protected void doStart()
```
    クラスからコピーされた説明: MessageProducerSupport
    デフォルトでは何も実行されません。ライフサイクル管理された動作が必要な場合、サブクラスはこれをオーバーライドできます。'lifecycleLock' によって保護されています。
    オーバーライド:
    クラス MessageProducerSupport の doStart
  - doStop
```
protected void doStop(RunnableSE callback)
```
    クラスからコピーされた説明: AbstractEndpoint
    コンポーネントを停止し、コールバックを呼び出します。
    オーバーライド:
    クラス AbstractEndpoint の doStop
    パラメーター:
    callback - 起動する Runnable。
  - doStop
```
protected void doStop()
```
    クラスからコピーされた説明: MessageProducerSupport
    デフォルトでは何もしません。サブクラスは、ライフサイクル管理の動作が必要な場合、これをオーバーライドできます。
    オーバーライド:
    クラス MessageProducerSupport の doStop
  - isListening
```
public boolean isListening()
```
  - getQueueSize
```
@ManagedMetric
public long getQueueSize()
```
    boundListOperations で指定されたキューのサイズを返します。キューは Redis リストで表されます。キューが存在しない場合、0 が返されます。https://redis.io/commands/llen も参照してください
    戻り値:
    キューのサイズ。決して否定的ではありません。
  - clearQueue
```
@ManagedOperation
public void clearQueue()
```
    boundListOperations で指定された Redis キューをクリアします。

クラス RedisQueueMessageDrivenEndpoint

フィールドのサマリー

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

フィールドの詳細

DEFAULT_RECEIVE_TIMEOUT

DEFAULT_RECOVERY_INTERVAL

コンストラクターの詳細

RedisQueueMessageDrivenEndpoint

メソッドの詳細

setApplicationEventPublisher

setBeanClassLoader

setSerializer

setExpectMessage

setReceiveTimeout

setTaskExecutor

setRecoveryInterval

setRightPop

onInit

getComponentType

doStart

doStop

doStop

isListening

getQueueSize

clearQueue