Class GatewayProxySpec

java.lang.Object

org.springframework.integration.dsl.GatewayProxySpec

public class GatewayProxySpec
extends Object

A builder for the GatewayProxyFactoryBean options when MessagingGateway on the service interface cannot be declared.

Since:

5.2

Author:

Artem Bilan, Gary Russell

Field Summary

Fields

Modifier and Type	Field	Description
protected final GatewayMethodMetadata	gatewayMethodMetadata
protected final GatewayProxyFactoryBean<?>	gatewayProxyFactoryBean
protected final MessageChannel	gatewayRequestChannel
protected final Map<String, Expression>	headerExpressions
protected static final SpelExpressionParser	PARSER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GatewayProxySpec(Class<?> serviceInterface)

Method Summary

Modifier and Type	Method	Description
GatewayProxySpec	asyncExecutor(Executor executor)	Provide a reference to an implementation of Executor to use for any of the interface methods that have a Future return type.
GatewayProxySpec	beanName(String beanName)	Specify a bean name for the target GatewayProxyFactoryBean.
GatewayProxySpec	errorChannel(String errorChannelName)	Identifies a channel that error messages will be sent to if a failure occurs in the gateway's proxy invocation.
GatewayProxySpec	errorChannel(MessageChannel errorChannel)	Identifies a channel that error messages will be sent to if a failure occurs in the gateway's proxy invocation.
GatewayProxySpec	header(String headerName, Object value)	Provides custom message header.
GatewayProxySpec	header(String headerName, Function<MethodArgsHolder, ?> valueFunction)	Provides custom message header.
GatewayProxySpec	header(String headerName, Expression valueExpression)	Provides custom message header.
GatewayProxySpec	mapper(MethodArgsMessageMapper mapper)	An MethodArgsMessageMapper to map the method arguments to a Message.
GatewayProxySpec	payloadExpression(String expression)	An expression that will be used to generate the payload for all methods in the service interface unless explicitly overridden by a method declaration.
GatewayProxySpec	payloadExpression(Expression expression)	An expression that will be used to generate the payload for all methods in the service interface unless explicitly overridden by a method declaration.
GatewayProxySpec	payloadFunction(Function<MethodArgsHolder, ?> defaultPayloadFunction)	A Function that will be used to generate the payload for all methods in the service interface unless explicitly overridden by a method declaration.
GatewayProxySpec	proxyDefaultMethods(boolean proxyDefaultMethods)	Indicate if default methods on the interface should be proxied as well.
GatewayProxySpec	replyChannel(String channelName)	Identifies the default channel the gateway proxy will subscribe to, to receive reply Messages, the payloads of which will be converted to the return type of the method signature.
GatewayProxySpec	replyChannel(MessageChannel replyChannel)	Identifies the default channel the gateway proxy will subscribe to, to receive reply Messages, the payloads of which will be converted to the return type of the method signature.
GatewayProxySpec	replyTimeout(long replyTimeout)	Allows to specify how long this gateway will wait for the reply Message before returning.
GatewayProxySpec	requestTimeout(long requestTimeout)	Provides the amount of time dispatcher would wait to send a Message.

Methods inherited from class java.lang.Object

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

Field Details

PARSER

protected static final SpelExpressionParser PARSER

gatewayRequestChannel

protected final MessageChannel gatewayRequestChannel

gatewayProxyFactoryBean

protected final GatewayProxyFactoryBean<?> gatewayProxyFactoryBean

gatewayMethodMetadata

protected final GatewayMethodMetadata gatewayMethodMetadata

headerExpressions

protected final Map<String, Expression> headerExpressions

Constructor Details

GatewayProxySpec

protected GatewayProxySpec(Class<?> serviceInterface)

Method Details

beanName

public GatewayProxySpec beanName(@Nullable
 String beanName)

Specify a bean name for the target GatewayProxyFactoryBean.

Parameters:

beanName - the bean name to be used for registering bean for the gateway proxy

Returns:

current GatewayProxySpec.

replyChannel

public GatewayProxySpec replyChannel(String channelName)

Identifies the default channel the gateway proxy will subscribe to, to receive reply Messages, the payloads of which will be converted to the return type of the method signature.

Parameters:

channelName - the bean name for MessageChannel

Returns:

current GatewayProxySpec.

See Also:

• GatewayProxyFactoryBean.setDefaultReplyChannel(org.springframework.messaging.MessageChannel)

replyChannel

public GatewayProxySpec replyChannel(MessageChannel replyChannel)

Identifies the default channel the gateway proxy will subscribe to, to receive reply Messages, the payloads of which will be converted to the return type of the method signature.

Parameters:

replyChannel - the MessageChannel for replies.

Returns:

current GatewayProxySpec.

See Also:

• GatewayProxyFactoryBean.setDefaultReplyChannel(org.springframework.messaging.MessageChannel)

errorChannel

public GatewayProxySpec errorChannel(String errorChannelName)

Identifies a channel that error messages will be sent to if a failure occurs in the gateway's proxy invocation. If no errorChannel reference is provided, the gateway will propagate Exceptions to the caller. To completely suppress Exceptions, provide a reference to the nullChannel here.

Parameters:

errorChannelName - the bean name for MessageChannel

Returns:

current GatewayProxySpec.

See Also:

• GatewayProxyFactoryBean.setErrorChannel(org.springframework.messaging.MessageChannel)

errorChannel

public GatewayProxySpec errorChannel(MessageChannel errorChannel)

Identifies a channel that error messages will be sent to if a failure occurs in the gateway's proxy invocation. If no errorChannel reference is provided, the gateway will propagate Exceptions to the caller. To completely suppress Exceptions, provide a reference to the nullChannel here.

Parameters:

errorChannel - the MessageChannel for replies.

Returns:

current GatewayProxySpec.

See Also:

• GatewayProxyFactoryBean.setErrorChannel(org.springframework.messaging.MessageChannel)

requestTimeout

public GatewayProxySpec requestTimeout(long requestTimeout)

Provides the amount of time dispatcher would wait to send a Message. This timeout would only apply if there is a potential to block in the send call. For example if this gateway is hooked up to a QueueChannel. Value is specified in milliseconds.

Parameters:

requestTimeout - the timeout for requests in milliseconds.

Returns:

current GatewayProxySpec.

See Also:

• GatewayProxyFactoryBean.setDefaultRequestTimeout(java.lang.Long)

replyTimeout

public GatewayProxySpec replyTimeout(long replyTimeout)

Allows to specify how long this gateway will wait for the reply Message before returning. By default, it will wait 30 seconds. null is returned if the gateway times out. Value is specified in milliseconds.

Parameters:

replyTimeout - the timeout for replies in milliseconds.

Returns:

current GatewayProxySpec.

See Also:

• GatewayProxyFactoryBean.setDefaultReplyTimeout(java.lang.Long)

asyncExecutor

public GatewayProxySpec asyncExecutor(@Nullable
 Executor executor)

Provide a reference to an implementation of Executor to use for any of the interface methods that have a Future return type. This Executor will only be used for those async methods; the sync methods will be invoked in the caller's thread. Use null to specify no async executor - for example if your downstream flow returns a Future.

Parameters:

executor - the Executor to use.

Returns:

current GatewayProxySpec.

See Also:

• GatewayProxyFactoryBean.setAsyncExecutor(java.util.concurrent.Executor)

payloadExpression

public GatewayProxySpec payloadExpression(String expression)

An expression that will be used to generate the payload for all methods in the service interface unless explicitly overridden by a method declaration. The root object for evaluation context is MethodArgsHolder.

Parameters:

expression - the SpEL expression for default payload.

Returns:

current GatewayProxySpec.

See Also:

• MessagingGateway.defaultPayloadExpression()

payloadFunction

public GatewayProxySpec payloadFunction(Function<MethodArgsHolder, ?> defaultPayloadFunction)

A Function that will be used to generate the payload for all methods in the service interface unless explicitly overridden by a method declaration.

Parameters:

defaultPayloadFunction - the Function for default payload.

Returns:

current GatewayProxySpec.

See Also:

• MessagingGateway.defaultPayloadExpression()

payloadExpression

public GatewayProxySpec payloadExpression(Expression expression)

An expression that will be used to generate the payload for all methods in the service interface unless explicitly overridden by a method declaration. The root object for evaluation context is MethodArgsHolder. a bean resolver is also available, enabling expressions like @someBean(#args).

Parameters:

expression - the SpEL expression for default payload.

Returns:

current GatewayProxySpec.

See Also:

• MessagingGateway.defaultPayloadExpression()

header

public GatewayProxySpec header(String headerName,
 Object value)

Provides custom message header. The default headers are created for all methods on the service-interface (unless overridden by a specific method).

Parameters:

headerName - the name ofr the header.

value - the static value for the header.

Returns:

current GatewayProxySpec.

See Also:

• MessagingGateway.defaultHeaders()

header

public GatewayProxySpec header(String headerName,
 Function<MethodArgsHolder, ?> valueFunction)

Provides custom message header. The default headers are created for all methods on the service-interface (unless overridden by a specific method).

Parameters:

headerName - the name ofr the header.

valueFunction - the Function for the header value.

Returns:

current GatewayProxySpec.

See Also:

• MessagingGateway.defaultHeaders()

header

public GatewayProxySpec header(String headerName,
 Expression valueExpression)

Provides custom message header. The default headers are created for all methods on the service-interface (unless overridden by a specific method). This expression-based header can get access to the MethodArgsHolder as a root object for evaluation context.

Parameters:

headerName - the name ofr the header.

valueExpression - the SpEL expression for the header value.

Returns:

current GatewayProxySpec.

See Also:

• MessagingGateway.defaultHeaders()

mapper

public GatewayProxySpec mapper(MethodArgsMessageMapper mapper)

An MethodArgsMessageMapper to map the method arguments to a Message. When this is provided, no payload-expressions or headers are allowed; the custom mapper is responsible for creating the message.

Parameters:

mapper - the MethodArgsMessageMapper to use.

Returns:

current GatewayProxySpec.

See Also:

• GatewayProxyFactoryBean.setMapper(MethodArgsMessageMapper)

proxyDefaultMethods

public GatewayProxySpec proxyDefaultMethods(boolean proxyDefaultMethods)

Indicate if default methods on the interface should be proxied as well.

Parameters:

proxyDefaultMethods - the boolean flag to proxy default methods or invoke via MethodHandle.

Returns:

current GatewayProxySpec.

Since:

5.3

See Also:

• GatewayProxyFactoryBean.setProxyDefaultMethods(boolean)