Class MessagingGatewaySpec<S extends MessagingGatewaySpec<S,G>,G extends MessagingGatewaySupport>
java.lang.Object
org.springframework.beans.factory.config.AbstractFactoryBean<T>
org.springframework.integration.dsl.IntegrationComponentSpec<S,G>
org.springframework.integration.dsl.MessagingGatewaySpec<S,G>
- Type Parameters:
S- the targetMessagingGatewaySpecimplementation type.G- the targetMessagingGatewaySupportimplementation type.
- 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<G>,org.springframework.beans.factory.InitializingBean,org.springframework.context.Lifecycle,org.springframework.context.Phased,org.springframework.context.SmartLifecycle
public abstract class MessagingGatewaySpec<S extends MessagingGatewaySpec<S,G>,G extends MessagingGatewaySupport>
extends IntegrationComponentSpec<S,G>
- Since:
- 5.0
-
Field Summary
Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec
PARSER, targetFields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean
loggerFields inherited from interface org.springframework.beans.factory.FactoryBean
OBJECT_TYPE_ATTRIBUTEFields inherited from interface org.springframework.context.SmartLifecycle
DEFAULT_PHASE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionautoStartup(boolean autoStartup) An auto-startup flag.errorChannel(String errorChannelName) An error channel name to use.errorChannel(org.springframework.messaging.MessageChannel errorChannel) An error channel to use.errorOnTimeout(boolean errorOnTimeout) If errorOnTimeout is true, construct an instance that will send anErrorMessagewith aMessageTimeoutExceptionpayload to the error channel if a reply is expected but none is received.Configure the component identifier.phase(int phase) A lifecycle phase to use.replyChannel(String replyChannelName) A reply channel name to use.replyChannel(org.springframework.messaging.MessageChannel replyChannel) A reply channel to use.replyMapper(OutboundMessageMapper<?> replyMapper) AnOutboundMessageMapperto use.replyTimeout(long replyTimeout) A reply timeout to use.requestChannel(String requestChannelName) A request channel name to use.requestChannel(org.springframework.messaging.MessageChannel requestChannel) A request channel to use.requestMapper(InboundMessageMapper<?> requestMapper) AnInboundMessageMapperto use.requestTimeout(long requestTimeout) A request timeout to use.shouldTrack(boolean shouldTrack) Whether component should be tracked or not by message history.Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec
_this, createInstance, destroyInstance, doGet, get, getId, getObjectType, getPhase, isAutoStartup, isRunning, start, stop, stopMethods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean
afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton
-
Constructor Details
-
MessagingGatewaySpec
-
-
Method Details
-
id
Description copied from class:IntegrationComponentSpecConfigure the component identifier. Used as thebeanNameto register the bean in the application context for this component.- Overrides:
idin classIntegrationComponentSpec<S extends MessagingGatewaySpec<S,G>, G extends MessagingGatewaySupport> - Parameters:
id- the id.- Returns:
- the spec.
-
phase
A lifecycle phase to use.- Parameters:
phase- the phase.- Returns:
- the spec.
- See Also:
-
SmartLifecycle
-
autoStartup
An auto-startup flag.- Parameters:
autoStartup- the autoStartup.- Returns:
- the spec.
- See Also:
-
SmartLifecycle
-
replyChannel
A reply channel to use.- Parameters:
replyChannel- the replyChannel.- Returns:
- the spec.
- See Also:
-
replyChannel
A reply channel name to use.- Parameters:
replyChannelName- the name of replyChannel.- Returns:
- the spec.
- See Also:
-
requestChannel
A request channel to use.- Parameters:
requestChannel- the requestChannel.- Returns:
- the spec.
- See Also:
-
requestChannel
A request channel name to use.- Parameters:
requestChannelName- the name of requestChannel.- Returns:
- the spec.
- See Also:
-
errorChannel
An error channel to use.- Parameters:
errorChannel- the errorChannel.- Returns:
- the spec.
- See Also:
-
errorChannel
An error channel name to use.- Parameters:
errorChannelName- the name of errorChannel.- Returns:
- the spec.
- See Also:
-
requestTimeout
A request timeout to use.- Parameters:
requestTimeout- the requestTimeout.- Returns:
- the spec.
- See Also:
-
replyTimeout
A reply timeout to use.- Parameters:
replyTimeout- the replyTimeout.- Returns:
- the spec.
- See Also:
-
errorOnTimeout
If errorOnTimeout is true, construct an instance that will send anErrorMessagewith aMessageTimeoutExceptionpayload to the error channel if a reply is expected but none is received. If no error channel is configured, theMessageTimeoutExceptionwill be thrown.- Parameters:
errorOnTimeout- true to create the error message on reply timeout.- Returns:
- the spec
- Since:
- 5.2.2
- See Also:
-
requestMapper
AnInboundMessageMapperto use.- Parameters:
requestMapper- the requestMapper.- Returns:
- the spec.
- See Also:
-
replyMapper
AnOutboundMessageMapperto use.- Parameters:
replyMapper- the replyMapper.- Returns:
- the spec.
- See Also:
-
shouldTrack
Whether component should be tracked or not by message history.- Parameters:
shouldTrack- the tracking flag- Returns:
- the spec.
- Since:
- 5.0.2
- See Also:
-