RedisQueueInboundGateway (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.endpoint.AbstractEndpoint
  - - org.springframework.integration.gateway.MessagingGatewaySupport
    - - org.springframework.integration.redis.inbound.RedisQueueInboundGateway

実装されたすべてのインターフェース:
Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, ApplicationEventPublisherAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, IntegrationPattern, NamedComponent, IntegrationInboundManagement, IntegrationManagement, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent
```
@ManagedResource
 @IntegrationManagedResource
public class RedisQueueInboundGateway
extends MessagingGatewaySupport
implements ApplicationEventPublisherAware, BeanClassLoaderAware
```
導入:
4.1
作成者:
David Liu, Artem Bilan, Gary Russell, Matthias Jeschke

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

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

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

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

コンストラクター
コンストラクターと説明
`RedisQueueInboundGateway(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`	`setExtractPayload(boolean extractPayload)`
`void`	`setReceiveTimeout(long receiveTimeout)` このタイムアウト（ミリ秒）は、`boundListOperations` で指定されたキューから要素を取得するときに使用されます。
`void`	`setRecoveryInterval(long recoveryInterval)`
`void`	`setSerializer(RedisSerializer<?> serializer)`
`void`	`setTaskExecutor(ExecutorSE taskExecutor)`

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

インターフェース 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
```
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - RedisQueueInboundGateway
```
public RedisQueueInboundGateway(StringSE queueName,
                                RedisConnectionFactory connectionFactory)
```
    パラメーター:
    queueName - 空の文字列であってはなりません
    connectionFactory - null であってはなりません
- メソッドの詳細
  - setExtractPayload
```
public void setExtractPayload(boolean extractPayload)
```
  - setApplicationEventPublisher
```
public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
```
    次で指定:
    インターフェース ApplicationEventPublisherAware の setApplicationEventPublisher
  - setBeanClassLoader
```
public void setBeanClassLoader(ClassLoaderSE beanClassLoader)
```
    次で指定:
    インターフェース BeanClassLoaderAware の setBeanClassLoader
  - setSerializer
```
public void setSerializer(RedisSerializer<?> serializer)
```
  - 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)
```
  - onInit
```
protected void onInit()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスは、初期化ロジック用にこれを実装できます。
    オーバーライド:
    クラス MessagingGatewaySupport の onInit
  - getComponentType
```
public StringSE getComponentType()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
    次で指定:
    インターフェース NamedComponent の getComponentType
    オーバーライド:
    クラス MessagingGatewaySupport の getComponentType
  - doStart
```
protected void doStart()
```
    クラスからコピーされた説明: AbstractEndpoint
    サブクラスは、開始動作でこのメソッドを実装する必要があります。このメソッドは、AbstractEndpoint.lifecycleLock を保持しているときに呼び出されます。
    オーバーライド:
    クラス MessagingGatewaySupport の doStart
  - doStop
```
protected void doStop(RunnableSE callback)
```
    クラスからコピーされた説明: AbstractEndpoint
    コンポーネントを停止し、コールバックを呼び出します。
    オーバーライド:
    クラス AbstractEndpoint の doStop
    パラメーター:
    callback - 起動する Runnable。
  - doStop
```
protected void doStop()
```
    クラスからコピーされた説明: AbstractEndpoint
    サブクラスは、停止動作でこのメソッドを実装する必要があります。このメソッドは、AbstractEndpoint.lifecycleLock を保持しているときに呼び出されます。
    オーバーライド:
    クラス MessagingGatewaySupport の 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 キューをクリアします。

クラス RedisQueueInboundGateway

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

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

フィールドのサマリー

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

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

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

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

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

コンストラクターの概要

メソッドのサマリー

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

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

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

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

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

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

フィールドの詳細

DEFAULT_RECEIVE_TIMEOUT

DEFAULT_RECOVERY_INTERVAL

コンストラクターの詳細

RedisQueueInboundGateway

メソッドの詳細

setExtractPayload

setApplicationEventPublisher

setBeanClassLoader

setSerializer

setReceiveTimeout

setTaskExecutor

setRecoveryInterval

onInit

getComponentType

doStart

doStop

doStop

isListening

getQueueSize

clearQueue