org.springframework.integration.dsl

Class HeaderEnricherSpec

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<T>

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:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<reactor.util.function.Tuple2<ConsumerEndpointFactoryBean,MessageTransformingHandler>>, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, ComponentsRegistration

public class HeaderEnricherSpec
extends ConsumerEndpointSpec<HeaderEnricherSpec,MessageTransformingHandler>

An IntegrationComponentSpec for a HeaderEnricher.

Since:

5.0

Field Summary

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.context.SmartLifecycle

DEFAULT_PHASE

Method Summary

Modifier and Type	Method and Description
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()
<V> HeaderEnricherSpec	header(java.lang.String headerName, HeaderValueMessageProcessor<V> headerValueMessageProcessor) Add a single header specification where the value is obtained by calling the HeaderValueMessageProcessor.
<V> HeaderEnricherSpec	header(java.lang.String name, V value) Add a single header specification.
<V> HeaderEnricherSpec	header(java.lang.String name, V value, java.lang.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(java.lang.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(java.lang.String name, java.lang.String expression) Add a single header specification where the value is a String representation of a SpEL Expression.
HeaderEnricherSpec	headerExpression(java.lang.String name, java.lang.String expression, java.lang.Boolean overwrite) Add a single header specification where the value is a String representation of a SpEL Expression.
HeaderEnricherSpec	headerExpressions(java.util.function.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(java.util.function.Consumer<StringStringMapBuilder> configurer, java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.String> headers, java.lang.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<?,java.lang.String,java.lang.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<?,java.lang.String,java.lang.String> headers, java.lang.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(java.lang.String name, java.util.function.Function<org.springframework.messaging.Message<P>,java.lang.Object> function) Add a single header specification where the value is obtained by invoking the Function callback.
<P> HeaderEnricherSpec	headerFunction(java.lang.String name, java.util.function.Function<org.springframework.messaging.Message<P>,java.lang.Object> function, java.lang.Boolean overwrite) Add a single header specification where the value is obtained by invoking the Function callback.
HeaderEnricherSpec	headers(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.Object> headers, java.lang.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<?,java.lang.String,java.lang.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<?,java.lang.String,java.lang.Object> headers, java.lang.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(MessageProcessor<?> messageProcessor) Configure an optional custom MessageProcessor for the enricher.
HeaderEnricherSpec	messageProcessor(java.lang.String expression) Configure an ExpressionEvaluatingMessageProcessor that evaluates to a Map of additional headers.
HeaderEnricherSpec	messageProcessor(java.lang.String beanName, java.lang.String methodName) Configure an MethodInvokingMessageProcessor that invokes the method on the bean - the method must return a Map of headers.
HeaderEnricherSpec	shouldSkipNulls(boolean shouldSkipNulls)

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

advice, async, autoStartup, notPropagatedHeaders, order, phase, poller, 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, createInstance, destroyInstance, get, getId, getObjectType, getPhase, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

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

Method Detail

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(java.lang.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(java.lang.String beanName,
                                           java.lang.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<?,java.lang.String,java.lang.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<?,java.lang.String,java.lang.Object> headers,
                                  java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.Object> headers,
                                  java.lang.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<?,java.lang.String,java.lang.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<?,java.lang.String,java.lang.String> headers,
                                            java.lang.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(java.util.function.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(java.util.function.Consumer<StringStringMapBuilder> configurer,
                                            java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.String> headers,
                                            java.lang.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.

header

public <V> HeaderEnricherSpec header(java.lang.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(java.lang.String name,
                                     V value,
                                     java.lang.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(java.lang.String name,
                                           java.lang.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(java.lang.String name,
                                           java.lang.String expression,
                                           java.lang.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(java.lang.String name,
                                             java.util.function.Function<org.springframework.messaging.Message<P>,java.lang.Object> 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(java.lang.String name,
                                             java.util.function.Function<org.springframework.messaging.Message<P>,java.lang.Object> function,
                                             java.lang.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(java.lang.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(java.lang.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>