Class SimpleWebServiceOutboundGateway

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractMessageProducingHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.integration.ws.outbound.AbstractWebServiceOutboundGateway

org.springframework.integration.ws.outbound.SimpleWebServiceOutboundGateway

All Implemented Interfaces:

org.reactivestreams.Subscriber<Message<?>>, Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ComponentSourceAware, ExpressionCapable, Orderable, MessageProducer, HeaderPropagationAware, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>

Direct Known Subclasses:

SimpleWebServiceOutboundGateway

public class SimpleWebServiceOutboundGateway
extends AbstractWebServiceOutboundGateway

An outbound Messaging Gateway for invoking a Web Service.

Since:

7.0

Author:

Mark Fisher, Oleg Zhurakousky, Artem Bilan, Gary Russell, Jooyoung Pyoung

Nested Class Summary

Nested classes/interfaces inherited from class AbstractWebServiceOutboundGateway

AbstractWebServiceOutboundGateway.RequestMessageCallback, AbstractWebServiceOutboundGateway.ResponseMessageExtractor

Nested classes/interfaces inherited from class AbstractReplyProducingMessageHandler

AbstractReplyProducingMessageHandler.RequestHandler

Nested classes/interfaces inherited from interface IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class AbstractWebServiceOutboundGateway

uriFactory

Fields inherited from class AbstractMessageProducingHandler

messagingTemplate

Fields inherited from class IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
SimpleWebServiceOutboundGateway(@Nullable String uri, @Nullable SourceExtractor<?> sourceExtractor, @Nullable WebServiceMessageFactory messageFactory)
SimpleWebServiceOutboundGateway(String uri)
SimpleWebServiceOutboundGateway(String uri, SourceExtractor<?> sourceExtractor)
SimpleWebServiceOutboundGateway(DestinationProvider destinationProvider)
SimpleWebServiceOutboundGateway(DestinationProvider destinationProvider, @Nullable SourceExtractor<?> sourceExtractor, @Nullable WebServiceMessageFactory messageFactory)
SimpleWebServiceOutboundGateway(DestinationProvider destinationProvider, SourceExtractor<?> sourceExtractor)

Method Summary

Modifier and Type	Method	Description
protected @Nullable Object	doHandle(String uri, Message<?> requestMessage, @Nullable WebServiceMessageCallback requestCallback)
String	getComponentType()
void	setExtractPayload(boolean extractPayload)	A flag to return the whole WebServiceMessage or build payload based on WebServiceMessage and populated headers according headerMapper configuration.

Methods inherited from class AbstractWebServiceOutboundGateway

doInit, doSetWebServiceTemplate, getWebServiceTemplate, handleRequestMessage, setEncodingMode, setFaultMessageResolver, setHeaderMapper, setIgnoreEmptyResponses, setInterceptors, setMessageFactory, setMessageSenders, setReplyChannel, setRequestCallback, setUriVariableExpressions, setWebServiceTemplate

Methods inherited from class AbstractReplyProducingMessageHandler

doInvokeAdvisedRequestHandler, getBeanClassLoader, getIntegrationPatternType, getRequiresReply, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReply

Methods inherited from class AbstractMessageProducingHandler

addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, produceOutput, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, setupMessageProcessor, shouldCopyRequestHeaders, shouldSplitOutput, updateNotPropagatedHeaders

Methods inherited from class AbstractMessageHandler

handleMessage, onComplete, onError, onNext, onSubscribe, setObservationConvention

Methods inherited from class MessageHandlerSupport

buildSendTimer, destroy, getManagedName, getManagedType, getMetricsCaptor, getObservationRegistry, getOrder, getOverrides, isLoggingEnabled, isObserved, registerMetricsCaptor, registerObservationRegistry, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack

Methods inherited from class IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class Object

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

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Methods inherited from interface IntegrationManagement

getThisAs

Methods inherited from interface NamedComponent

getBeanName, getComponentName

Constructor Details

SimpleWebServiceOutboundGateway

public SimpleWebServiceOutboundGateway(DestinationProvider destinationProvider)

SimpleWebServiceOutboundGateway

public SimpleWebServiceOutboundGateway(DestinationProvider destinationProvider,
 SourceExtractor<?> sourceExtractor)

SimpleWebServiceOutboundGateway

public SimpleWebServiceOutboundGateway(DestinationProvider destinationProvider,
 @Nullable SourceExtractor<?> sourceExtractor,
 @Nullable WebServiceMessageFactory messageFactory)

SimpleWebServiceOutboundGateway

public SimpleWebServiceOutboundGateway(String uri)

SimpleWebServiceOutboundGateway

public SimpleWebServiceOutboundGateway(String uri,
 SourceExtractor<?> sourceExtractor)

SimpleWebServiceOutboundGateway

public SimpleWebServiceOutboundGateway(@Nullable String uri,
 @Nullable SourceExtractor<?> sourceExtractor,
 @Nullable WebServiceMessageFactory messageFactory)

Method Details

setExtractPayload

public void setExtractPayload(boolean extractPayload)

A flag to return the whole WebServiceMessage or build payload based on WebServiceMessage and populated headers according headerMapper configuration. Defaults to extract payload.

Parameters:

extractPayload - build payload or return a whole WebServiceMessage

getComponentType

public String getComponentType()

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class MessageHandlerSupport

doHandle

protected @Nullable Object doHandle(String uri,
 Message<?> requestMessage,
 @Nullable WebServiceMessageCallback requestCallback)

Specified by:

doHandle in class AbstractWebServiceOutboundGateway