クラス StepParserStepFactoryBean<I,O>
java.lang.ObjectSE
org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean<I,O>
- 実装されたすべてのインターフェース:
org.springframework.beans.factory.Aware
、org.springframework.beans.factory.BeanNameAware
、org.springframework.beans.factory.FactoryBean<Step>
public class StepParserStepFactoryBean<I,O>
extends ObjectSE
implements org.springframework.beans.factory.FactoryBean<Step>, org.springframework.beans.factory.BeanNameAware
この
FactoryBean
は、Step
オブジェクトを作成するためにバッチ名前空間パーサーによって使用されます。<step/> (およびその内部の <tasklet/>) で構成可能なすべてのプロパティを格納します。どのプロパティが構成されているかに基づいて、getObject()
メソッドは Step
を生成するための適切なクラスに委譲します。- 導入:
- 2.0
- 作成者:
- Dan Garrette, Josh Long, Michael Minella, Chris Schaefer, Mahmoud Ben Hassine
- 関連事項:
フィールドサマリー
インターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド
OBJECT_TYPE_ATTRIBUTE
コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明protected Step
フォールトトレラントStep
を作成します。protected Step
新しいFlowStep
を作成します。protected Step
パーティションStep
を作成します。protected Step
新しいTaskletStep
を作成します。protected TaskletStep
新しいTaskletStep
を作成します。protected void
enhanceCommonStep
(StepBuilderHelper<?> builder) 提供されたStepBuilderHelper
からの属性でステップを拡張します。protected void
enhanceTaskletStepBuilder
(AbstractTaskletStepBuilder<?> builder) 提供時の Bean で確立された値を使用して、AbstractTaskletStepBuilder
の状態を設定します。protected IntegerSE
protected CompletionPolicy
protected FaultTolerantStepBuilder<I,
O> getFaultTolerantStepBuilder
(StringSE stepName) 新しいFaultTolerantStepBuilder
を作成します。getName()
提供された構成からStep
を作成します。protected PartitionHandler
protected SimpleStepBuilder<I,
O> getSimpleStepBuilder
(StringSE stepName) protected StepExecutionAggregator
protected Tasklet
org.springframework.transaction.PlatformTransactionManager
protected boolean
protected boolean
protected boolean
protected boolean
ステップにフォールトトレランスを必要とするコンポーネントがあるかどうかを示します。boolean
protected void
registerItemListeners
(SimpleStepBuilder<I, O> builder) boolean
現在、TaskletStep
以外のすべてのステップ実装はAbstractStep
のインスタンスであり、トランザクションマネージャーは必要ありません。void
setAllowStartIfComplete
(boolean allowStartIfComplete) 初めて成功した場合でも、再起動時にステップを再生する必要があることを示すフラグのパブリック setter。void
setBackOffPolicy
(org.springframework.retry.backoff.BackOffPolicy backOffPolicy) 再試行プロセスに適用されるバックオフポリシー。void
setBeanName
(StringSE name) Bean name プロパティを設定します。これは、作成時にStep
の名前になります。void
setCacheCapacity
(int cacheCapacity) 再試行ポリシーのキャッシュ容量用のパブリック setter。protected void
setChunk
(SimpleStepBuilder<I, O> builder) void
setChunkCompletionPolicy
(CompletionPolicy chunkCompletionPolicy) チャンクレベルに適用されるCompletionPolicy
のパブリック setter。void
setCommitInterval
(int commitInterval) コミット間隔を設定します。void
void
setGridSize
(int gridSize) void
setHasChunkElement
(boolean hasChunkElement) void
setIsolation
(org.springframework.transaction.annotation.Isolation isolation) void
setIsReaderTransactionalQueue
(boolean isReaderTransactionalQueue) ロールバック後にアイテムが再表示されるように、リーダーがトランザクション対応(通常は JMS コンシューマー)であることを示すフラグ。void
setItemProcessor
(ItemProcessor<? super I, ? extends O> itemProcessor) void
setItemReader
(ItemReader<? extends I> itemReader) void
setItemWriter
(ItemWriter<? super O> itemWriter) void
void
setJobLauncher
(JobLauncher jobLauncher) void
setJobParametersExtractor
(JobParametersExtractor jobParametersExtractor) void
setJobRepository
(JobRepository jobRepository) JobRepository
のパブリック setter。void
setKeyGenerator
(KeyGenerator keyGenerator) 再試行でアイテムを以前に記録されたアイテムと比較するために使用できるキージェネレーター。void
setListeners
(ObjectSE[] listeners) Step
に注入するリスナー。void
void
setNoRollbackExceptionClasses
(CollectionSE<ClassSE<? extends ThrowableSE>> noRollbackExceptionClasses) 適切な場所で発生した場合にロールバックを引き起こさない例外クラス。void
setPartitioner
(Partitioner partitioner) void
setPartitionHandler
(PartitionHandler partitionHandler) void
setProcessorTransactional
(BooleanSE processorTransactional) プロセッサーがトランザクション対応であることを示すフラグ。その場合、すべてのトランザクションのすべてのアイテムに対して呼び出す必要があります。void
setPropagation
(org.springframework.transaction.annotation.Propagation propagation) void
setRetryableExceptionClasses
(MapSE<ClassSE<? extends ThrowableSE>, BooleanSE> retryableExceptionClasses) 発生時に項目を再試行する例外クラスのパブリック setter。void
setRetryContextCache
(org.springframework.retry.policy.RetryContextCache retryContextCache) void
setRetryLimit
(int retryLimit) 再試行制限のパブリック setter。void
setRetryListeners
(org.springframework.retry.RetryListener... retryListeners) RetryListener
インスタンスのパブリック setter。void
setRetryPolicy
(org.springframework.retry.RetryPolicy retryPolicy) 例外が発生したときに適用する再試行ポリシー。void
setSkipLimit
(int skipLimit) スキップポリシーを決定する制限のパブリック setter。void
setSkippableExceptionClasses
(MapSE<ClassSE<? extends ThrowableSE>, BooleanSE> exceptionClasses) 例外クラスのパブリック setter が発生すると、ジョブはクラッシュしませんが、トランザクションロールバックが発生します。void
setSkipPolicy
(SkipPolicy skipPolicy) スキップポリシーのパブリック setter。void
setStartLimit
(int startLimit) ステップの開始を許可する回数。void
void
setStepExecutionAggregator
(StepExecutionAggregator stepExecutionAggregator) void
setStreams
(ItemStream[] streams) Step
に注入するストリーム。void
setTaskExecutor
(org.springframework.core.task.TaskExecutor taskExecutor) TaskExecutor
の公開 setter。void
setTasklet
(Tasklet tasklet) 使用する構成済みTasklet
。void
setThrottleLimit
(IntegerSE throttleLimit) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。5.0 以降、6.0 で削除予定。void
setTransactionManager
(org.springframework.transaction.PlatformTransactionManager transactionManager) void
setTransactionTimeout
(int transactionTimeout) protected void
フォールトトレラントステップを構築するために必要なすべてのコンポーネントが設定されていることを検証します。
コンストラクターの詳細
StepParserStepFactoryBean
public StepParserStepFactoryBean()
メソッドの詳細
getObject
提供された構成からStep
を作成します。- 次で指定:
- インターフェース
org.springframework.beans.factory.FactoryBean<I>
のgetObject
- 例外:
ExceptionSE
- 関連事項:
FactoryBean.getObject()
requiresTransactionManager
public boolean requiresTransactionManager()現在、TaskletStep
以外のすべてのステップ実装はAbstractStep
のインスタンスであり、トランザクションマネージャーは必要ありません。enhanceCommonStep
提供されたStepBuilderHelper
からの属性でステップを拡張します。- パラメーター:
builder
- 強化するステップを表すStepBuilderHelper
createPartitionStep
パーティションStep
を作成します。- 戻り値:
Step
createFaultTolerantStep
フォールトトレラントStep
を作成します。- 戻り値:
Step
getFaultTolerantStepBuilder
新しいFaultTolerantStepBuilder
を作成します。- パラメーター:
stepName
- 作成されたビルダーによって使用されるステップの名前。- 戻り値:
FaultTolerantStepBuilder
registerItemListeners
createSimpleStep
新しいTaskletStep
を作成します。- 戻り値:
TaskletStep
setChunk
getCompletionPolicy
getSimpleStepBuilder
createTaskletStep
新しいTaskletStep
を作成します。- 戻り値:
- 新しい
TaskletStep
enhanceTaskletStepBuilder
提供時の Bean で確立された値を使用して、AbstractTaskletStepBuilder
の状態を設定します。- パラメーター:
builder
- 変更するAbstractTaskletStepBuilder
。
createFlowStep
新しいFlowStep
を作成します。- 戻り値:
FlowStep
validateFaultTolerantSettings
protected void validateFaultTolerantSettings()フォールトトレラントステップを構築するために必要なすべてのコンポーネントが設定されていることを検証します。isFaultTolerant
protected boolean isFaultTolerant()ステップにフォールトトレランスを必要とするコンポーネントがあるかどうかを示します。- 戻り値:
- ステップがフォールトトレランスを必要とするコンポーネントで構成されている場合は、
true
。
getObjectType
- 次で指定:
- インターフェース
org.springframework.beans.factory.FactoryBean<I>
のgetObjectType
isSingleton
public boolean isSingleton()- 次で指定:
- インターフェース
org.springframework.beans.factory.FactoryBean<I>
のisSingleton
setBeanName
Bean name プロパティを設定します。これは、作成時にStep
の名前になります。- 次で指定:
- インターフェース
org.springframework.beans.factory.BeanNameAware
のsetBeanName
- 関連事項:
BeanNameAware.setBeanName(java.lang.String)
setName
- パラメーター:
name
- 設定する名前
getName
setFlow
- パラメーター:
flow
- 設定する流れ
setJob
setJobParametersExtractor
setJobLauncher
setPartitioner
- パラメーター:
partitioner
- 設定するパーティショナー
setStepExecutionAggregator
- パラメーター:
stepExecutionAggregator
- 設定する stepExecutionAggregator
getStepExecutionAggergator
- 戻り値:
- 現在のステップの
StepExecutionAggregator
setPartitionHandler
- パラメーター:
partitionHandler
- 設定する partitionHandler
getPartitionHandler
- 戻り値:
- 現在のステップの
PartitionHandler
setGridSize
public void setGridSize(int gridSize) - パラメーター:
gridSize
- 設定する gridSize
setStep
- パラメーター:
step
- 設定するステップ
setAllowStartIfComplete
public void setAllowStartIfComplete(boolean allowStartIfComplete) 初めて成功した場合でも、再起動時にステップを再生する必要があることを示すフラグのパブリック setter。- パラメーター:
allowStartIfComplete
- 設定する shouldAllowStartIfComplete
getJobRepository
- 戻り値:
- jobRepository
setJobRepository
JobRepository
のパブリック setter。- パラメーター:
jobRepository
- ステップで使用されるJobRepository
インスタンス。
setStartLimit
public void setStartLimit(int startLimit) ステップの開始を許可する回数。- パラメーター:
startLimit
- ステップを開始できる回数を含む整数。
setTasklet
使用する構成済みTasklet
。- パラメーター:
tasklet
- ステップで使用されるTasklet
インスタンス。
getTasklet
getTransactionManager
public org.springframework.transaction.PlatformTransactionManager getTransactionManager()- 戻り値:
- ステップで使用される
PlatformTransactionManager
のインスタンス。
setTransactionManager
public void setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager) - パラメーター:
transactionManager
- 設定するトランザクションマネージャー
setListeners
Step
に注入するリスナー。StepListener
の任意のインスタンスを使用でき、ステップの適切な段階でコールバックを受け取ります。- パラメーター:
listeners
- リスナーの配列
setNoRollbackExceptionClasses
public void setNoRollbackExceptionClasses(CollectionSE<ClassSE<? extends ThrowableSE>> noRollbackExceptionClasses) 適切な場所で発生した場合にロールバックを引き起こさない例外クラス。- パラメーター:
noRollbackExceptionClasses
- 設定する noRollbackExceptionClasses
setTransactionTimeout
public void setTransactionTimeout(int transactionTimeout) - パラメーター:
transactionTimeout
- 設定する transactionTimeout
setIsolation
public void setIsolation(org.springframework.transaction.annotation.Isolation isolation) - パラメーター:
isolation
- 設定するアイソレーション
setPropagation
public void setPropagation(org.springframework.transaction.annotation.Propagation propagation) - パラメーター:
propagation
- 設定する伝搬
setBackOffPolicy
public void setBackOffPolicy(org.springframework.retry.backoff.BackOffPolicy backOffPolicy) 再試行プロセスに適用されるバックオフポリシー。- パラメーター:
backOffPolicy
- 設定するBackOffPolicy
setRetryPolicy
public void setRetryPolicy(org.springframework.retry.RetryPolicy retryPolicy) 例外が発生したときに適用する再試行ポリシー。これが指定されている場合、再試行制限と再試行可能な例外は無視されます。- パラメーター:
retryPolicy
- 設定するRetryPolicy
setRetryContextCache
public void setRetryContextCache(org.springframework.retry.policy.RetryContextCache retryContextCache) - パラメーター:
retryContextCache
- 設定するRetryContextCache
setKeyGenerator
再試行でアイテムを以前に記録されたアイテムと比較するために使用できるキージェネレーター。リーダーがトランザクションキューである場合にのみ使用されます。- パラメーター:
keyGenerator
- 設定するKeyGenerator
setCacheCapacity
public void setCacheCapacity(int cacheCapacity) 再試行ポリシーのキャッシュの容量のパブリック setter。指定された容量よりも多くのアイテムがある場合、ステップはスキップまたは回復されずに失敗し、例外がスローされます。これにより、アイテムの同一性の問題によって生成される不注意な無限ループを防ぐことができます。
デフォルト値は、ほとんどの目的に対して十分に高いはずです。シングルスレッドステップで制限に違反するには、通常、1 つのトランザクションでこれだけ多くの失敗が発生する必要があります。デフォルトはMapRetryContextCache
の値です。- パラメーター:
cacheCapacity
- 設定するキャッシュ容量 (0 より大きい場合は無視)
setChunkCompletionPolicy
チャンクレベルに適用されるCompletionPolicy
のパブリック setter。このポリシーが完了を決定すると、トランザクションがコミットされます。デフォルトは、commitInterval
プロパティと等しいチャンクサイズを持つSimpleCompletionPolicy
です。- パラメーター:
chunkCompletionPolicy
- 設定するchunkCompletionPolicy
。
setCommitInterval
public void setCommitInterval(int commitInterval) コミット間隔を設定します。これまたはchunkCompletionPolicy
のいずれかを設定しますが、両方を設定することはできません。- パラメーター:
commitInterval
- デフォルトで 1
getCommitInterval
- 戻り値:
- コミット間隔。
setIsReaderTransactionalQueue
public void setIsReaderTransactionalQueue(boolean isReaderTransactionalQueue) ロールバック後に項目が再提示されるように、リーダーがトランザクション対応 (通常は JMS コンシューマー) であることを示すフラグ。デフォルトはfalse
で、リーダーは転送専用であると見なされます。- パラメーター:
isReaderTransactionalQueue
- フラグの値
setProcessorTransactional
プロセッサーがトランザクション対応であることを示すフラグ。その場合、すべてのトランザクションのすべてのアイテムに対して呼び出す必要があります。false
の場合、ロールバックの場合にトランザクション間でプロセッサーの結果をキャッシュできます。- パラメーター:
processorTransactional
- 設定する値
setRetryLimit
public void setRetryLimit(int retryLimit) 再試行制限のパブリック setter。各項目は、この制限まで再試行できます。この制限には、アイテムを処理するための最初の試行が含まれることに注意してください。デフォルトではretryLimit == 1
.- パラメーター:
retryLimit
- 設定する再試行制限。1 以上である必要があります。
setSkipLimit
public void setSkipLimit(int skipLimit) スキップポリシーを決定する制限のパブリック setter。この値が正の場合、チャンク処理での例外により項目がスキップされ、制限に達するまで例外は伝播されません。ゼロの場合、すべての例外がチャンクから伝播され、ステップが中止されます。- パラメーター:
skipLimit
- 設定する値。デフォルトは 0 (スキップしない) です。
setSkipPolicy
スキップポリシーのパブリック setter。この値が設定されている場合、スキップ制限とスキップ可能な例外は無視されます。- パラメーター:
skipPolicy
- 設定するSkipPolicy
。
setTaskExecutor
public void setTaskExecutor(org.springframework.core.task.TaskExecutor taskExecutor) TaskExecutor
のパブリック setter。これが設定されている場合、Step
内でチャンク処理を実行するために使用されます。- パラメーター:
taskExecutor
- 設定する taskExecutor。
setThrottleLimit
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。5.0 以降、6.0 で削除予定。いずれにせよ、この API はエンドユーザーを対象としたものではありません。これは、XML 名前空間パーサーによってのみ使用されます。スロットル制限のパブリック setter。これにより、並行処理のためにキューに入れられるタスクの数が制限され、スレッドプールがオーバーロードになるのを防ぎます。デフォルトはTaskExecutorRepeatTemplate.DEFAULT_THROTTLE_LIMIT
です。- パラメーター:
throttleLimit
- 設定するスロットル制限。
setItemReader
- パラメーター:
itemReader
- 設定するItemReader
。
setItemProcessor
- パラメーター:
itemProcessor
- 設定するItemProcessor
。
setItemWriter
- パラメーター:
itemWriter
- 設定するItemWriter
。
setRetryListeners
public void setRetryListeners(org.springframework.retry.RetryListener... retryListeners) RetryListener
インスタンスのパブリック setter。- パラメーター:
retryListeners
- 設定するRetryListener
インスタンス。
setSkippableExceptionClasses
public void setSkippableExceptionClasses(MapSE<ClassSE<? extends ThrowableSE>, BooleanSE> exceptionClasses) 例外クラスのパブリック setter が発生すると、ジョブはクラッシュしませんが、トランザクションロールバックが発生します。処理が例外を引き起こした項目はスキップされます。- パラメーター:
exceptionClasses
-Throwable
SE インスタンスをキーとして、Boolean
SE インスタンスを値として含むMap
SE。true
の場合、項目はスキップされます。
setRetryableExceptionClasses
public void setRetryableExceptionClasses(MapSE<ClassSE<? extends ThrowableSE>, BooleanSE> retryableExceptionClasses) 発生時に項目を再試行する例外クラスのパブリック setter。- パラメーター:
retryableExceptionClasses
- 設定する retryableExceptionClasses。
setStreams
Step
に注入するストリーム。ItemStream
の任意のインスタンスを使用でき、ステップの適切な段階でコールバックを受け取ります。- パラメーター:
streams
- リスナーの配列
setHasChunkElement
public void setHasChunkElement(boolean hasChunkElement) - パラメーター:
hasChunkElement
- ステップに <chunk/> 要素がある場合はtrue
。
hasChunkElement
protected boolean hasChunkElement()- 戻り値:
- 定義されたステップに <chunk/> 要素がある場合は
true
。
hasTasklet
protected boolean hasTasklet()- 戻り値:
- 定義されたステップに <tasklet/> 要素がある場合は
true
。
hasPartitionElement
protected boolean hasPartitionElement()- 戻り値:
- 定義されたステップに <partition/> 要素がある場合は
true
。