Spring WebService

Spring WebService

Scheme: spring-ws
Syntax: spring-ws:type:lookupKey:webServiceEndpointUri
Description: The spring-ws component is used for SOAP WebServices using Spring WebServices.
Deprecated:false
Async:false
Maven: org.apache.camel/camel-spring-ws/2.18.1.redhat-000034

The spring-ws component is used for SOAP WebServices using Spring WebServices.

Name Kind Group Required Default Type Enum Description
type path consumer org.apache.camel.component.spring.ws.type.EndpointMappingType ROOT_QNAME
ACTION
TO
SOAP_ACTION
XPATHRESULT
URI
URI_PATH
BEANNAME
Endpoint mapping type if endpoint mapping is used.
  • rootqname - Offers the option to map web service requests based on the qualified name of the root element contained in the message.
  • soapaction - Used to map web service requests based on the SOAP action specified in the header of the message.
  • uri - In order to map web service requests that target a specific URI.
  • xpathresult - Used to map web service requests based on the evaluation of an XPath expression against the incoming message. The result of the evaluation should match the XPath result specified in the endpoint URI.
  • beanname - Allows you to reference an org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher object in order to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping, SoapActionEndpointMapping, etc
lookupKey path consumer java.lang.String Endpoint mapping key if endpoint mapping is used
webServiceEndpointUri path producer java.lang.String The default Web Service endpoint uri to use for the producer.
messageFilter parameter common org.apache.camel.component.spring.ws.filter.MessageFilter Option to provide a custom MessageFilter. For example when you want to process your headers or attachments by your own.
bridgeErrorHandler parameter consumer boolean Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN/ERROR level and ignored.
endpointDispatcher parameter consumer org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher Spring {@link org.springframework.ws.server.endpoint.MessageEndpoint} for dispatching messages received by Spring-WS to a Camel endpoint, to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping, SoapActionEndpointMapping, etc.
endpointMapping parameter consumer org.apache.camel.component.spring.ws.bean.CamelSpringWSEndpointMapping Reference to an instance of org.apache.camel.component.spring.ws.bean.CamelEndpointMapping in the Registry/ApplicationContext. Only one bean is required in the registry to serve all Camel/Spring-WS endpoints. This bean is auto-discovered by the MessageDispatcher and used to map requests to Camel endpoints based on characteristics specified on the endpoint (like root QName, SOAP action, etc)
expression parameter consumer java.lang.String The XPath expression to use when option type=xpathresult. Then this option is required to be configured.
sslContextParameters parameter consumer org.apache.camel.util.jsse.SSLContextParameters To configure security using SSLContextParameters
exceptionHandler parameter consumer (advanced) org.apache.camel.spi.ExceptionHandler To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored.
exchangePattern parameter consumer (advanced) org.apache.camel.ExchangePattern InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the exchange pattern when the consumer creates an exchange.
faultAction parameter producer java.net.URI Signifies the value for the faultAction response WS-Addressing Fault Action header that is provided by the method. @see {@link Action}
faultTo parameter producer java.net.URI Signifies the value for the faultAction response WS-Addressing FaultTo header that is provided by the method. @see {@link Action}
messageFactory parameter producer org.springframework.ws.WebServiceMessageFactory Option to provide a custom WebServiceMessageFactory. For example when you want Apache Axiom to handle web service messages instead of SAAJ.
messageIdStrategy parameter producer org.springframework.ws.soap.addressing.messageid.MessageIdStrategy Option to provide a custom MessageIdStrategy to control generation of unique message ids.
messageSender parameter producer org.springframework.ws.transport.WebServiceMessageSender Option to provide a custom WebServiceMessageSender. For example to perform authentication or use alternative transports
outputAction parameter producer java.net.URI Signifies the value for the response WS-Addressing Action header that is provided by the method. @see {@link Action}
replyTo parameter producer java.net.URI Signifies the value for the replyTo response WS-Addressing ReplyTo header that is provided by the method. @see {@link Action}
soapAction parameter producer java.lang.String SOAP action to include inside a SOAP request when accessing remote web services
timeout parameter producer int Sets the socket read timeout (in milliseconds) while invoking a webservice using the producer, see URLConnection.setReadTimeout() and CommonsHttpMessageSender.setReadTimeout(). This option works when using the built-in message sender implementations: CommonsHttpMessageSender and HttpUrlConnectionMessageSender. One of these implementations will be used by default for HTTP based services unless you customize the Spring WS configuration options supplied to the component. If you are using a non-standard sender, it is assumed that you will handle your own timeout configuration. The built-in message sender HttpComponentsMessageSender is considered instead of CommonsHttpMessageSender which has been deprecated, see HttpComponentsMessageSender.setReadTimeout().
webServiceTemplate parameter producer org.springframework.ws.client.core.WebServiceTemplate Option to provide a custom WebServiceTemplate. This allows for full control over client-side web services handling; like adding a custom interceptor or specifying a fault resolver, message sender or message factory.
wsAddressingAction parameter producer java.net.URI WS-Addressing 1.0 action header to include when accessing web services. The To header is set to the address of the web service as specified in the endpoint URI (default Spring-WS behavior).
synchronous parameter advanced false boolean Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

spring-ws consumer