org.springframework.integration.ws

Class AbstractWebServiceOutboundGateway

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractMessageProducingHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.integration.ws.AbstractWebServiceOutboundGateway

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, ExpressionCapable, Orderable, MessageProducer, HeaderPropagationAware, NamedComponent, ConfigurableMetricsAware<AbstractMessageHandlerMetrics>, IntegrationManagement, IntegrationStatsManagement, MessageHandlerMetrics, TrackableComponent, org.springframework.messaging.MessageHandler

Direct Known Subclasses:

MarshallingWebServiceOutboundGateway, SimpleWebServiceOutboundGateway

public abstract class AbstractWebServiceOutboundGateway
extends AbstractReplyProducingMessageHandler

Base class for outbound Web Service-invoking Messaging Gateways.

Author:

Mark Fisher, Jonas Partner, Oleg Zhurakousky, Gary Russell, Artem Bilan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractWebServiceOutboundGateway.RequestMessageCallback
protected class	AbstractWebServiceOutboundGateway.ResponseMessageExtractor

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

AbstractReplyProducingMessageHandler.RequestHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected SoapHeaderMapper	headerMapper

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.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractWebServiceOutboundGateway(org.springframework.ws.client.support.destination.DestinationProvider destinationProvider, org.springframework.ws.WebServiceMessageFactory messageFactory)
AbstractWebServiceOutboundGateway(java.lang.String uri, org.springframework.ws.WebServiceMessageFactory messageFactory)

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.Object	doHandle(java.lang.String uri, org.springframework.messaging.Message<?> requestMessage, org.springframework.ws.client.core.WebServiceMessageCallback requestCallback)
protected void	doInit()
protected org.springframework.ws.client.core.WebServiceTemplate	getWebServiceTemplate()
java.lang.Object	handleRequestMessage(org.springframework.messaging.Message<?> requestMessage) Subclasses must implement this method to handle the request Message.
void	setEncodeUri(boolean encodeUri) Specify whether the URI should be encoded after any uriVariables are expanded and before sending the request.
void	setFaultMessageResolver(org.springframework.ws.client.core.FaultMessageResolver faultMessageResolver)
void	setHeaderMapper(SoapHeaderMapper headerMapper)
void	setIgnoreEmptyResponses(boolean ignoreEmptyResponses) Specify whether empty String response payloads should be ignored.
void	setInterceptors(org.springframework.ws.client.support.interceptor.ClientInterceptor... interceptors)
void	setMessageFactory(org.springframework.ws.WebServiceMessageFactory messageFactory)
void	setMessageSender(org.springframework.ws.transport.WebServiceMessageSender messageSender)
void	setMessageSenders(org.springframework.ws.transport.WebServiceMessageSender... messageSenders)
void	setReplyChannel(org.springframework.messaging.MessageChannel replyChannel)
void	setRequestCallback(org.springframework.ws.client.core.WebServiceMessageCallback requestCallback)
void	setUriVariableExpressions(java.util.Map<java.lang.String,org.springframework.expression.Expression> uriVariableExpressions) Set the Map of URI variable expressions to evaluate against the outbound message when replacing the variable placeholders in a URI template.

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

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

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

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

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

configureMetrics, getActiveCount, getActiveCountLong, getComponentType, getDuration, getErrorCount, getErrorCountLong, getHandleCount, getHandleCountLong, getManagedName, getManagedType, getMaxDuration, getMeanDuration, getMinDuration, getOrder, getStandardDeviationDuration, handleMessage, isCountsEnabled, isLoggingEnabled, isStatsEnabled, reset, setCountsEnabled, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, setStatsEnabled

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

afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, 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 org.springframework.integration.support.context.NamedComponent

getComponentName

Field Detail

headerMapper

protected volatile SoapHeaderMapper headerMapper

Constructor Detail

AbstractWebServiceOutboundGateway

public AbstractWebServiceOutboundGateway(java.lang.String uri,
                                         org.springframework.ws.WebServiceMessageFactory messageFactory)

AbstractWebServiceOutboundGateway

public AbstractWebServiceOutboundGateway(org.springframework.ws.client.support.destination.DestinationProvider destinationProvider,
                                         org.springframework.ws.WebServiceMessageFactory messageFactory)

Method Detail

setHeaderMapper

public void setHeaderMapper(SoapHeaderMapper headerMapper)

setUriVariableExpressions

public void setUriVariableExpressions(java.util.Map<java.lang.String,org.springframework.expression.Expression> uriVariableExpressions)

Set the Map of URI variable expressions to evaluate against the outbound message when replacing the variable placeholders in a URI template.

Parameters:

uriVariableExpressions - The URI variable expressions.

setEncodeUri

public void setEncodeUri(boolean encodeUri)

Specify whether the URI should be encoded after any uriVariables are expanded and before sending the request. The default value is true.

Parameters:

encodeUri - true if the URI should be encoded.

Since:

4.1

See Also:

UriComponentsBuilder

setReplyChannel

public void setReplyChannel(org.springframework.messaging.MessageChannel replyChannel)

setIgnoreEmptyResponses

public void setIgnoreEmptyResponses(boolean ignoreEmptyResponses)

Specify whether empty String response payloads should be ignored. The default is true. Set this to false if you want to send empty String responses in reply Messages.

Parameters:

ignoreEmptyResponses - true if empty responses should be ignored.

setMessageFactory

public void setMessageFactory(org.springframework.ws.WebServiceMessageFactory messageFactory)

setRequestCallback

public void setRequestCallback(org.springframework.ws.client.core.WebServiceMessageCallback requestCallback)

setFaultMessageResolver

public void setFaultMessageResolver(org.springframework.ws.client.core.FaultMessageResolver faultMessageResolver)

setMessageSender

public void setMessageSender(org.springframework.ws.transport.WebServiceMessageSender messageSender)

setMessageSenders

public void setMessageSenders(org.springframework.ws.transport.WebServiceMessageSender... messageSenders)

setInterceptors

public void setInterceptors(org.springframework.ws.client.support.interceptor.ClientInterceptor... interceptors)

doInit

protected void doInit()

Overrides:

doInit in class AbstractReplyProducingMessageHandler

getWebServiceTemplate

protected org.springframework.ws.client.core.WebServiceTemplate getWebServiceTemplate()

handleRequestMessage

public final java.lang.Object handleRequestMessage(org.springframework.messaging.Message<?> requestMessage)

Description copied from class: AbstractReplyProducingMessageHandler

Subclasses must implement this method to handle the request Message. The return value may be a Message, a MessageBuilder, or any plain Object. The base class will handle the final creation of a reply Message from any of those starting points. If the return value is null, the Message flow will end here.

Specified by:

handleRequestMessage in class AbstractReplyProducingMessageHandler

Parameters:

requestMessage - The request message.

Returns:

The result of handling the message, or null.

doHandle

protected abstract java.lang.Object doHandle(java.lang.String uri,
                                             org.springframework.messaging.Message<?> requestMessage,
                                             org.springframework.ws.client.core.WebServiceMessageCallback requestCallback)