Package org.springframework.integration.ws

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.AbstractWebServiceOutboundGateway

org.springframework.integration.ws.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<?>>

public class SimpleWebServiceOutboundGateway
extends AbstractWebServiceOutboundGateway

An outbound Messaging Gateway for invoking a Web Service.

Author:

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

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.ws.AbstractWebServiceOutboundGateway

AbstractWebServiceOutboundGateway.RequestMessageCallback, AbstractWebServiceOutboundGateway.ResponseMessageExtractor

Nested classes/interfaces inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

AbstractReplyProducingMessageHandler.RequestHandler

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.ws.AbstractWebServiceOutboundGateway

uriFactory

Fields inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

messagingTemplate

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface org.springframework.core.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()	Subclasses may implement this method to provide component type information.
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 org.springframework.integration.ws.AbstractWebServiceOutboundGateway

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

Methods inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

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

Methods inherited from class org.springframework.integration.handler.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 org.springframework.integration.handler.AbstractMessageHandler

handleMessage, onComplete, onError, onNext, onSubscribe, setObservationConvention

Methods inherited from class org.springframework.integration.handler.MessageHandlerSupport

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

Methods inherited from class org.springframework.integration.context.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 java.lang.Object

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

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Methods inherited from interface org.springframework.integration.support.management.IntegrationManagement

getThisAs

Methods inherited from interface org.springframework.integration.support.context.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

Since:

5.0

getComponentType

public String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

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