C# 클래스 Summer.Batch.Core.Scope.Context.StepContext

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.Infrastructure.Repeat.Context.SynchronizedAttributeAccessor

파일 보기 프로젝트 열기: SummerBatch/SummerBatch 1 사용 예제들

공개 메소드들

메소드	설명
Close ( ) : void	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.
Equals ( object other ) : bool	Equals override.
GetHashCode ( ) : int	Overrides the default behaviour to provide a hash code based only on the step execution.
GetId ( ) : string
GetJobExecutionContext ( ) : object>.IReadOnlyDictionary	Returns the job execution context.
GetJobName ( ) : string	Convenient accessor for current job name identifier.
GetJobParameters ( ) : JobParameter>.IReadOnlyDictionary	Returns the job parameters.
GetStepExecutionContext ( ) : object>.IReadOnlyDictionary	Returns the step execution context.
GetStepName ( ) : string	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).
RegisterDestructionCallback ( string name, System.Threading.Tasks.Task callback ) : void	Allow clients to register callbacks for clean up on close.
RemoveAttribute ( string name ) : object	Override base class behaviour to ensure destruction callbacks are unregistered as well as the default behaviour.
StepContext ( StepExecution stepExecution ) : System	Create a new instance of StepContext for this StepExecution.
ToString ( ) : string	ToString override.

비공개 메소드들

메소드	설명
UnregisterDestructionCallbacks ( string name ) : void	Unregisters destruction callback.

메소드 상세

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.

public Close ( ) : void
리턴	void

Equals() 공개 메소드

Equals override.

public Equals ( object other ) : bool
other	object
리턴	bool

GetHashCode() 공개 메소드

Overrides the default behaviour to provide a hash code based only on the step execution.

public GetHashCode ( ) : int
리턴	int

GetId() 공개 메소드

public GetId ( ) : string
리턴	string

GetJobExecutionContext() 공개 메소드

Returns the job execution context.

public GetJobExecutionContext ( ) : object>.IReadOnlyDictionary
리턴	object>.IReadOnlyDictionary

GetJobName() 공개 메소드

Convenient accessor for current job name identifier.

public GetJobName ( ) : string
리턴	string

GetJobParameters() 공개 메소드

Returns the job parameters.

public GetJobParameters ( ) : JobParameter>.IReadOnlyDictionary
리턴	JobParameter>.IReadOnlyDictionary

GetStepExecutionContext() 공개 메소드

Returns the step execution context.

public GetStepExecutionContext ( ) : object>.IReadOnlyDictionary
리턴	object>.IReadOnlyDictionary

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).

public GetStepName ( ) : string
리턴	string

RegisterDestructionCallback() 공개 메소드

Allow clients to register callbacks for clean up on close.

public RegisterDestructionCallback ( string name, System.Threading.Tasks.Task callback ) : void
name	string	the callback id (unique attribute key in this context)
callback	System.Threading.Tasks.Task	a callback to execute on close
리턴	void

RemoveAttribute() 공개 메소드

Override base class behaviour to ensure destruction callbacks are unregistered as well as the default behaviour.

public RemoveAttribute ( string name ) : object
name	string
리턴	object

StepContext() 공개 메소드

Create a new instance of StepContext for this StepExecution.

public StepContext ( StepExecution stepExecution ) : System
stepExecution	StepExecution
리턴	System

ToString() 공개 메소드

ToString override.

public ToString ( ) : string
리턴	string