Package org.springframework.batch.integration.async

Class StepExecutionInterceptor

  • All Implemented Interfaces:
    org.springframework.messaging.support.ChannelInterceptor
    public class StepExecutionInterceptor
extends org.springframework.messaging.support.ChannelInterceptorAdapter
    A ChannelInterceptor that adds the current StepExecution (if there is one) as a header to the message. Downstream asynchronous handlers can then take advantage of the step context without needing to be step scoped, which is a problem for handlers executing in another thread because the scope context is not available.
    Author:
    Dave Syer

    • Field Summary

      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringSTEP_EXECUTION
      The name of the header

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      org.springframework.messaging.Message<?>preSend​(org.springframework.messaging.Message<?> message, org.springframework.messaging.MessageChannel channel) 

      • Methods inherited from class org.springframework.messaging.support.ChannelInterceptorAdapter

        afterReceiveCompletion, afterSendCompletion, postReceive, postSend, preReceive

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • STEP_EXECUTION

        public static final java.lang.String STEP_EXECUTION
        The name of the header
        See Also:
        Constant Field Values

    • Constructor Detail

      • StepExecutionInterceptor

        public StepExecutionInterceptor()

    • Method Detail

      • preSend

        public org.springframework.messaging.Message<?> preSend​(org.springframework.messaging.Message<?> message,
                                                        org.springframework.messaging.MessageChannel channel)
        Specified by:
        preSend in interface org.springframework.messaging.support.ChannelInterceptor
        Overrides:
        preSend in class org.springframework.messaging.support.ChannelInterceptorAdapter