SpringWebserviceConfiguration (Camel :: Spring Web Services 2.21.2 API)

java.lang.Object
- org.apache.camel.component.spring.ws.SpringWebserviceConfiguration

@UriParams
public class SpringWebserviceConfiguration
extends Object

Constructor Summary

Constructors
Constructor and Description

SpringWebserviceConfiguration()

Constructors
Constructor and Description
`SpringWebserviceConfiguration()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`decode(String uri)`
`static String`	`encode(String uri)`
`CamelEndpointDispatcher`	`getEndpointDispatcher()`
`CamelSpringWSEndpointMapping`	`getEndpointMapping()`
`EndpointMappingKey`	`getEndpointMappingKey()`
`String`	`getEndpointUri()`
`String`	`getExpression()`
`URI`	`getFaultAction()`
`URI`	`getFaultTo()`
`org.springframework.ws.WebServiceMessageFactory`	`getMessageFactory()`
`MessageFilter`	`getMessageFilter()`
`org.springframework.ws.soap.addressing.messageid.MessageIdStrategy`	`getMessageIdStrategy()`
`org.springframework.ws.transport.WebServiceMessageSender`	`getMessageSender()`
`URI`	`getOutputAction()`
`URI`	`getReplyTo()`
`String`	`getSoapAction()`
`org.apache.camel.util.jsse.SSLContextParameters`	`getSslContextParameters()`
`int`	`getTimeout()`
`String`	`getWebServiceEndpointUri()`
`org.springframework.ws.client.core.WebServiceTemplate`	`getWebServiceTemplate()`
`URI`	`getWsAddressingAction()`
`org.apache.camel.converter.jaxp.XmlConverter`	`getXmlConverter()`
`boolean`	`isAllowResponseAttachmentOverride()`
`boolean`	`isAllowResponseHeaderOverride()`
`void`	`setAllowResponseAttachmentOverride(boolean allowResponseAttachmentOverride)` Option to override soap response attachments in in/out exchange with attachments from the actual service layer.
`void`	`setAllowResponseHeaderOverride(boolean allowResponseHeaderOverride)` Option to override soap response header in in/out exchange with header info from the actual service layer.
`void`	`setEndpointDispatcher(CamelEndpointDispatcher endpointDispatcher)` Spring `MessageEndpoint` for dispatching messages received by Spring-WS to a Camel endpoint, to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping, SoapActionEndpointMapping, etc.
`void`	`setEndpointMapping(CamelSpringWSEndpointMapping endpointMapping)` Reference to an instance of org.apache.camel.component.spring.ws.bean.CamelEndpointMapping in the Registry/ApplicationContext.
`void`	`setEndpointMappingKey(EndpointMappingKey endpointMappingKey)`
`void`	`setExpression(String expression)` The XPath expression to use when option type=xpathresult.
`void`	`setFaultAction(String fault)` Signifies the value for the faultAction response WS-Addressing `Fault Action` header that is provided by the method.
`void`	`setFaultAction(URI fault)` Signifies the value for the faultAction response WS-Addressing `Fault Action` header that is provided by the method.
`void`	`setFaultTo(String faultTo)` Signifies the value for the faultAction response WS-Addressing `FaultTo` header that is provided by the method.
`void`	`setFaultTo(URI faultTo)` Signifies the value for the faultAction response WS-Addressing `FaultTo` header that is provided by the method.
`void`	`setMessageFactory(org.springframework.ws.WebServiceMessageFactory messageFactory)` Option to provide a custom WebServiceMessageFactory.
`void`	`setMessageFilter(MessageFilter messageFilter)` Option to provide a custom MessageFilter.
`void`	`setMessageIdStrategy(org.springframework.ws.soap.addressing.messageid.MessageIdStrategy messageIdStrategy)` Option to provide a custom MessageIdStrategy to control generation of unique message ids.
`void`	`setMessageSender(org.springframework.ws.transport.WebServiceMessageSender messageSender)` Option to provide a custom WebServiceMessageSender.
`void`	`setOutputAction(String output)`
`void`	`setOutputAction(URI outputAction)` Signifies the value for the response WS-Addressing `Action` header that is provided by the method.
`void`	`setReplyTo(String replyToAction)` Signifies the value for the replyTo response WS-Addressing `ReplyTo` header that is provided by the method.
`void`	`setReplyTo(URI replyToAction)` Signifies the value for the replyTo response WS-Addressing `ReplyTo` header that is provided by the method.
`void`	`setSoapAction(String soapAction)` SOAP action to include inside a SOAP request when accessing remote web services
`void`	`setSslContextParameters(org.apache.camel.util.jsse.SSLContextParameters sslContextParameters)` To configure security using SSLContextParameters
`void`	`setTimeout(int timeout)` Sets the socket read timeout (in milliseconds) while invoking a webservice using the producer, see URLConnection.setReadTimeout() and CommonsHttpMessageSender.setReadTimeout().
`void`	`setWebServiceEndpointUri(String webServiceEndpointUri)` The default Web Service endpoint uri to use for the producer.
`void`	`setWebServiceTemplate(org.springframework.ws.client.core.WebServiceTemplate webServiceTemplate)` Option to provide a custom WebServiceTemplate.
`void`	`setWsAddressingAction(String wsAddressingAction)`
`void`	`setWsAddressingAction(URI wsAddressingAction)` WS-Addressing 1.0 action header to include when accessing web services.
`void`	`setXmlConverter(org.apache.camel.converter.jaxp.XmlConverter xmlConverter)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SpringWebserviceConfiguration
```
public SpringWebserviceConfiguration()
```
- Method Detail
  - getWebServiceTemplate
```
public org.springframework.ws.client.core.WebServiceTemplate getWebServiceTemplate()
```
  - setWebServiceTemplate
```
public void setWebServiceTemplate(org.springframework.ws.client.core.WebServiceTemplate 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.
  - getMessageFactory
```
public org.springframework.ws.WebServiceMessageFactory getMessageFactory()
```
  - setMessageFactory
```
public void setMessageFactory(org.springframework.ws.WebServiceMessageFactory messageFactory)
```
    Option to provide a custom WebServiceMessageFactory. For example when you want Apache Axiom to handle web service messages instead of SAAJ.
  - getWebServiceEndpointUri
```
public String getWebServiceEndpointUri()
```
  - setWebServiceEndpointUri
```
public void setWebServiceEndpointUri(String webServiceEndpointUri)
```
    The default Web Service endpoint uri to use for the producer.
  - getExpression
```
public String getExpression()
```
  - setExpression
```
public void setExpression(String expression)
```
    The XPath expression to use when option type=xpathresult. Then this option is required to be configured.
  - getSoapAction
```
public String getSoapAction()
```
  - setSoapAction
```
public void setSoapAction(String soapAction)
```
    SOAP action to include inside a SOAP request when accessing remote web services
  - getEndpointUri
```
public String getEndpointUri()
```
  - getWsAddressingAction
```
public URI getWsAddressingAction()
```
  - setWsAddressingAction
```
public void setWsAddressingAction(URI wsAddressingAction)
```
    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).
  - setWsAddressingAction
```
public void setWsAddressingAction(String wsAddressingAction)
                           throws URISyntaxException
```
    Throws:
    
    URISyntaxException
  - getTimeout
```
public int getTimeout()
```
  - setTimeout
```
public void setTimeout(int timeout)
```
    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().
  - getEndpointMapping
```
public CamelSpringWSEndpointMapping getEndpointMapping()
```
  - setEndpointMapping
```
public void setEndpointMapping(CamelSpringWSEndpointMapping endpointMapping)
```
    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)
  - getEndpointMappingKey
```
public EndpointMappingKey getEndpointMappingKey()
```
  - setEndpointMappingKey
```
public void setEndpointMappingKey(EndpointMappingKey endpointMappingKey)
```
  - getSslContextParameters
```
public org.apache.camel.util.jsse.SSLContextParameters getSslContextParameters()
```
  - setSslContextParameters
```
public void setSslContextParameters(org.apache.camel.util.jsse.SSLContextParameters sslContextParameters)
```
    To configure security using SSLContextParameters
  - getEndpointDispatcher
```
public CamelEndpointDispatcher getEndpointDispatcher()
```
  - setEndpointDispatcher
```
public void setEndpointDispatcher(CamelEndpointDispatcher endpointDispatcher)
```
    Spring MessageEndpoint for dispatching messages received by Spring-WS to a Camel endpoint, to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping, SoapActionEndpointMapping, etc.
  - getXmlConverter
```
public org.apache.camel.converter.jaxp.XmlConverter getXmlConverter()
```
  - setXmlConverter
```
public void setXmlConverter(org.apache.camel.converter.jaxp.XmlConverter xmlConverter)
```
  - encode
```
public static String encode(String uri)
```
  - decode
```
public static String decode(String uri)
```
  - setMessageFilter
```
public void setMessageFilter(MessageFilter messageFilter)
```
    Option to provide a custom MessageFilter. For example when you want to process your headers or attachments by your own.
  - getMessageFilter
```
public MessageFilter getMessageFilter()
```
  - getOutputAction
```
public URI getOutputAction()
```
  - setOutputAction
```
public void setOutputAction(URI outputAction)
```
    Signifies the value for the response WS-Addressing Action header that is provided by the method.
    
    See Also:
    
    Action}
  - setOutputAction
```
public void setOutputAction(String output)
                     throws URISyntaxException
```
    Throws:
    
    URISyntaxException
  - getFaultAction
```
public URI getFaultAction()
```
  - setFaultAction
```
public void setFaultAction(String fault)
                    throws URISyntaxException
```
    Signifies the value for the faultAction response WS-Addressing Fault Action header that is provided by the method.
    
    Throws:
    
    URISyntaxException
    
    See Also:
    
    Action}
  - setFaultAction
```
public void setFaultAction(URI fault)
```
    Signifies the value for the faultAction response WS-Addressing Fault Action header that is provided by the method.
    
    See Also:
    
    Action}
  - getFaultTo
```
public URI getFaultTo()
```
  - setFaultTo
```
public void setFaultTo(String faultTo)
                throws URISyntaxException
```
    Signifies the value for the faultAction response WS-Addressing FaultTo header that is provided by the method.
    
    Throws:
    
    URISyntaxException
    
    See Also:
    
    Action}
  - setFaultTo
```
public void setFaultTo(URI faultTo)
```
    Signifies the value for the faultAction response WS-Addressing FaultTo header that is provided by the method.
    
    See Also:
    
    Action}
  - getReplyTo
```
public URI getReplyTo()
```
  - setReplyTo
```
public void setReplyTo(String replyToAction)
                throws URISyntaxException
```
    Signifies the value for the replyTo response WS-Addressing ReplyTo header that is provided by the method.
    
    Throws:
    
    URISyntaxException
    
    See Also:
    
    Action}
  - setReplyTo
```
public void setReplyTo(URI replyToAction)
```
    Signifies the value for the replyTo response WS-Addressing ReplyTo header that is provided by the method.
    
    See Also:
    
    Action}
  - getMessageSender
```
public org.springframework.ws.transport.WebServiceMessageSender getMessageSender()
```
  - setMessageSender
```
public void setMessageSender(org.springframework.ws.transport.WebServiceMessageSender messageSender)
```
    Option to provide a custom WebServiceMessageSender. For example to perform authentication or use alternative transports
  - getMessageIdStrategy
```
public org.springframework.ws.soap.addressing.messageid.MessageIdStrategy getMessageIdStrategy()
```
  - setMessageIdStrategy
```
public void setMessageIdStrategy(org.springframework.ws.soap.addressing.messageid.MessageIdStrategy messageIdStrategy)
```
    Option to provide a custom MessageIdStrategy to control generation of unique message ids.
  - isAllowResponseHeaderOverride
```
public boolean isAllowResponseHeaderOverride()
```
  - setAllowResponseHeaderOverride
```
public void setAllowResponseHeaderOverride(boolean allowResponseHeaderOverride)
```
    Option to override soap response header in in/out exchange with header info from the actual service layer. If the invoked service appends or rewrites the soap header this option when set to true, allows the modified soap header to be overwritten in in/out message headers
    
    Parameters:
    
    allowResponseHeaderOverride - - true, will override header with spring-ws response message header
  - isAllowResponseAttachmentOverride
```
public boolean isAllowResponseAttachmentOverride()
```
  - setAllowResponseAttachmentOverride
```
public void setAllowResponseAttachmentOverride(boolean allowResponseAttachmentOverride)
```
    Option to override soap response attachments in in/out exchange with attachments from the actual service layer. If the invoked service appends or rewrites the soap attachments this option when set to true, allows the modified soap attachments to be overwritten in in/out message attachments
    
    Parameters:
    
    allowResponseAttachmentOverride - - true, will override attachments with spring-ws response message attachments

Class SpringWebserviceConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SpringWebserviceConfiguration

Method Detail

getWebServiceTemplate

setWebServiceTemplate

getMessageFactory

setMessageFactory

getWebServiceEndpointUri

setWebServiceEndpointUri

getExpression

setExpression

getSoapAction

setSoapAction

getEndpointUri

getWsAddressingAction

setWsAddressingAction

setWsAddressingAction

getTimeout

setTimeout

getEndpointMapping

setEndpointMapping

getEndpointMappingKey

setEndpointMappingKey

getSslContextParameters

setSslContextParameters

getEndpointDispatcher

setEndpointDispatcher

getXmlConverter

setXmlConverter

encode

decode

setMessageFilter

getMessageFilter

getOutputAction

setOutputAction

setOutputAction

getFaultAction

setFaultAction

setFaultAction

getFaultTo

setFaultTo

setFaultTo

getReplyTo

setReplyTo

setReplyTo

getMessageSender

setMessageSender

getMessageIdStrategy

setMessageIdStrategy

isAllowResponseHeaderOverride

setAllowResponseHeaderOverride

isAllowResponseAttachmentOverride

setAllowResponseAttachmentOverride