An IStep that delegates to a Job to do its work. This is a great tool for managing dependencies between jobs, and also to modularise complex step logic into something that is testable in isolation. The job is executed with parameters that can be extracted from the step execution, hence this step can also be usefully used as the worker in a parallel or partitioned execution. More...
Public Member Functions | |
override void | AfterPropertiesSet () |
Invoked programmatically by JobStepBuilder. More... | |
JobStep (string name) | |
Custom constructor using a name More... | |
Public Member Functions inherited from Summer.Batch.Core.Step.AbstractStep | |
void | Execute (StepExecution stepExecution) |
Template method for step execution logic - calls abstract methods for resource initialization ( Open), execution Logic (DoExecute) and resource closing (Close). More... | |
void | RegisterStepExecutionListener (IStepExecutionListener listener) |
Registers step execution listener. More... | |
void | SetStepExecutionListeners (IStepExecutionListener[] listeners) |
Registers an array of step execution listeners. More... | |
override string | ToString () |
ToString override. More... | |
Protected Member Functions | |
override void | DoExecute (StepExecution stepExecution) |
Execute the job provided by delegating to the IJobLauncherto prevent duplicate executions. The job parameters will be generated by the IJobParametersExtractorprovided (if any), otherwise empty. On a restart, the job parameters will be the same as the last (failed) execution. More... | |
Protected Member Functions inherited from Summer.Batch.Core.Step.AbstractStep | |
AbstractStep (string name) | |
Custom constructor with name. More... | |
AbstractStep () | |
Default constructor. More... | |
virtual void | Open (ExecutionContext ctx) |
Extension point for subclasses to provide callbacks to their collaborators at the beginning of a step, to open or acquire resources. Does nothing by default. More... | |
virtual void | Close (ExecutionContext ctx) |
Extension point for subclasses to provide callbacks to their collaborators at the end of a step, to close or release resources. Does nothing by default. More... | |
void | DoExecutionRelease () |
Releases the most recent StepExecution More... | |
void | DoExecutionRegistration (StepExecution stepExecution) |
Registers the StepExecution for property resolution via StepScope More... | |
Properties | |
IJob | Job [set] |
Job property. More... | |
IJobLauncher | JobLauncher [set] |
Job launcher property. More... | |
IJobParametersExtractor | JobParametersExtractor [set] |
The IJobParametersExtractoris used to extract JobParametersExtractor from the StepExecutionto run the IJob. By default an instance will be provided that simply copies JobParameters from the parent job. More... | |
Properties inherited from Summer.Batch.Core.Step.AbstractStep | |
string | Name [get, set] |
Name property. More... | |
bool | AllowStartIfComplete [get, set] |
Allow start if complete flag property. More... | |
int | StartLimit [get, set] |
Start limit for this step. More... | |
IJobRepository | JobRepository [get, set] |
Job repository property. More... | |
Properties inherited from Summer.Batch.Core.IStep | |
string | Name [get] |
Name. More... | |
bool | AllowStartIfComplete [get, set] |
Allow start if complete flag. More... | |
int | StartLimit [get, set] |
Start limit. More... | |
Detailed Description
An IStep that delegates to a Job to do its work. This is a great tool for managing dependencies between jobs, and also to modularise complex step logic into something that is testable in isolation. The job is executed with parameters that can be extracted from the step execution, hence this step can also be usefully used as the worker in a parallel or partitioned execution.
Constructor & Destructor Documentation
Summer.Batch.Core.Step.Job.JobStep.JobStep | ( | string | name | ) |
Custom constructor using a name
- Parameters
-
name
Member Function Documentation
|
virtual |
Invoked programmatically by JobStepBuilder.
- See also
- IInitializationPostOperations::AfterPropertiesSet.
- Exceptions
-
Exception
Reimplemented from Summer.Batch.Core.Step.AbstractStep.
|
protectedvirtual |
Execute the job provided by delegating to the IJobLauncherto prevent duplicate executions. The job parameters will be generated by the IJobParametersExtractorprovided (if any), otherwise empty. On a restart, the job parameters will be the same as the last (failed) execution.
- Parameters
-
stepExecution
Implements Summer.Batch.Core.Step.AbstractStep.
Property Documentation
|
set |
Job launcher property.
|
set |
The IJobParametersExtractoris used to extract JobParametersExtractor from the StepExecutionto run the IJob. By default an instance will be provided that simply copies JobParameters from the parent job.
The documentation for this class was generated from the following file:
- Summer.Batch.Core/Core/Step/Job/JobStep.cs