AbstractPollingEndpoint (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.endpoint.AbstractEndpoint
  - - org.springframework.integration.endpoint.AbstractPollingEndpoint

実装されたすべてのインターフェース:
Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, NamedComponent, ManageableLifecycle, ManageableSmartLifecycle
既知の直属サブクラス
PollingConsumer, SourcePollingChannelAdapter
```
public abstract class AbstractPollingEndpoint
extends AbstractEndpoint
implements BeanClassLoaderAware
```
作成者:
Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan, Andreas Baer

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

フィールド
修飾子と型	フィールドと説明
`static long`	`DEFAULT_POLLING_PERIOD` `PeriodicTrigger` のデフォルトのポーリング期間。

コンストラクターの概要
コンストラクター
コンストラクターと説明
AbstractPollingEndpoint()

コンストラクター
コンストラクターと説明
`AbstractPollingEndpoint()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`protected void`	`applyReceiveOnlyAdviceChain(CollectionSE<Advice> chain)` `receiveMessage()` 呼び出しに応答するコンポーネントにアドバイスチェーンを追加します。
`protected void`	`doStart()` サブクラスは、開始動作でこのメソッドを実装する必要があります。
`protected void`	`doStop()` サブクラスは、停止動作でこのメソッドを実装する必要があります。
`protected ClassLoaderSE`	`getBeanClassLoader()`
`MessageChannel`	`getDefaultErrorChannel()` エラーハンドラーが明示的に提供され、それが `MessagePublishingErrorHandler` である場合、デフォルトのエラーチャネルを返します。
`protected reactor.core.publisher.Flux<Message<?>>`	`getPollingFlux()`
`protected ObjectSE`	`getReceiveMessageSource()`
`protected StringSE`	`getResourceKey()` リソースが `IntegrationResourceHolder` の属性として使用可能になるキーを返します。
`protected ObjectSE`	`getResourceToBind()` トランザクション同期を使用するときにバインドするリソース（MessageSource など）を返します。
`protected ExecutorSE`	`getTaskExecutor()`
`protected abstract void`	`handleMessage(Message<?> message)` メッセージを処理します。
`protected boolean`	`isReactive()`
`protected boolean`	`isReceiveOnlyAdvice(Advice advice)` このアドバイスをポーリング全体ではなく `receiveMessage()` 操作にのみ適用する必要がある場合は、true を返します。
`protected boolean`	`isSyncExecutor()`
`protected void`	`onInit()` サブクラスは、初期化ロジック用にこれを実装できます。
`protected abstract Message<?>`	`receiveMessage()` 次のメッセージを取得します（利用可能な場合）。
`void`	`setAdviceChain(ListSE<Advice> adviceChain)`
`void`	`setBeanClassLoader(ClassLoaderSE classLoader)`
`void`	`setErrorHandler(ErrorHandler errorHandler)`
`void`	`setMaxMessagesPerPoll(long maxMessagesPerPoll)`
`protected void`	`setReceiveMessageSource(ObjectSE source)`
`void`	`setTaskExecutor(ExecutorSE taskExecutor)`
`void`	`setTransactionSynchronizationFactory(TransactionSynchronizationFactory transactionSynchronizationFactory)`
`void`	`setTrigger(Trigger trigger)`

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

- フィールドの詳細
  - DEFAULT_POLLING_PERIOD
```
public static final long DEFAULT_POLLING_PERIOD
```
    PeriodicTrigger のデフォルトのポーリング期間。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - AbstractPollingEndpoint
```
public AbstractPollingEndpoint()
```
- メソッドの詳細
  - setTaskExecutor
```
public void setTaskExecutor(ExecutorSE taskExecutor)
```
  - getTaskExecutor
```
protected ExecutorSE getTaskExecutor()
```
  - isSyncExecutor
```
protected boolean isSyncExecutor()
```
  - setTrigger
```
public void setTrigger(Trigger trigger)
```
  - setAdviceChain
```
public void setAdviceChain(ListSE<Advice> adviceChain)
```
  - setMaxMessagesPerPoll
```
public void setMaxMessagesPerPoll(long maxMessagesPerPoll)
```
  - setErrorHandler
```
public void setErrorHandler(ErrorHandler errorHandler)
```
  - setBeanClassLoader
```
public void setBeanClassLoader(ClassLoaderSE classLoader)
```
    次で指定:
    インターフェース BeanClassLoaderAware の setBeanClassLoader
  - setTransactionSynchronizationFactory
```
public void setTransactionSynchronizationFactory(TransactionSynchronizationFactory transactionSynchronizationFactory)
```
  - getDefaultErrorChannel
```
public MessageChannel getDefaultErrorChannel()
```
    エラーハンドラーが明示的に提供され、それが MessagePublishingErrorHandler である場合、デフォルトのエラーチャネルを返します。
    戻り値:
    チャネルまたは null。
    導入:
    4.3
  - getBeanClassLoader
```
protected ClassLoaderSE getBeanClassLoader()
```
  - isReceiveOnlyAdvice
```
protected boolean isReceiveOnlyAdvice(Advice advice)
```
    このアドバイスをポーリング全体ではなく receiveMessage() 操作にのみ適用する必要がある場合は、true を返します。
    パラメーター:
    advice - 助言。
    戻り値:
    受信操作のみをアドバイスする場合は true。
  - applyReceiveOnlyAdviceChain
```
protected void applyReceiveOnlyAdviceChain(CollectionSE<Advice> chain)
```
    receiveMessage() 呼び出しに応答するコンポーネントにアドバイスチェーンを追加します。
    パラメーター:
    chain - アドバイスチェーン Collection。
  - isReactive
```
protected boolean isReactive()
```
  - getPollingFlux
```
protected reactor.core.publisher.Flux<Message<?>> getPollingFlux()
```
  - getReceiveMessageSource
```
protected ObjectSE getReceiveMessageSource()
```
  - setReceiveMessageSource
```
protected void setReceiveMessageSource(ObjectSE source)
```
  - onInit
```
protected void onInit()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスは、初期化ロジック用にこれを実装できます。
    オーバーライド:
    クラス AbstractEndpoint の onInit
  - doStart
```
protected void doStart()
```
    クラスからコピーされた説明: AbstractEndpoint
    サブクラスは、開始動作でこのメソッドを実装する必要があります。このメソッドは、AbstractEndpoint.lifecycleLock を保持しているときに呼び出されます。
    次で指定:
    クラス AbstractEndpoint の doStart
  - doStop
```
protected void doStop()
```
    クラスからコピーされた説明: AbstractEndpoint
    サブクラスは、停止動作でこのメソッドを実装する必要があります。このメソッドは、AbstractEndpoint.lifecycleLock を保持しているときに呼び出されます。
    次で指定:
    クラス AbstractEndpoint の doStop
  - receiveMessage
```
protected abstract Message<?> receiveMessage()
```
    次のメッセージを取得します（利用可能な場合）。すぐに利用できるメッセージがない場合は、null を返す場合があります。
    戻り値:
    メッセージまたは null。
  - handleMessage
```
protected abstract void handleMessage(Message<?> message)
```
    メッセージを処理します。
    パラメーター:
    message - メッセージ。
  - getResourceToBind
```
protected ObjectSE getResourceToBind()
```
    トランザクション同期を使用するときにバインドするリソース（MessageSource など）を返します。
    戻り値:
    リソース。トランザクションの同期が不要な場合は null。
  - getResourceKey
```
protected StringSE getResourceKey()
```
    リソースが IntegrationResourceHolder の属性として使用可能になるキーを返します。デフォルトの ExpressionEvaluatingTransactionSynchronizationProcessor は、この属性を SpEL 式の変数として使用できるようにします。
    戻り値:
    キー、またはリソースを属性として使用可能にしない場合は null（デフォルト）。

クラス AbstractPollingEndpoint

フィールドのサマリー

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

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

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

コンストラクターの概要

メソッドのサマリー

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

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

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

フィールドの詳細

DEFAULT_POLLING_PERIOD

コンストラクターの詳細

AbstractPollingEndpoint

メソッドの詳細

setTaskExecutor

getTaskExecutor

isSyncExecutor

setTrigger

setAdviceChain

setMaxMessagesPerPoll

setErrorHandler

setBeanClassLoader

setTransactionSynchronizationFactory

getDefaultErrorChannel

getBeanClassLoader

isReceiveOnlyAdvice

applyReceiveOnlyAdviceChain

isReactive

getPollingFlux

getReceiveMessageSource

setReceiveMessageSource

onInit

doStart

doStop

receiveMessage

handleMessage

getResourceToBind

getResourceKey