org.springframework.integration.dsl

Class EnricherSpec

java.lang.Object

org.springframework.integration.dsl.core.IntegrationComponentSpec<S,H>

org.springframework.integration.dsl.core.MessageHandlerSpec<EnricherSpec,org.springframework.integration.transformer.ContentEnricher>

org.springframework.integration.dsl.EnricherSpec

All Implemented Interfaces:

org.springframework.beans.factory.FactoryBean<org.springframework.integration.transformer.ContentEnricher>

public class EnricherSpec
extends MessageHandlerSpec<EnricherSpec,org.springframework.integration.transformer.ContentEnricher>

The MessageHandlerSpec implementation for the ContentEnricher.

Author:

Artem Bilan, Tim Ysewyn

Field Summary

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

logger, PARSER, target

Method Summary

Modifier and Type	Method and Description
protected org.springframework.integration.transformer.ContentEnricher	doGet()
<V> EnricherSpec	header(java.lang.String name, org.springframework.integration.transformer.support.HeaderValueMessageProcessor<V> headerValueMessageProcessor) Set a header value using an explicit HeaderValueMessageProcessor.
<V> EnricherSpec	header(java.lang.String name, V value) Set a header with the value if it is not already present.
<V> EnricherSpec	header(java.lang.String name, V value, java.lang.Boolean overwrite)
EnricherSpec	headerExpression(java.lang.String name, java.lang.String expression) Set a header with the expression evaluation if the header is not already present.
EnricherSpec	headerExpression(java.lang.String name, java.lang.String expression, java.lang.Boolean overwrite)
<P> EnricherSpec	headerFunction(java.lang.String name, Function<org.springframework.messaging.Message<P>,java.lang.Object> function) Set a header with the function return value if the header is not already present.
<P> EnricherSpec	headerFunction(java.lang.String name, Function<org.springframework.messaging.Message<P>,java.lang.Object> function, java.lang.Boolean overwrite)
<V> EnricherSpec	property(java.lang.String key, V value)
EnricherSpec	propertyExpression(java.lang.String key, java.lang.String expression)
<P> EnricherSpec	propertyFunction(java.lang.String key, Function<org.springframework.messaging.Message<P>,java.lang.Object> function)
EnricherSpec	replyChannel(org.springframework.messaging.MessageChannel replyChannel)
EnricherSpec	replyChannel(java.lang.String replyChannel)
EnricherSpec	replyTimeout(java.lang.Long replyTimeout)
EnricherSpec	requestChannel(org.springframework.messaging.MessageChannel requestChannel)
EnricherSpec	requestChannel(java.lang.String requestChannel)
<P> EnricherSpec	requestPayload(Function<org.springframework.messaging.Message<P>,?> requestPayloadFunction)
EnricherSpec	requestPayloadExpression(java.lang.String requestPayloadExpression)
EnricherSpec	requestTimeout(java.lang.Long requestTimeout)
EnricherSpec	shouldClonePayload(boolean shouldClonePayload)

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

_this, get, getId, getObject, getObjectType, id, isSingleton

Methods inherited from class java.lang.Object

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

Method Detail

requestChannel

public EnricherSpec requestChannel(org.springframework.messaging.MessageChannel requestChannel)

Parameters:

requestChannel - the request channel.

Returns:

the enricher spec.

See Also:

ContentEnricher.setRequestChannel(MessageChannel)

requestChannel

public EnricherSpec requestChannel(java.lang.String requestChannel)

Parameters:

requestChannel - the request channel.

Returns:

the enricher spec.

See Also:

ContentEnricher.setRequestChannelName(String)

replyChannel

public EnricherSpec replyChannel(org.springframework.messaging.MessageChannel replyChannel)

Parameters:

replyChannel - the reply channel.

Returns:

the enricher spec.

See Also:

ContentEnricher.setReplyChannel(MessageChannel)

replyChannel

public EnricherSpec replyChannel(java.lang.String replyChannel)

Parameters:

replyChannel - the reply channel.

Returns:

the enricher spec.

See Also:

ContentEnricher.setReplyChannelName(String)

requestTimeout

public EnricherSpec requestTimeout(java.lang.Long requestTimeout)

Parameters:

requestTimeout - the requestTimeout

Returns:

the enricher spec.

See Also:

ContentEnricher.setRequestTimeout(Long)

replyTimeout

public EnricherSpec replyTimeout(java.lang.Long replyTimeout)

Parameters:

replyTimeout - the replyTimeout

Returns:

the enricher spec.

See Also:

ContentEnricher.setReplyTimeout(Long)

requestPayloadExpression

public EnricherSpec requestPayloadExpression(java.lang.String requestPayloadExpression)

Parameters:

requestPayloadExpression - the requestPayloadExpression.

Returns:

the enricher spec.

See Also:

ContentEnricher.setRequestPayloadExpression(Expression)

requestPayload

public <P> EnricherSpec requestPayload(Function<org.springframework.messaging.Message<P>,?> requestPayloadFunction)

Type Parameters:

P - the payload type.

Parameters:

requestPayloadFunction - the requestPayloadFunction.

Returns:

the enricher spec.

See Also:

ContentEnricher.setRequestPayloadExpression(Expression), FunctionExpression

shouldClonePayload

public EnricherSpec shouldClonePayload(boolean shouldClonePayload)

Parameters:

shouldClonePayload - the shouldClonePayload.

Returns:

the enricher spec.

See Also:

ContentEnricher.setShouldClonePayload(boolean)

property

public <V> EnricherSpec property(java.lang.String key,
                                 V value)

Type Parameters:

V - the value type.

Parameters:

key - the key.

value - the value.

Returns:

the enricher spec.

See Also:

ContentEnricher.setPropertyExpressions(Map)

propertyExpression

public EnricherSpec propertyExpression(java.lang.String key,
                                       java.lang.String expression)

Parameters:

key - the key.

expression - the expression.

Returns:

the enricher spec.

See Also:

ContentEnricher.setPropertyExpressions(Map)

propertyFunction

public <P> EnricherSpec propertyFunction(java.lang.String key,
                                         Function<org.springframework.messaging.Message<P>,java.lang.Object> function)

Type Parameters:

P - the payload type.

Parameters:

key - the key.

function - the function (usually a JDK8 lambda).

Returns:

the enricher spec.

See Also:

ContentEnricher.setPropertyExpressions(Map), FunctionExpression

header

public <V> EnricherSpec header(java.lang.String name,
                               V value)

Set a header with the value if it is not already present.

Type Parameters:

V - the value type.

Parameters:

name - the header name.

value - the value.

Returns:

the enricher spec.

See Also:

ContentEnricher.setHeaderExpressions(Map)

header

public <V> EnricherSpec header(java.lang.String name,
                               V value,
                               java.lang.Boolean overwrite)

Type Parameters:

V - the value type.

Parameters:

name - the header name.

value - the value.

overwrite - true to overwrite the header if already present.

Returns:

the enricher spec.

See Also:

ContentEnricher.setHeaderExpressions(Map)

headerExpression

public EnricherSpec headerExpression(java.lang.String name,
                                     java.lang.String expression)

Set a header with the expression evaluation if the header is not already present.

Parameters:

name - the header name.

expression - the expression to be evaluated against the reply message to obtain the value.

Returns:

the enricher spec.

See Also:

ContentEnricher.setHeaderExpressions(Map)

headerExpression

public EnricherSpec headerExpression(java.lang.String name,
                                     java.lang.String expression,
                                     java.lang.Boolean overwrite)

Parameters:

name - the header name.

expression - the expression to be evaluated against the reply message to obtain the value.

overwrite - true to overwrite the header if already present.

Returns:

the enricher spec.

See Also:

ContentEnricher.setHeaderExpressions(Map)

headerFunction

public <P> EnricherSpec headerFunction(java.lang.String name,
                                       Function<org.springframework.messaging.Message<P>,java.lang.Object> function)

Set a header with the function return value if the header is not already present.

Type Parameters:

P - the payload type.

Parameters:

name - the header name.

function - the function (usually a JDK8 lambda).

Returns:

the enricher spec.

See Also:

ContentEnricher.setHeaderExpressions(Map), FunctionExpression

headerFunction

public <P> EnricherSpec headerFunction(java.lang.String name,
                                       Function<org.springframework.messaging.Message<P>,java.lang.Object> function,
                                       java.lang.Boolean overwrite)

Type Parameters:

P - the payload type.

Parameters:

name - the header name.

function - the function (usually a JDK8 lambda).

overwrite - true to overwrite the header if already present.

Returns:

the enricher spec.

See Also:

ContentEnricher.setHeaderExpressions(Map), FunctionExpression

header

public <V> EnricherSpec header(java.lang.String name,
                               org.springframework.integration.transformer.support.HeaderValueMessageProcessor<V> headerValueMessageProcessor)

Set a header value using an explicit HeaderValueMessageProcessor.

Type Parameters:

V - the value type.

Parameters:

name - the header name.

headerValueMessageProcessor - the headerValueMessageProcessor.

Returns:

the enricher spec.

See Also:

ContentEnricher.setHeaderExpressions(Map)

doGet

protected org.springframework.integration.transformer.ContentEnricher doGet()

Overrides:

doGet in class IntegrationComponentSpec<EnricherSpec,org.springframework.integration.transformer.ContentEnricher>