Class GatewayEndpointSpec

java.lang.Object

org.springframework.integration.dsl.IntegrationComponentSpec<GatewayEndpointSpec, reactor.util.function.Tuple2<ConsumerEndpointFactoryBean, GatewayMessageHandler>>

org.springframework.integration.dsl.EndpointSpec<GatewayEndpointSpec, ConsumerEndpointFactoryBean, GatewayMessageHandler>

org.springframework.integration.dsl.ConsumerEndpointSpec<GatewayEndpointSpec, GatewayMessageHandler>

org.springframework.integration.dsl.GatewayEndpointSpec

All Implemented Interfaces:

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

public class GatewayEndpointSpec
extends ConsumerEndpointSpec<GatewayEndpointSpec, GatewayMessageHandler>

A ConsumerEndpointSpec implementation for a mid-flow GatewayMessageHandler.

Since:

5.0

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	GatewayEndpointSpec(String requestChannel)
protected	GatewayEndpointSpec(MessageChannel requestChannel)

Method Summary

Modifier and Type	Method	Description
GatewayEndpointSpec	asyncExecutor(@Nullable Executor executor)	Set an Executor for async request-reply scenarios.
GatewayEndpointSpec	errorChannel(String errorChannel)	Set an error channel.
GatewayEndpointSpec	errorChannel(MessageChannel errorChannel)	Set an error channel.
GatewayEndpointSpec	errorOnTimeout(boolean errorOnTimeout)	Set a error on timeout flag.
GatewayEndpointSpec	replyChannel(String replyChannel)	Set a reply channel.
GatewayEndpointSpec	replyChannel(MessageChannel replyChannel)	Set a reply channel.
GatewayEndpointSpec	replyTimeout(Long replyTimeout)	Set a reply timeout.
GatewayEndpointSpec	requestTimeout(Long requestTimeout)	Set a request timeout.

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

getComponentsToRegister, 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

Methods inherited from interface org.springframework.context.SmartLifecycle

isPauseable

Constructor Details

GatewayEndpointSpec

protected GatewayEndpointSpec(MessageChannel requestChannel)

GatewayEndpointSpec

protected GatewayEndpointSpec(String requestChannel)

Method Details

replyChannel

public GatewayEndpointSpec replyChannel(MessageChannel replyChannel)

Set a reply channel.

Parameters:

replyChannel - the reply channel

Returns:

the spec

replyChannel

public GatewayEndpointSpec replyChannel(String replyChannel)

Set a reply channel.

Parameters:

replyChannel - the reply channel

Returns:

the spec

errorChannel

public GatewayEndpointSpec errorChannel(MessageChannel errorChannel)

Set an error channel.

Parameters:

errorChannel - the error channel

Returns:

the spec

errorChannel

public GatewayEndpointSpec errorChannel(String errorChannel)

Set an error channel.

Parameters:

errorChannel - the error channel

Returns:

the spec

requestTimeout

public GatewayEndpointSpec requestTimeout(Long requestTimeout)

Set a request timeout.

Parameters:

requestTimeout - the request timeout

Returns:

the spec

replyTimeout

public GatewayEndpointSpec replyTimeout(Long replyTimeout)

Set a reply timeout.

Parameters:

replyTimeout - the reply timeout

Returns:

the spec

errorOnTimeout

public GatewayEndpointSpec errorOnTimeout(boolean errorOnTimeout)

Set a error on timeout flag.

Parameters:

errorOnTimeout - true to produce an error in case of a reply timeout.

Returns:

the spec.

Since:

6.2

See Also:

• GatewayProxyFactoryBean.setErrorOnTimeout(boolean)

asyncExecutor

public GatewayEndpointSpec asyncExecutor(@Nullable Executor executor)

Set an Executor for async request-reply scenarios.

Parameters:

executor - the executor to use.

Returns:

the spec.

Since:

6.5

See Also:

• GatewayProxyFactoryBean.setAsyncExecutor(Executor)