Package org.springframework.integration.dsl

Class HeaderEnricherSpec

java.lang.Object

org.springframework.integration.dsl.IntegrationComponentSpec<S,reactor.util.function.Tuple2<F,H>>

org.springframework.integration.dsl.EndpointSpec<S,ConsumerEndpointFactoryBean,H>

org.springframework.integration.dsl.ConsumerEndpointSpec<HeaderEnricherSpec,MessageTransformingHandler>

org.springframework.integration.dsl.HeaderEnricherSpec

All Implemented Interfaces:

DisposableBean, FactoryBean<reactor.util.function.Tuple2<ConsumerEndpointFactoryBean,MessageTransformingHandler>>, InitializingBean, Lifecycle, Phased, SmartLifecycle, ComponentsRegistration

public class HeaderEnricherSpec
extends ConsumerEndpointSpec<HeaderEnricherSpec,MessageTransformingHandler>

An IntegrationComponentSpec for a HeaderEnricher.

Since:

5.0

Author:

Artem Bilan, Gary Russell

Field Summary

Fields

Modifier and Type	Field	Description
protected final HeaderEnricher	headerEnricher
protected final Map<String,HeaderValueMessageProcessor<?>>	headerToAdd

Fields inherited from class org.springframework.integration.dsl.ConsumerEndpointSpec

adviceChain

Fields inherited from class org.springframework.integration.dsl.EndpointSpec

componentsToRegister, endpointFactoryBean, handler

Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

logger, PARSER, target

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HeaderEnricherSpec()

Method Summary

Modifier and Type	Method	Description
HeaderEnricherSpec	correlationId(Object correlationId)	Add a IntegrationMessageHeaderAccessor.CORRELATION_ID header.
HeaderEnricherSpec	correlationId(Object correlationId, Boolean overwrite)	Add a IntegrationMessageHeaderAccessor.CORRELATION_ID header.
HeaderEnricherSpec	correlationIdExpression(String correlationIdExpression)	Add a IntegrationMessageHeaderAccessor.CORRELATION_ID header where the value is a SpEL Expression evaluation result.
HeaderEnricherSpec	correlationIdExpression(String correlationIdExpression, Boolean overwrite)	Add a IntegrationMessageHeaderAccessor.CORRELATION_ID header where the value is a SpEL Expression evaluation result.
<P> HeaderEnricherSpec	correlationIdFunction(Function<Message<P>,?> correlationIdFunction, Boolean overwrite)	Add a IntegrationMessageHeaderAccessor.CORRELATION_ID header where the value is obtained by invoking the Function callback.
<P> HeaderEnricherSpec	correlationIdFunction(Function<Message<P>,Object> correlationIdFunction)	Add a IntegrationMessageHeaderAccessor.CORRELATION_ID header where the value is obtained by invoking the Function callback.
HeaderEnricherSpec	defaultOverwrite(boolean defaultOverwrite)	Determine the default action to take when setting individual header specifications without an explicit 'overwrite' argument.
protected reactor.util.function.Tuple2<ConsumerEndpointFactoryBean,MessageTransformingHandler>	doGet()
HeaderEnricherSpec	errorChannel(Object errorChannel)	Add a MessageHeaders.ERROR_CHANNEL header: bean name or instance.
HeaderEnricherSpec	errorChannel(Object errorChannel, Boolean overwrite)	Add a MessageHeaders.ERROR_CHANNEL header: bean name or instance.
HeaderEnricherSpec	errorChannelExpression(String errorChannelExpression)	Add a MessageHeaders.ERROR_CHANNEL header where the value is a SpEL Expression evaluation result.
HeaderEnricherSpec	errorChannelExpression(String errorChannelExpression, Boolean overwrite)	Add a MessageHeaders.ERROR_CHANNEL header where the value is a SpEL Expression evaluation result.
<P> HeaderEnricherSpec	errorChannelFunction(Function<Message<P>,?> errorChannelFunction, Boolean overwrite)	Add a MessageHeaders.ERROR_CHANNEL header where the value is obtained by invoking the Function callback.
<P> HeaderEnricherSpec	errorChannelFunction(Function<Message<P>,Object> errorChannelFunction)	Add a MessageHeaders.ERROR_CHANNEL header where the value is obtained by invoking the Function callback.
HeaderEnricherSpec	expirationDate(Object expirationDate)	Add a IntegrationMessageHeaderAccessor.EXPIRATION_DATE header: Date or long.
HeaderEnricherSpec	expirationDate(Object expirationDate, Boolean overwrite)	Add a IntegrationMessageHeaderAccessor.EXPIRATION_DATE header.
HeaderEnricherSpec	expirationDateExpression(String expirationDateExpression)	Add a IntegrationMessageHeaderAccessor.EXPIRATION_DATE header where the value is a SpEL Expression evaluation result.
HeaderEnricherSpec	expirationDateExpression(String expirationDateExpression, Boolean overwrite)	Add a IntegrationMessageHeaderAccessor.EXPIRATION_DATE header where the value is a SpEL Expression evaluation result.
<P> HeaderEnricherSpec	expirationDateFunction(Function<Message<P>,?> expirationDateFunction, Boolean overwrite)	Add a IntegrationMessageHeaderAccessor.EXPIRATION_DATE header where the value is obtained by invoking the Function callback.
<P> HeaderEnricherSpec	expirationDateFunction(Function<Message<P>,Object> expirationDateFunction)	Add a IntegrationMessageHeaderAccessor.EXPIRATION_DATE header where the value is obtained by invoking the Function callback.
<V> HeaderEnricherSpec	header(String headerName, HeaderValueMessageProcessor<V> headerValueMessageProcessor)	Add a single header specification where the value is obtained by calling the HeaderValueMessageProcessor.
<V> HeaderEnricherSpec	header(String name, V value)	Add a single header specification.
<V> HeaderEnricherSpec	header(String name, V value, Boolean overwrite)	Add a single header specification.
HeaderEnricherSpec	headerChannelsToString()	Add header specifications to automatically convert header channels (reply, error channels) to Strings and store them in a header channel registry.
HeaderEnricherSpec	headerChannelsToString(String timeToLiveExpression)	Add header specifications to automatically convert header channels (reply, error channels) to Strings and store them in a header channel registry.
HeaderEnricherSpec	headerExpression(String name, String expression)	Add a single header specification where the value is a String representation of a SpEL Expression.
HeaderEnricherSpec	headerExpression(String name, String expression, Boolean overwrite)	Add a single header specification where the value is a String representation of a SpEL Expression.
HeaderEnricherSpec	headerExpressions(Consumer<StringStringMapBuilder> configurer)	Add header specifications via the consumer callback, which receives a StringStringMapBuilder; the Map values must be String representations of SpEL expressions that will be evaluated at run time when the message headers are enriched.
HeaderEnricherSpec	headerExpressions(Consumer<StringStringMapBuilder> configurer, Boolean overwrite)	Add header specifications via the consumer callback, which receives a StringStringMapBuilder; the Map values must be String representations of SpEL expressions that will be evaluated at run time when the message headers are enriched.
HeaderEnricherSpec	headerExpressions(Map<String,String> headers)	Add header specifications; the Map values must be String representations of SpEL expressions that will be evaluated at run time when the message headers are enriched.
HeaderEnricherSpec	headerExpressions(Map<String,String> headers, Boolean overwrite)	Add header specifications; the Map values must be String representations of SpEL expressions that will be evaluated at run time when the message headers are enriched.
HeaderEnricherSpec	headerExpressions(MapBuilder<?,String,String> headers)	Add header specifications from the MapBuilder; the Map values must be String representations of SpEL expressions that will be evaluated at run time when the message headers are enriched.
HeaderEnricherSpec	headerExpressions(MapBuilder<?,String,String> headers, Boolean overwrite)	Add header specifications from the MapBuilder; the Map values must be String representations of SpEL expressions that will be evaluated at run time when the message headers are enriched.
<P> HeaderEnricherSpec	headerFunction(String name, Function<Message<P>,?> function)	Add a single header specification where the value is obtained by invoking the Function callback.
<P> HeaderEnricherSpec	headerFunction(String name, Function<Message<P>,?> function, Boolean overwrite)	Add a single header specification where the value is obtained by invoking the Function callback.
HeaderEnricherSpec	headers(Map<String,Object> headers)	Add header specifications from the Map; if a map value is an Expression, it will be evaluated at run time when the message headers are enriched.
HeaderEnricherSpec	headers(Map<String,Object> headers, Boolean overwrite)	Add header specifications from the Map; if a map value is an Expression, it will be evaluated at run time when the message headers are enriched.
HeaderEnricherSpec	headers(MapBuilder<?,String,Object> headers)	Add header specifications from the MapBuilder; if a map value is an Expression, it will be evaluated at run time when the message headers are enriched.
HeaderEnricherSpec	headers(MapBuilder<?,String,Object> headers, Boolean overwrite)	Add header specifications from the MapBuilder; if a map value is an Expression, it will be evaluated at run time when the message headers are enriched.
HeaderEnricherSpec	messageProcessor(String expression)	Configure an ExpressionEvaluatingMessageProcessor that evaluates to a Map of additional headers.
HeaderEnricherSpec	messageProcessor(String beanName, String methodName)	Configure an MethodInvokingMessageProcessor that invokes the method on the bean - the method must return a Map of headers.
HeaderEnricherSpec	messageProcessor(MessageProcessor<?> messageProcessor)	Configure an optional custom MessageProcessor for the enricher.
HeaderEnricherSpec	priority(Number priority)	Add a IntegrationMessageHeaderAccessor.PRIORITY header.
HeaderEnricherSpec	priority(Number priority, Boolean overwrite)	Add a IntegrationMessageHeaderAccessor.PRIORITY header.
HeaderEnricherSpec	priorityExpression(String priorityExpression)	Add a IntegrationMessageHeaderAccessor.PRIORITY header where the value is a SpEL Expression evaluation result.
HeaderEnricherSpec	priorityExpression(String priorityExpression, Boolean overwrite)	Add a IntegrationMessageHeaderAccessor.PRIORITY header where the value is a SpEL Expression evaluation result.
<P> HeaderEnricherSpec	priorityFunction(Function<Message<P>,?> priorityFunction, Boolean overwrite)	Add a IntegrationMessageHeaderAccessor.PRIORITY header where the value is obtained by invoking the Function callback.
<P> HeaderEnricherSpec	priorityFunction(Function<Message<P>,Object> priorityFunction)	Add a IntegrationMessageHeaderAccessor.PRIORITY header where the value is obtained by invoking the Function callback.
HeaderEnricherSpec	replyChannel(Object replyChannel)	Add a MessageHeaders.REPLY_CHANNEL header: bean name or instance.
HeaderEnricherSpec	replyChannel(Object replyChannel, Boolean overwrite)	Add a MessageHeaders.REPLY_CHANNEL header: bean name or instance.
HeaderEnricherSpec	replyChannelExpression(String replyChannelExpression)	Add a MessageHeaders.REPLY_CHANNEL header where the value is a SpEL Expression evaluation result.
HeaderEnricherSpec	replyChannelExpression(String replyChannelExpression, Boolean overwrite)	Add a MessageHeaders.REPLY_CHANNEL header where the value is a SpEL Expression evaluation result.
<P> HeaderEnricherSpec	replyChannelFunction(Function<Message<P>,?> replyChannelFunction, Boolean overwrite)	Add a MessageHeaders.REPLY_CHANNEL header where the value is obtained by invoking the Function callback.
<P> HeaderEnricherSpec	replyChannelFunction(Function<Message<P>,Object> replyChannelFunction)	Add a MessageHeaders.REPLY_CHANNEL header where the value is obtained by invoking the Function callback.
HeaderEnricherSpec	routingSlip(Boolean overwrite, Object... routingSlipPath)	Add a IntegrationMessageHeaderAccessor.ROUTING_SLIP header.
HeaderEnricherSpec	routingSlip(Object... routingSlipPath)	Add a IntegrationMessageHeaderAccessor.ROUTING_SLIP header.
HeaderEnricherSpec	shouldSkipNulls(boolean shouldSkipNulls)

Methods inherited from class org.springframework.integration.dsl.ConsumerEndpointSpec

advice, async, autoStartup, customizeMonoReply, handleMessageAdvice, notPropagatedHeaders, order, phase, poller, reactive, reactive, requiresReply, role, sendTimeout, taskScheduler, transactional, transactional, transactional, transactional, transactional

Methods inherited from class org.springframework.integration.dsl.EndpointSpec

assertHandler, getComponentsToRegister, id, obtainInputChannelFromFlow, obtainInputChannelFromFlow, poller, poller

Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

_this, afterPropertiesSet, destroy, get, getId, getObject, getObjectType, getPhase, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.FactoryBean

isSingleton

Field Details

headerToAdd

protected final Map<String,HeaderValueMessageProcessor<?>> headerToAdd

headerEnricher

protected final HeaderEnricher headerEnricher

Constructor Details

HeaderEnricherSpec

protected HeaderEnricherSpec()

Method Details

defaultOverwrite

public HeaderEnricherSpec defaultOverwrite(boolean defaultOverwrite)

Determine the default action to take when setting individual header specifications without an explicit 'overwrite' argument.

Parameters:

defaultOverwrite - the defaultOverwrite.

Returns:

the header enricher spec.

See Also:

• HeaderEnricher.setDefaultOverwrite(boolean)

shouldSkipNulls

public HeaderEnricherSpec shouldSkipNulls(boolean shouldSkipNulls)

Parameters:

shouldSkipNulls - the shouldSkipNulls.

Returns:

the header enricher spec.

See Also:

• HeaderEnricher.setShouldSkipNulls(boolean)

messageProcessor

public HeaderEnricherSpec messageProcessor(MessageProcessor<?> messageProcessor)

Configure an optional custom MessageProcessor for the enricher. The processor must return a Map of header names and values. They will be added to the inbound message headers before evaluating the individual configured header specifications.

Parameters:

messageProcessor - the messageProcessor.

Returns:

the header enricher spec.

See Also:

• HeaderEnricher.setMessageProcessor(MessageProcessor)

messageProcessor

public HeaderEnricherSpec messageProcessor(String expression)

Configure an ExpressionEvaluatingMessageProcessor that evaluates to a Map of additional headers. They will be added to the inbound message headers before evaluating the individual configured header specifications.

Parameters:

expression - the expression.

Returns:

the header enricher spec.

See Also:

• messageProcessor(MessageProcessor)

messageProcessor

public HeaderEnricherSpec messageProcessor(String beanName,
 String methodName)

Configure an MethodInvokingMessageProcessor that invokes the method on the bean - the method must return a Map of headers. They will be added to the inbound message headers before evaluating the individual configured header specifications.

Parameters:

beanName - The bean name.

methodName - The method name.

Returns:

the header enricher spec.

See Also:

• messageProcessor(MessageProcessor)

headers

public HeaderEnricherSpec headers(MapBuilder<?,String,Object> headers)

Add header specifications from the MapBuilder; if a map value is an Expression, it will be evaluated at run time when the message headers are enriched. Otherwise, the value is simply added to the headers. Headers derived from the map will not overwrite existing headers, unless defaultOverwrite(boolean) is true.

Parameters:

headers - the header map builder.

Returns:

the header enricher spec.

headers

public HeaderEnricherSpec headers(MapBuilder<?,String,Object> headers,
 @Nullable
 Boolean overwrite)

Add header specifications from the MapBuilder; if a map value is an Expression, it will be evaluated at run time when the message headers are enriched. Otherwise, the value is simply added to the headers.

Parameters:

headers - the header map builder.

overwrite - true to overwrite existing headers.

Returns:

the header enricher spec.

headers

public HeaderEnricherSpec headers(Map<String,Object> headers)

Add header specifications from the Map; if a map value is an Expression, it will be evaluated at run time when the message headers are enriched. Otherwise, the value is simply added to the headers. Headers derived from the map will not overwrite existing headers, unless defaultOverwrite(boolean) is true.

Parameters:

headers - The header builder.

Returns:

the header enricher spec.

headers

public HeaderEnricherSpec headers(Map<String,Object> headers,
 @Nullable
 Boolean overwrite)

Add header specifications from the Map; if a map value is an Expression, it will be evaluated at run time when the message headers are enriched. Otherwise, the value is simply added to the headers.

Parameters:

headers - The header builder.

overwrite - true to overwrite existing headers.

Returns:

the header enricher spec.

headerExpressions

public HeaderEnricherSpec headerExpressions(MapBuilder<?,String,String> headers)

Add header specifications from the MapBuilder; the Map values must be String representations of SpEL expressions that will be evaluated at run time when the message headers are enriched. Headers derived from the map will not overwrite existing headers, unless defaultOverwrite(boolean) is true.

Parameters:

headers - the header map builder.

Returns:

the header enricher spec.

headerExpressions

public HeaderEnricherSpec headerExpressions(MapBuilder<?,String,String> headers,
 @Nullable
 Boolean overwrite)

Add header specifications from the MapBuilder; the Map values must be String representations of SpEL expressions that will be evaluated at run time when the message headers are enriched.

Parameters:

headers - the header map builder.

overwrite - true to overwrite existing headers.

Returns:

the header enricher spec.

headerExpressions

public HeaderEnricherSpec headerExpressions(Consumer<StringStringMapBuilder> configurer)

Add header specifications via the consumer callback, which receives a StringStringMapBuilder; the Map values must be String representations of SpEL expressions that will be evaluated at run time when the message headers are enriched. Headers derived from the map will not overwrite existing headers, unless defaultOverwrite(boolean) is true. Usually used with a JDK8 lambda:

 
 .enrichHeaders(s -> s.headerExpressions(c -> c
 			.put(MailHeaders.SUBJECT, "payload.subject")
 			.put(MailHeaders.FROM,    "payload.from[0].toString()")))
 
 

Parameters:

configurer - the configurer.

Returns:

the header enricher spec.

headerExpressions

public HeaderEnricherSpec headerExpressions(Consumer<StringStringMapBuilder> configurer,
 @Nullable
 Boolean overwrite)

Add header specifications via the consumer callback, which receives a StringStringMapBuilder; the Map values must be String representations of SpEL expressions that will be evaluated at run time when the message headers are enriched. Usually used with a JDK8 lambda:

 
 .enrichHeaders(s -> s.headerExpressions(c -> c
 			.put(MailHeaders.SUBJECT, "payload.subject")
 			.put(MailHeaders.FROM,    "payload.from[0].toString()"), true))
 
 

Parameters:

configurer - the configurer.

overwrite - true to overwrite existing headers.

Returns:

the header enricher spec.

headerExpressions

public HeaderEnricherSpec headerExpressions(Map<String,String> headers)

Add header specifications; the Map values must be String representations of SpEL expressions that will be evaluated at run time when the message headers are enriched. Headers derived from the map will not overwrite existing headers, unless defaultOverwrite(boolean) is true.

Parameters:

headers - the headers.

Returns:

the header enricher spec.

headerExpressions

public HeaderEnricherSpec headerExpressions(Map<String,String> headers,
 @Nullable
 Boolean overwrite)

Add header specifications; the Map values must be String representations of SpEL expressions that will be evaluated at run time when the message headers are enriched.

Parameters:

headers - the headers.

overwrite - true to overwrite existing headers.

Returns:

the header enricher spec.

correlationId

public HeaderEnricherSpec correlationId(Object correlationId)

Add a IntegrationMessageHeaderAccessor.CORRELATION_ID header. If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Parameters:

correlationId - the header value for IntegrationMessageHeaderAccessor.CORRELATION_ID.

Returns:

the header enricher spec.

Since:

5.2

correlationId

public HeaderEnricherSpec correlationId(Object correlationId,
 @Nullable
 Boolean overwrite)

Add a IntegrationMessageHeaderAccessor.CORRELATION_ID header.

Parameters:

correlationId - the header value for IntegrationMessageHeaderAccessor.CORRELATION_ID.

overwrite - true to overwrite an existing header.

Returns:

the header enricher spec.

Since:

5.2

correlationIdExpression

public HeaderEnricherSpec correlationIdExpression(String correlationIdExpression)

Add a IntegrationMessageHeaderAccessor.CORRELATION_ID header where the value is a SpEL Expression evaluation result. If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Parameters:

correlationIdExpression - the expression for IntegrationMessageHeaderAccessor.CORRELATION_ID header.

Returns:

the header enricher spec.

Since:

5.2

correlationIdExpression

public HeaderEnricherSpec correlationIdExpression(String correlationIdExpression,
 @Nullable
 Boolean overwrite)

Add a IntegrationMessageHeaderAccessor.CORRELATION_ID header where the value is a SpEL Expression evaluation result.

Parameters:

correlationIdExpression - the expression for IntegrationMessageHeaderAccessor.CORRELATION_ID header.

overwrite - true to overwrite an existing header.

Returns:

the header enricher spec.

Since:

5.2

correlationIdFunction

public <P> HeaderEnricherSpec correlationIdFunction(Function<Message<P>,Object> correlationIdFunction)

Add a IntegrationMessageHeaderAccessor.CORRELATION_ID header where the value is obtained by invoking the Function callback. If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Type Parameters:

P - the payload type.

Parameters:

correlationIdFunction - the function.

Returns:

the header enricher spec.

Since:

5.2

See Also:

• FunctionExpression

correlationIdFunction

public <P> HeaderEnricherSpec correlationIdFunction(Function<Message<P>,?> correlationIdFunction,
 @Nullable
 Boolean overwrite)

Add a IntegrationMessageHeaderAccessor.CORRELATION_ID header where the value is obtained by invoking the Function callback.

Type Parameters:

P - the payload type.

Parameters:

correlationIdFunction - the function.

overwrite - true to overwrite an existing header.

Returns:

the header enricher spec.

Since:

5.2

See Also:

• FunctionExpression

replyChannel

public HeaderEnricherSpec replyChannel(Object replyChannel)

Add a MessageHeaders.REPLY_CHANNEL header: bean name or instance. If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Parameters:

replyChannel - the header value for MessageHeaders.REPLY_CHANNEL.

Returns:

the header enricher spec.

Since:

5.2

replyChannel

public HeaderEnricherSpec replyChannel(Object replyChannel,
 @Nullable
 Boolean overwrite)

Add a MessageHeaders.REPLY_CHANNEL header: bean name or instance.

Parameters:

replyChannel - the header value for MessageHeaders.REPLY_CHANNEL.

overwrite - true to overwrite an existing header.

Returns:

the header enricher spec.

Since:

5.2

replyChannelExpression

public HeaderEnricherSpec replyChannelExpression(String replyChannelExpression)

Add a MessageHeaders.REPLY_CHANNEL header where the value is a SpEL Expression evaluation result. If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Parameters:

replyChannelExpression - the expression for MessageHeaders.REPLY_CHANNEL header.

Returns:

the header enricher spec.

Since:

5.2

replyChannelExpression

public HeaderEnricherSpec replyChannelExpression(String replyChannelExpression,
 @Nullable
 Boolean overwrite)

Add a MessageHeaders.REPLY_CHANNEL header where the value is a SpEL Expression evaluation result.

Parameters:

replyChannelExpression - the expression for MessageHeaders.REPLY_CHANNEL header.

overwrite - true to overwrite an existing header.

Returns:

the header enricher spec.

Since:

5.2

replyChannelFunction

public <P> HeaderEnricherSpec replyChannelFunction(Function<Message<P>,Object> replyChannelFunction)

Add a MessageHeaders.REPLY_CHANNEL header where the value is obtained by invoking the Function callback. If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Type Parameters:

P - the payload type.

Parameters:

replyChannelFunction - the function.

Returns:

the header enricher spec.

Since:

5.2

See Also:

• FunctionExpression

replyChannelFunction

public <P> HeaderEnricherSpec replyChannelFunction(Function<Message<P>,?> replyChannelFunction,
 @Nullable
 Boolean overwrite)

Add a MessageHeaders.REPLY_CHANNEL header where the value is obtained by invoking the Function callback.

Type Parameters:

P - the payload type.

Parameters:

replyChannelFunction - the function.

overwrite - true to overwrite an existing header.

Returns:

the header enricher spec.

Since:

5.2

See Also:

• FunctionExpression

errorChannel

public HeaderEnricherSpec errorChannel(Object errorChannel)

Add a MessageHeaders.ERROR_CHANNEL header: bean name or instance. If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Parameters:

errorChannel - the header value for MessageHeaders.ERROR_CHANNEL.

Returns:

the header enricher spec.

Since:

5.2

errorChannel

public HeaderEnricherSpec errorChannel(Object errorChannel,
 @Nullable
 Boolean overwrite)

Add a MessageHeaders.ERROR_CHANNEL header: bean name or instance.

Parameters:

errorChannel - the header value for MessageHeaders.ERROR_CHANNEL.

overwrite - true to overwrite an existing header.

Returns:

the header enricher spec.

Since:

5.2

errorChannelExpression

public HeaderEnricherSpec errorChannelExpression(String errorChannelExpression)

Add a MessageHeaders.ERROR_CHANNEL header where the value is a SpEL Expression evaluation result. If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Parameters:

errorChannelExpression - the expression for MessageHeaders.ERROR_CHANNEL header.

Returns:

the header enricher spec.

Since:

5.2

errorChannelExpression

public HeaderEnricherSpec errorChannelExpression(String errorChannelExpression,
 @Nullable
 Boolean overwrite)

Add a MessageHeaders.ERROR_CHANNEL header where the value is a SpEL Expression evaluation result.

Parameters:

errorChannelExpression - the expression for MessageHeaders.ERROR_CHANNEL header.

overwrite - true to overwrite an existing header.

Returns:

the header enricher spec.

Since:

5.2

errorChannelFunction

public <P> HeaderEnricherSpec errorChannelFunction(Function<Message<P>,Object> errorChannelFunction)

Add a MessageHeaders.ERROR_CHANNEL header where the value is obtained by invoking the Function callback. If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Type Parameters:

P - the payload type.

Parameters:

errorChannelFunction - the function.

Returns:

the header enricher spec.

Since:

5.2

See Also:

• FunctionExpression

errorChannelFunction

public <P> HeaderEnricherSpec errorChannelFunction(Function<Message<P>,?> errorChannelFunction,
 @Nullable
 Boolean overwrite)

Add a MessageHeaders.ERROR_CHANNEL header where the value is obtained by invoking the Function callback.

Type Parameters:

P - the payload type.

Parameters:

errorChannelFunction - the function.

overwrite - true to overwrite an existing header.

Returns:

the header enricher spec.

Since:

5.2

See Also:

• FunctionExpression

priority

public HeaderEnricherSpec priority(Number priority)

Add a IntegrationMessageHeaderAccessor.PRIORITY header. If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Parameters:

priority - the header value for IntegrationMessageHeaderAccessor.PRIORITY.

Returns:

the header enricher spec.

Since:

5.2

priority

public HeaderEnricherSpec priority(Number priority,
 @Nullable
 Boolean overwrite)

Add a IntegrationMessageHeaderAccessor.PRIORITY header.

Parameters:

priority - the header value for IntegrationMessageHeaderAccessor.PRIORITY.

overwrite - true to overwrite an existing header.

Returns:

the header enricher spec.

Since:

5.2

priorityExpression

public HeaderEnricherSpec priorityExpression(String priorityExpression)

Add a IntegrationMessageHeaderAccessor.PRIORITY header where the value is a SpEL Expression evaluation result. If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Parameters:

priorityExpression - the expression for IntegrationMessageHeaderAccessor.PRIORITY header.

Returns:

the header enricher spec.

Since:

5.2

priorityExpression

public HeaderEnricherSpec priorityExpression(String priorityExpression,
 @Nullable
 Boolean overwrite)

Add a IntegrationMessageHeaderAccessor.PRIORITY header where the value is a SpEL Expression evaluation result.

Parameters:

priorityExpression - the expression for IntegrationMessageHeaderAccessor.PRIORITY header.

overwrite - true to overwrite an existing header.

Returns:

the header enricher spec.

Since:

5.2

priorityFunction

public <P> HeaderEnricherSpec priorityFunction(Function<Message<P>,Object> priorityFunction)

Add a IntegrationMessageHeaderAccessor.PRIORITY header where the value is obtained by invoking the Function callback. If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Type Parameters:

P - the payload type.

Parameters:

priorityFunction - the function.

Returns:

the header enricher spec.

Since:

5.2

See Also:

• FunctionExpression

priorityFunction

public <P> HeaderEnricherSpec priorityFunction(Function<Message<P>,?> priorityFunction,
 @Nullable
 Boolean overwrite)

Add a IntegrationMessageHeaderAccessor.PRIORITY header where the value is obtained by invoking the Function callback.

Type Parameters:

P - the payload type.

Parameters:

priorityFunction - the function.

overwrite - true to overwrite an existing header.

Returns:

the header enricher spec.

Since:

5.2

See Also:

• FunctionExpression

expirationDate

public HeaderEnricherSpec expirationDate(Object expirationDate)

Add a IntegrationMessageHeaderAccessor.EXPIRATION_DATE header: Date or long. If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Parameters:

expirationDate - the header value for IntegrationMessageHeaderAccessor.EXPIRATION_DATE.

Returns:

the header enricher spec.

Since:

5.2

expirationDate

public HeaderEnricherSpec expirationDate(Object expirationDate,
 @Nullable
 Boolean overwrite)

Add a IntegrationMessageHeaderAccessor.EXPIRATION_DATE header.

Parameters:

expirationDate - the header value for IntegrationMessageHeaderAccessor.EXPIRATION_DATE.

overwrite - true to overwrite an existing header.

Returns:

the header enricher spec.

Since:

5.2

expirationDateExpression

public HeaderEnricherSpec expirationDateExpression(String expirationDateExpression)

Add a IntegrationMessageHeaderAccessor.EXPIRATION_DATE header where the value is a SpEL Expression evaluation result. If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Parameters:

expirationDateExpression - the expression for IntegrationMessageHeaderAccessor.EXPIRATION_DATE header.

Returns:

the header enricher spec.

Since:

5.2

expirationDateExpression

public HeaderEnricherSpec expirationDateExpression(String expirationDateExpression,
 @Nullable
 Boolean overwrite)

Add a IntegrationMessageHeaderAccessor.EXPIRATION_DATE header where the value is a SpEL Expression evaluation result.

Parameters:

expirationDateExpression - the expression for IntegrationMessageHeaderAccessor.EXPIRATION_DATE header.

overwrite - true to overwrite an existing header.

Returns:

the header enricher spec.

Since:

5.2

expirationDateFunction

public <P> HeaderEnricherSpec expirationDateFunction(Function<Message<P>,Object> expirationDateFunction)

Add a IntegrationMessageHeaderAccessor.EXPIRATION_DATE header where the value is obtained by invoking the Function callback. If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Type Parameters:

P - the payload type.

Parameters:

expirationDateFunction - the function.

Returns:

the header enricher spec.

Since:

5.2

See Also:

• FunctionExpression

expirationDateFunction

public <P> HeaderEnricherSpec expirationDateFunction(Function<Message<P>,?> expirationDateFunction,
 @Nullable
 Boolean overwrite)

Add a IntegrationMessageHeaderAccessor.EXPIRATION_DATE header where the value is obtained by invoking the Function callback.

Type Parameters:

P - the payload type.

Parameters:

expirationDateFunction - the function.

overwrite - true to overwrite an existing header.

Returns:

the header enricher spec.

Since:

5.2

See Also:

• FunctionExpression

routingSlip

public HeaderEnricherSpec routingSlip(Object... routingSlipPath)

Add a IntegrationMessageHeaderAccessor.ROUTING_SLIP header. The possible values are:

• A MessageChannel instance.
• A MessageChannel bean name.
• A RoutingSlipRouteStrategy instance.
• A RoutingSlipRouteStrategy bean name.
• A String for SpEL expression which has to be evaluated to the MessageChannel or RoutingSlipRouteStrategy.

If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Parameters:

routingSlipPath - the header value for IntegrationMessageHeaderAccessor.ROUTING_SLIP.

Returns:

the header enricher spec.

Since:

5.2

routingSlip

public HeaderEnricherSpec routingSlip(@Nullable
 Boolean overwrite,
 Object... routingSlipPath)

Add a IntegrationMessageHeaderAccessor.ROUTING_SLIP header. The possible values are:

• A MessageChannel instance.
• A MessageChannel bean name.
• A RoutingSlipRouteStrategy instance.
• A RoutingSlipRouteStrategy bean name.
• A String for SpEL expression which has to be evaluated to the MessageChannel or RoutingSlipRouteStrategy.

Parameters:

overwrite - true to overwrite an existing header.

routingSlipPath - the header value for IntegrationMessageHeaderAccessor.ROUTING_SLIP.

Returns:

the header enricher spec.

Since:

5.2

header

public <V> HeaderEnricherSpec header(String name,
 V value)

Add a single header specification. If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Type Parameters:

V - the value type.

Parameters:

name - the header name.

value - the header value (not an Expression).

Returns:

the header enricher spec.

header

public <V> HeaderEnricherSpec header(String name,
 V value,
 @Nullable
 Boolean overwrite)

Add a single header specification.

Type Parameters:

V - the value type.

Parameters:

name - the header name.

value - the header value (not an Expression).

overwrite - true to overwrite an existing header.

Returns:

the header enricher spec.

headerExpression

public HeaderEnricherSpec headerExpression(String name,
 String expression)

Add a single header specification where the value is a String representation of a SpEL Expression. If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Parameters:

name - the header name.

expression - the expression.

Returns:

the header enricher spec.

headerExpression

public HeaderEnricherSpec headerExpression(String name,
 String expression,
 @Nullable
 Boolean overwrite)

Add a single header specification where the value is a String representation of a SpEL Expression.

Parameters:

name - the header name.

expression - the expression.

overwrite - true to overwrite an existing header.

Returns:

the header enricher spec.

headerFunction

public <P> HeaderEnricherSpec headerFunction(String name,
 Function<Message<P>,?> function)

Add a single header specification where the value is obtained by invoking the Function callback. If the header exists, it will not be overwritten unless defaultOverwrite(boolean) is true.

Type Parameters:

P - the payload type.

Parameters:

name - the header name.

function - the function.

Returns:

the header enricher spec.

See Also:

• FunctionExpression

headerFunction

public <P> HeaderEnricherSpec headerFunction(String name,
 Function<Message<P>,?> function,
 @Nullable
 Boolean overwrite)

Add a single header specification where the value is obtained by invoking the Function callback.

Type Parameters:

P - the payload type.

Parameters:

name - the header name.

function - the function.

overwrite - true to overwrite an existing header.

Returns:

the header enricher spec.

See Also:

• FunctionExpression

header

public <V> HeaderEnricherSpec header(String headerName,
 HeaderValueMessageProcessor<V> headerValueMessageProcessor)

Add a single header specification where the value is obtained by calling the HeaderValueMessageProcessor.

Type Parameters:

V - the value type.

Parameters:

headerName - the header name.

headerValueMessageProcessor - the message processor.

Returns:

the header enricher spec.

headerChannelsToString

public HeaderEnricherSpec headerChannelsToString()

Add header specifications to automatically convert header channels (reply, error channels) to Strings and store them in a header channel registry. Allows persistence and serialization of messages without losing these important framework headers.

Returns:

the header enricher spec.

See Also:

• HeaderChannelRegistry

headerChannelsToString

public HeaderEnricherSpec headerChannelsToString(@Nullable
 String timeToLiveExpression)

Add header specifications to automatically convert header channels (reply, error channels) to Strings and store them in a header channel registry. Allows persistence and serialization of messages without losing these important framework headers.

Parameters:

timeToLiveExpression - the minimum time that the mapping will remain in the registry.

Returns:

the header enricher spec.

See Also:

• HeaderChannelRegistry

doGet

protected reactor.util.function.Tuple2<ConsumerEndpointFactoryBean,MessageTransformingHandler> doGet()

Overrides:

doGet in class ConsumerEndpointSpec<HeaderEnricherSpec,MessageTransformingHandler>