A context object that can be used to interrogate the current StepExecution and some of its associated properties using expressions based on bean paths. Has public getters for the step execution and convenience methods for accessing commonly used properties like the ExecutionContext associated with the step or its enclosing job execution.
More...
A context object that can be used to interrogate the current StepExecution and some of its associated properties using expressions based on bean paths. Has public getters for the step execution and convenience methods for accessing commonly used properties like the ExecutionContext associated with the step or its enclosing job execution.
Summer.Batch.Core.Scope.Context.StepContext.StepContext |
( |
StepExecution |
stepExecution | ) |
|
void Summer.Batch.Core.Scope.Context.StepContext.Close |
( |
| ) |
|
Clean up the context at the end of a step execution. Must be called once at the end of a step execution to honour the destruction callback contract from the Step Scope.
override bool Summer.Batch.Core.Scope.Context.StepContext.Equals |
( |
object |
other | ) |
|
Equals override.
- Parameters
-
- Returns
override int Summer.Batch.Core.Scope.Context.StepContext.GetHashCode |
( |
| ) |
|
Overrides the default behaviour to provide a hash code based only on the step execution.
- Returns
string Summer.Batch.Core.Scope.Context.StepContext.GetId |
( |
| ) |
|
- Returns
- an unique identifier for this context based on the step execution
IReadOnlyDictionary<string, object> Summer.Batch.Core.Scope.Context.StepContext.GetJobExecutionContext |
( |
| ) |
|
Returns the job execution context.
- Returns
string Summer.Batch.Core.Scope.Context.StepContext.GetJobName |
( |
| ) |
|
Convenient accessor for current job name identifier.
- Returns
IReadOnlyDictionary<string, JobParameter> Summer.Batch.Core.Scope.Context.StepContext.GetJobParameters |
( |
| ) |
|
Returns the job parameters.
- Returns
IReadOnlyDictionary<string, object> Summer.Batch.Core.Scope.Context.StepContext.GetStepExecutionContext |
( |
| ) |
|
Returns the step execution context.
- Returns
string Summer.Batch.Core.Scope.Context.StepContext.GetStepName |
( |
| ) |
|
Convenient accessor for current step name identifier. Usually this is the same as the bean name of the step that is executing (but might not be e.g. in a partition).
- Returns
void Summer.Batch.Core.Scope.Context.StepContext.RegisterDestructionCallback |
( |
string |
name, |
|
|
Task |
callback |
|
) |
| |
Allow clients to register callbacks for clean up on close.
- Parameters
-
name | the callback id (unique attribute key in this context) |
callback | a callback to execute on close |
override object Summer.Batch.Core.Scope.Context.StepContext.RemoveAttribute |
( |
string |
name | ) |
|
|
virtual |
override string Summer.Batch.Core.Scope.Context.StepContext.ToString |
( |
| ) |
|
ToString override.
- Returns
StepExecution Summer.Batch.Core.Scope.Context.StepContext.StepExecution |
|
get |
The documentation for this class was generated from the following file:
- Summer.Batch.Core/Core/Scope/Context/StepContext.cs