Package org.springframework.integration.dsl

Class TransformerEndpointSpec

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<TransformerEndpointSpec,MessageTransformingHandler>

org.springframework.integration.dsl.TransformerEndpointSpec

All Implemented Interfaces:

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

public class TransformerEndpointSpec
extends ConsumerEndpointSpec<TransformerEndpointSpec,MessageTransformingHandler>

A ConsumerEndpointSpec for a MessageTransformingHandler options. One of the expression(String), ref(Object), refName(String), processor(MessageProcessorSpec) or transformer(GenericTransformer) must be provided.

Since:

6.2

Author:

Artem Bilan

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.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TransformerEndpointSpec()

Method Summary

Modifier and Type	Method	Description
<P> TransformerEndpointSpec	expectedType(Class<P> expectedType)	Set a GenericTransformer input argument type.
TransformerEndpointSpec	expression(String expression)	Provide an expression to use an ExpressionEvaluatingTransformer for the target handler.
TransformerEndpointSpec	expression(Expression expression)	Provide an expression to use an ExpressionEvaluatingTransformer for the target handler.
Map<Object,String>	getComponentsToRegister()
TransformerEndpointSpec	method(String method)	Provide a service method name to call.
TransformerEndpointSpec	processor(MessageProcessorSpec<?> processor)	Provide a MessageProcessorSpec as a factory for MethodInvokingTransformer delegate.
TransformerEndpointSpec	ref(Object ref)	Provide a service to use a MethodInvokingTransformer for the target handler.
TransformerEndpointSpec	refName(String refName)	Provide a bean name to use a MethodInvokingTransformer (based on BeanNameMessageProcessor) for the target handler.
<P, T> TransformerEndpointSpec	transformer(GenericTransformer<P,T> transformer)	Provide a GenericTransformer as a direct delegate for MessageTransformingHandler.

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

advice, async, autoStartup, customizeMonoReply, doGet, 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, id, obtainInputChannelFromFlow, obtainInputChannelFromFlow, poller, poller

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

_this, afterPropertiesSet, destroy, 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

Constructor Details

TransformerEndpointSpec

protected TransformerEndpointSpec()

Method Details

expression

public TransformerEndpointSpec expression(String expression)

Provide an expression to use an ExpressionEvaluatingTransformer for the target handler.

Parameters:

expression - the SpEL expression to use.

Returns:

the TransformerSpec

expression

public TransformerEndpointSpec expression(Expression expression)

Provide an expression to use an ExpressionEvaluatingTransformer for the target handler.

Parameters:

expression - the SpEL expression to use.

Returns:

the TransformerSpec

ref

public TransformerEndpointSpec ref(Object ref)

Provide a service to use a MethodInvokingTransformer for the target handler.

Parameters:

ref - the service to call as a transformer POJO.

Returns:

the TransformerSpec

refName

public TransformerEndpointSpec refName(String refName)

Provide a bean name to use a MethodInvokingTransformer (based on BeanNameMessageProcessor) for the target handler.

Parameters:

refName - the bean name for service to call as a transformer POJO.

Returns:

the TransformerSpec

method

public TransformerEndpointSpec method(@Nullable
 String method)

Provide a service method name to call. Optional. Use only together with ref(Object) or refName(String).

Parameters:

method - the service method name to call.

Returns:

the TransformerSpec

transformer

public <P,
T> TransformerEndpointSpec transformer(GenericTransformer<P,T> transformer)

Provide a GenericTransformer as a direct delegate for MessageTransformingHandler.

Type Parameters:

P - the input type.

T - the output type.

Parameters:

transformer - the GenericTransformer instance to use.

Returns:

the TransformerSpec

expectedType

public <P> TransformerEndpointSpec expectedType(@Nullable
 Class<P> expectedType)

Set a GenericTransformer input argument type. Can be a Message. Ignored for all other transformers, but transformer(GenericTransformer).

Type Parameters:

P - the type ot expect.

Parameters:

expectedType - the GenericTransformer input argument type.

Returns:

the spec.

processor

public TransformerEndpointSpec processor(MessageProcessorSpec<?> processor)

Provide a MessageProcessorSpec as a factory for MethodInvokingTransformer delegate.

Parameters:

processor - the MessageProcessorSpec to use.

Returns:

the TransformerSpec

getComponentsToRegister

public Map<Object,String> getComponentsToRegister()

Specified by:

getComponentsToRegister in interface ComponentsRegistration

Overrides:

getComponentsToRegister in class EndpointSpec<TransformerEndpointSpec,ConsumerEndpointFactoryBean,MessageTransformingHandler>