Class StepSynchronizationManager
java.lang.Object
org.springframework.batch.core.scope.context.StepSynchronizationManager
Central convenience class for framework use in managing the step scope context.
Generally only to be used by implementations of
Step
. N.B. it is the
responsibility of every Step
implementation to ensure that a
StepContext
is available on every thread that might be involved in a step
execution, including worker threads from a pool.- Author:
- Dave Syer, Michael Minella, Mahmoud Ben Hassine
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic void
close()
Method for unregistering the current context - should always and only be used by in conjunction with a matchingregister(StepExecution)
to ensure thatgetContext()
always returns the correct value.static StepContext
Getter for the current context if there is one, otherwise returnsnull
.static StepContext
register
(StepExecution stepExecution) Register a context with the current thread - always put a matchingclose()
call in a finally block to ensure that the correct context is available in the enclosing block.static void
release()
A convenient "deep" close operation.
-
Constructor Details
-
StepSynchronizationManager
public StepSynchronizationManager()
-
-
Method Details
-
getContext
Getter for the current context if there is one, otherwise returnsnull
.- Returns:
- the current
StepContext
ornull
if there is none (if one has not been registered for this thread).
-
register
Register a context with the current thread - always put a matchingclose()
call in a finally block to ensure that the correct context is available in the enclosing block.- Parameters:
stepExecution
- the step context to register- Returns:
- a new
StepContext
or the current one if it has the sameStepExecution
-
close
public static void close()Method for unregistering the current context - should always and only be used by in conjunction with a matchingregister(StepExecution)
to ensure thatgetContext()
always returns the correct value. Does not callStepContext.close()
- that is left up to the caller because he has a reference to the context (having registered it) and only he has knowledge of when the step actually ended. -
release
public static void release()A convenient "deep" close operation. Call this instead ofclose()
if the step execution for the current context is ending. Delegates toStepContext.close()
and then ensures thatclose()
is also called in a finally block.
-