Summer.Batch.Core.Step.AbstractStep Class Referenceabstract

An IStepimplementation that provides common behavior to subclasses, including registering and calling listeners. More...

Inheritance diagram for Summer.Batch.Core.Step.AbstractStep:
Summer.Batch.Core.IStep Summer.Batch.Common.Factory.IInitializationPostOperations Summer.Batch.Core.Job.Flow.FlowStep Summer.Batch.Core.Partition.Support.PartitionStep Summer.Batch.Core.Step.Job.JobStep Summer.Batch.Core.Step.Tasklet.TaskletStep

Public Member Functions

virtual void AfterPropertiesSet ()
 used programmatically by JobStepBuilder ... IInitializationPostOperations::AfterPropertiesSet. More...
 
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

 AbstractStep (string name)
 Custom constructor with name. More...
 
 AbstractStep ()
 Default constructor. More...
 
abstract void DoExecute (StepExecution stepExecution)
 Extension point for subclasses to execute business logic. Subclasses should set the ExitStatus on the StepExecution before returning. 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

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 IStepimplementation that provides common behavior to subclasses, including registering and calling listeners.

Constructor & Destructor Documentation

Summer.Batch.Core.Step.AbstractStep.AbstractStep ( string  name)
protected

Custom constructor with name.

Parameters
name
Summer.Batch.Core.Step.AbstractStep.AbstractStep ( )
protected

Default constructor.

Member Function Documentation

virtual void Summer.Batch.Core.Step.AbstractStep.AfterPropertiesSet ( )
virtual

used programmatically by JobStepBuilder ... IInitializationPostOperations::AfterPropertiesSet.

Exceptions
Exception 

Implements Summer.Batch.Common.Factory.IInitializationPostOperations.

Reimplemented in Summer.Batch.Core.Partition.Support.PartitionStep, Summer.Batch.Core.Step.Job.JobStep, and Summer.Batch.Core.Job.Flow.FlowStep.

virtual void Summer.Batch.Core.Step.AbstractStep.Close ( ExecutionContext  ctx)
protectedvirtual

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.

Parameters
ctx
Exceptions
Exception 

Reimplemented in Summer.Batch.Core.Step.Tasklet.TaskletStep.

abstract void Summer.Batch.Core.Step.AbstractStep.DoExecute ( StepExecution  stepExecution)
protectedpure virtual

Extension point for subclasses to execute business logic. Subclasses should set the ExitStatus on the StepExecution before returning.

Parameters
stepExecution
Exceptions
Exception 

Implemented in Summer.Batch.Core.Step.Tasklet.TaskletStep, Summer.Batch.Core.Partition.Support.PartitionStep, Summer.Batch.Core.Step.Job.JobStep, and Summer.Batch.Core.Job.Flow.FlowStep.

void Summer.Batch.Core.Step.AbstractStep.DoExecutionRegistration ( StepExecution  stepExecution)
protected

Registers the StepExecution for property resolution via StepScope

Parameters
stepExecution
void Summer.Batch.Core.Step.AbstractStep.DoExecutionRelease ( )
protected

Releases the most recent StepExecution

void Summer.Batch.Core.Step.AbstractStep.Execute ( StepExecution  stepExecution)

Template method for step execution logic - calls abstract methods for resource initialization ( Open), execution Logic (DoExecute) and resource closing (Close).

Parameters
stepExecution
Exceptions
JobInterruptedException 
UnexpectedJobExecutionException 

Implements Summer.Batch.Core.IStep.

virtual void Summer.Batch.Core.Step.AbstractStep.Open ( ExecutionContext  ctx)
protectedvirtual

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.

Parameters
ctx
Exceptions
Exception 

Reimplemented in Summer.Batch.Core.Step.Tasklet.TaskletStep.

void Summer.Batch.Core.Step.AbstractStep.RegisterStepExecutionListener ( IStepExecutionListener  listener)

Registers step execution listener.

Parameters
listener
void Summer.Batch.Core.Step.AbstractStep.SetStepExecutionListeners ( IStepExecutionListener[]  listeners)

Registers an array of step execution listeners.

Parameters
listeners
override string Summer.Batch.Core.Step.AbstractStep.ToString ( )

ToString override.

Returns

Property Documentation

bool Summer.Batch.Core.Step.AbstractStep.AllowStartIfComplete
getset

Allow start if complete flag property.

IJobRepository Summer.Batch.Core.Step.AbstractStep.JobRepository
getset

Job repository property.

string Summer.Batch.Core.Step.AbstractStep.Name
getset

Name property.

int Summer.Batch.Core.Step.AbstractStep.StartLimit
getset

Start limit for this step.


The documentation for this class was generated from the following file:
  • Summer.Batch.Core/Core/Step/AbstractStep.cs