Package org.springframework.integration.handler

Interface HeaderPropagationAware

All Known Implementing Classes:
AbstractAmqpOutboundEndpoint, AbstractCorrelatingMessageHandler, AbstractHttpRequestExecutingMessageHandler, AbstractMessageProducingHandler, AbstractMessageSplitter, AbstractRemoteFileOutboundGateway, AbstractReplyProducingMessageHandler, AbstractReplyProducingPostProcessingMessageHandler, AbstractWebServiceOutboundGateway, AggregatingMessageHandler, AmqpOutboundEndpoint, AsyncAmqpOutboundGateway, BarrierMessageHandler, BridgeHandler, ContentEnricher, DefaultMessageSplitter, DelayHandler, ExpressionEvaluatingSplitter, FileSplitter, FileWritingMessageHandler, FluxAggregatorMessageHandler, FtpOutboundGateway, GatewayMessageHandler, GraphQlMessageHandler, HttpRequestExecutingMessageHandler, JdbcOutboundGateway, JmsOutboundGateway, JpaOutboundGateway, KafkaProducerMessageHandler, MarshallingWebServiceOutboundGateway, MessageFilter, MessageHandlerChain, MessageTransformingHandler, MethodInvokingSplitter, MockMessageHandler, MongoDbOutboundGateway, OperationInvokingMessageHandler, RedisOutboundGateway, RedisQueueOutboundGateway, ReplyProducingMessageHandlerWrapper, ResequencingMessageHandler, RSocketOutboundGateway, ScatterGatherHandler, ServiceActivatingHandler, SftpOutboundGateway, SimpleWebServiceOutboundGateway, StoredProcOutboundGateway, TcpOutboundGateway, WebFluxRequestExecutingMessageHandler, XPathMessageSplitter
public interface HeaderPropagationAware
MessageHandlers implementing this interface can propagate headers from an input message to an output message.
Since:
4.3.11
Author:
Gary Russell

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addNotPropagatedHeaders(String... headers)
    Add headers that will NOT be copied from the inbound message if the handler is configured to copy headers, instead of overwriting the existing set.
    Collection<String>
    getNotPropagatedHeaders()
    Get the header names this handler doesn't propagate.
    void
    setNotPropagatedHeaders(String... headers)
    Set headers that will NOT be copied from the inbound message if the handler is configured to copy headers.

  • Method Details

    • setNotPropagatedHeaders

      void setNotPropagatedHeaders(String... headers)
      Set headers that will NOT be copied from the inbound message if the handler is configured to copy headers.
      Parameters:
      headers - the headers to not propagate from the inbound message.

    • getNotPropagatedHeaders

      Collection<String> getNotPropagatedHeaders()
      Get the header names this handler doesn't propagate.
      Returns:
      an immutable Collection of headers that will not be copied from the inbound message if the handler is configured to copy headers.
      See Also:

    • addNotPropagatedHeaders

      void addNotPropagatedHeaders(String... headers)
      Add headers that will NOT be copied from the inbound message if the handler is configured to copy headers, instead of overwriting the existing set.
      Parameters:
      headers - the headers to not propagate from the inbound message.
      See Also: