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<org.springframework.messaging.Message<?>>, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, org.springframework.integration.context.ExpressionCapable, org.springframework.integration.context.Orderable, org.springframework.integration.core.MessageProducer, org.springframework.integration.handler.HeaderPropagationAware, org.springframework.integration.IntegrationPattern, org.springframework.integration.support.context.NamedComponent, org.springframework.integration.support.management.IntegrationManagement, org.springframework.integration.support.management.TrackableComponent, org.springframework.messaging.MessageHandler, reactor.core.CoreSubscriber<org.springframework.messaging.Message<?>>
public class SimpleWebServiceOutboundGateway extends AbstractWebServiceOutboundGateway
An outbound Messaging Gateway for invoking a Web Service.

  • 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

    org.springframework.integration.handler.AbstractReplyProducingMessageHandler.RequestHandler

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

    org.springframework.integration.support.management.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(String uri)
     
    SimpleWebServiceOutboundGateway(String uri, org.springframework.ws.client.core.SourceExtractor<?> sourceExtractor)
     
    SimpleWebServiceOutboundGateway(String uri, org.springframework.ws.client.core.SourceExtractor<?> sourceExtractor, org.springframework.ws.WebServiceMessageFactory messageFactory)
     
    SimpleWebServiceOutboundGateway(org.springframework.ws.client.support.destination.DestinationProvider destinationProvider)
     
    SimpleWebServiceOutboundGateway(org.springframework.ws.client.support.destination.DestinationProvider destinationProvider, org.springframework.ws.client.core.SourceExtractor<?> sourceExtractor)
     
    SimpleWebServiceOutboundGateway(org.springframework.ws.client.support.destination.DestinationProvider destinationProvider, org.springframework.ws.client.core.SourceExtractor<?> sourceExtractor, org.springframework.ws.WebServiceMessageFactory messageFactory)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected Object
    doHandle(String uri, org.springframework.messaging.Message<?> requestMessage, org.springframework.ws.client.core.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 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, 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, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, 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 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(org.springframework.ws.client.support.destination.DestinationProvider destinationProvider)

    • SimpleWebServiceOutboundGateway

      public SimpleWebServiceOutboundGateway(org.springframework.ws.client.support.destination.DestinationProvider destinationProvider, org.springframework.ws.client.core.SourceExtractor<?> sourceExtractor)

    • SimpleWebServiceOutboundGateway

      public SimpleWebServiceOutboundGateway(org.springframework.ws.client.support.destination.DestinationProvider destinationProvider, org.springframework.ws.client.core.SourceExtractor<?> sourceExtractor, org.springframework.ws.WebServiceMessageFactory messageFactory)

    • SimpleWebServiceOutboundGateway

      public SimpleWebServiceOutboundGateway(String uri)

    • SimpleWebServiceOutboundGateway

      public SimpleWebServiceOutboundGateway(String uri, org.springframework.ws.client.core.SourceExtractor<?> sourceExtractor)

    • SimpleWebServiceOutboundGateway

      public SimpleWebServiceOutboundGateway(String uri, org.springframework.ws.client.core.SourceExtractor<?> sourceExtractor, org.springframework.ws.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()
      Specified by:
      getComponentType in interface org.springframework.integration.support.context.NamedComponent
      Overrides:
      getComponentType in class org.springframework.integration.handler.MessageHandlerSupport

    • doHandle

      protected Object doHandle(String uri, org.springframework.messaging.Message<?> requestMessage, org.springframework.ws.client.core.WebServiceMessageCallback requestCallback)
      Specified by:
      doHandle in class AbstractWebServiceOutboundGateway