Package org.apache.camel.component.spring.ws

Class SpringWebserviceConfiguration

  • @UriParams
public class SpringWebserviceConfiguration
extends Object

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

      • 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).

      • 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().

      • 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)

      • setEndpointMappingType

        public void setEndpointMappingType​(EndpointMappingType endpointMappingType)
        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

      • getEndpointMappingLookupKey

        public String getEndpointMappingLookupKey()

      • setEndpointMappingLookupKey

        public void setEndpointMappingLookupKey​(String endpointMappingLookupKey)
        Endpoint mapping key if endpoint mapping is used

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

      • getxPathExpression

        public org.springframework.xml.xpath.XPathExpression getxPathExpression()

      • setxPathExpression

        public void setxPathExpression​(org.springframework.xml.xpath.XPathExpression xPathExpression)

      • getSslContextParameters

        public org.apache.camel.support.jsse.SSLContextParameters getSslContextParameters()

      • setSslContextParameters

        public void setSslContextParameters​(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
        To configure security using SSLContextParameters

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

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

      • 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 org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details.

      • 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. See org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details.
        Throws:
        URISyntaxException

      • 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 org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details.

      • 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. See org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details.
        Throws:
        URISyntaxException

      • setFaultTo

        public void setFaultTo​(URI faultTo)
        Signifies the value for the faultAction response WS-Addressing FaultTo header that is provided by the method. See org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details.

      • 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. See org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details.
        Throws:
        URISyntaxException

      • setReplyTo

        public void setReplyTo​(URI replyToAction)
        Signifies the value for the replyTo response WS-Addressing ReplyTo header that is provided by the method. See org.springframework.ws.soap.addressing.server.annotation.Action annotation for more details.

      • 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 WS-Addressing 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

      • 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