org.apache.camel.builder.endpoint.dsl

Interface SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointBuilder

Enclosing interface:

SpringWebserviceEndpointBuilderFactory

public static interface SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the Spring WebService component.

Method Summary

Modifier and Type	Method and Description
default SpringWebserviceEndpointBuilderFactory.AdvancedSpringWebserviceEndpointProducerBuilder	advanced()
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	allowResponseAttachmentOverride(boolean allowResponseAttachmentOverride) Option to override soap response attachments in in/out exchange with attachments from the actual service layer.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	allowResponseAttachmentOverride(String allowResponseAttachmentOverride) Option to override soap response attachments in in/out exchange with attachments from the actual service layer.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	allowResponseHeaderOverride(boolean allowResponseHeaderOverride) Option to override soap response header in in/out exchange with header info from the actual service layer.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	allowResponseHeaderOverride(String allowResponseHeaderOverride) Option to override soap response header in in/out exchange with header info from the actual service layer.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	faultAction(String faultAction) Signifies the value for the faultAction response WS-Addressing Fault Action header that is provided by the method.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	faultAction(URI faultAction) Signifies the value for the faultAction response WS-Addressing Fault Action header that is provided by the method.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	faultTo(String faultTo) Signifies the value for the faultAction response WS-Addressing FaultTo header that is provided by the method.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	faultTo(URI faultTo) Signifies the value for the faultAction response WS-Addressing FaultTo header that is provided by the method.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	messageFactory(Object messageFactory) Option to provide a custom WebServiceMessageFactory.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	messageFactory(String messageFactory) Option to provide a custom WebServiceMessageFactory.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	messageFilter(Object messageFilter) Option to provide a custom MessageFilter.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	messageFilter(String messageFilter) Option to provide a custom MessageFilter.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	messageIdStrategy(Object messageIdStrategy) Option to provide a custom MessageIdStrategy to control generation of WS-Addressing unique message ids.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	messageIdStrategy(String messageIdStrategy) Option to provide a custom MessageIdStrategy to control generation of WS-Addressing unique message ids.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	messageSender(Object messageSender) Option to provide a custom WebServiceMessageSender.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	messageSender(String messageSender) Option to provide a custom WebServiceMessageSender.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	outputAction(String outputAction) Signifies the value for the response WS-Addressing Action header that is provided by the method.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	outputAction(URI outputAction) Signifies the value for the response WS-Addressing Action header that is provided by the method.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	replyTo(String replyTo) Signifies the value for the replyTo response WS-Addressing ReplyTo header that is provided by the method.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	replyTo(URI replyTo) Signifies the value for the replyTo response WS-Addressing ReplyTo header that is provided by the method.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	soapAction(String soapAction) SOAP action to include inside a SOAP request when accessing remote web services.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	sslContextParameters(Object sslContextParameters) To configure security using SSLContextParameters.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	sslContextParameters(String sslContextParameters) To configure security using SSLContextParameters.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	timeout(int timeout) Sets the socket read timeout (in milliseconds) while invoking a webservice using the producer, see URLConnection.setReadTimeout() and CommonsHttpMessageSender.setReadTimeout().
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	timeout(String timeout) Sets the socket read timeout (in milliseconds) while invoking a webservice using the producer, see URLConnection.setReadTimeout() and CommonsHttpMessageSender.setReadTimeout().
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	webServiceTemplate(Object webServiceTemplate) Option to provide a custom WebServiceTemplate.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	webServiceTemplate(String webServiceTemplate) Option to provide a custom WebServiceTemplate.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	wsAddressingAction(String wsAddressingAction) WS-Addressing 1.0 action header to include when accessing web services.
default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder	wsAddressingAction(URI wsAddressingAction) WS-Addressing 1.0 action header to include when accessing web services.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default SpringWebserviceEndpointBuilderFactory.AdvancedSpringWebserviceEndpointProducerBuilder advanced()

messageFilter

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder messageFilter(Object messageFilter)

Option to provide a custom MessageFilter. For example when you want to process your headers or attachments by your own. The option is a: <code>org.apache.camel.component.spring.ws.filter.MessageFilter</code> type. Group: common

Parameters:

messageFilter - the value to set

Returns:

the dsl builder

messageFilter

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder messageFilter(String messageFilter)

Option to provide a custom MessageFilter. For example when you want to process your headers or attachments by your own. The option will be converted to a <code>org.apache.camel.component.spring.ws.filter.MessageFilter</code> type. Group: common

Parameters:

messageFilter - the value to set

Returns:

the dsl builder

messageIdStrategy

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder messageIdStrategy(Object messageIdStrategy)

Option to provide a custom MessageIdStrategy to control generation of WS-Addressing unique message ids. The option is a: <code>org.springframework.ws.soap.addressing.messageid.MessageIdStrategy</code> type. Group: common

Parameters:

messageIdStrategy - the value to set

Returns:

the dsl builder

messageIdStrategy

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder messageIdStrategy(String messageIdStrategy)

Option to provide a custom MessageIdStrategy to control generation of WS-Addressing unique message ids. The option will be converted to a <code>org.springframework.ws.soap.addressing.messageid.MessageIdStrategy</code> type. Group: common

Parameters:

messageIdStrategy - the value to set

Returns:

the dsl builder

allowResponseAttachmentOverride

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder allowResponseAttachmentOverride(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. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

allowResponseAttachmentOverride - the value to set

Returns:

the dsl builder

allowResponseAttachmentOverride

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder allowResponseAttachmentOverride(String 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. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

allowResponseAttachmentOverride - the value to set

Returns:

the dsl builder

allowResponseHeaderOverride

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder allowResponseHeaderOverride(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. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

allowResponseHeaderOverride - the value to set

Returns:

the dsl builder

allowResponseHeaderOverride

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder allowResponseHeaderOverride(String 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. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

allowResponseHeaderOverride - the value to set

Returns:

the dsl builder

faultAction

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder faultAction(URI faultAction)

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. The option is a: <code>java.net.URI</code> type. Group: producer

Parameters:

faultAction - the value to set

Returns:

the dsl builder

faultAction

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder faultAction(String faultAction)

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. The option will be converted to a <code>java.net.URI</code> type. Group: producer

Parameters:

faultAction - the value to set

Returns:

the dsl builder

faultTo

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder faultTo(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. The option is a: <code>java.net.URI</code> type. Group: producer

Parameters:

faultTo - the value to set

Returns:

the dsl builder

faultTo

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder faultTo(String 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. The option will be converted to a <code>java.net.URI</code> type. Group: producer

Parameters:

faultTo - the value to set

Returns:

the dsl builder

lazyStartProducer

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder lazyStartProducer(boolean lazyStartProducer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

lazyStartProducer

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder lazyStartProducer(String lazyStartProducer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

messageFactory

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder messageFactory(Object messageFactory)

Option to provide a custom WebServiceMessageFactory. For example when you want Apache Axiom to handle web service messages instead of SAAJ. The option is a: <code>org.springframework.ws.WebServiceMessageFactory</code> type. Group: producer

Parameters:

messageFactory - the value to set

Returns:

the dsl builder

messageFactory

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder messageFactory(String messageFactory)

Option to provide a custom WebServiceMessageFactory. For example when you want Apache Axiom to handle web service messages instead of SAAJ. The option will be converted to a <code>org.springframework.ws.WebServiceMessageFactory</code> type. Group: producer

Parameters:

messageFactory - the value to set

Returns:

the dsl builder

messageSender

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder messageSender(Object messageSender)

Option to provide a custom WebServiceMessageSender. For example to perform authentication or use alternative transports. The option is a: <code>org.springframework.ws.transport.WebServiceMessageSender</code> type. Group: producer

Parameters:

messageSender - the value to set

Returns:

the dsl builder

messageSender

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder messageSender(String messageSender)

Option to provide a custom WebServiceMessageSender. For example to perform authentication or use alternative transports. The option will be converted to a <code>org.springframework.ws.transport.WebServiceMessageSender</code> type. Group: producer

Parameters:

messageSender - the value to set

Returns:

the dsl builder

outputAction

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder outputAction(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. The option is a: <code>java.net.URI</code> type. Group: producer

Parameters:

outputAction - the value to set

Returns:

the dsl builder

outputAction

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder outputAction(String 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. The option will be converted to a <code>java.net.URI</code> type. Group: producer

Parameters:

outputAction - the value to set

Returns:

the dsl builder

replyTo

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder replyTo(URI replyTo)

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. The option is a: <code>java.net.URI</code> type. Group: producer

Parameters:

replyTo - the value to set

Returns:

the dsl builder

replyTo

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder replyTo(String replyTo)

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. The option will be converted to a <code>java.net.URI</code> type. Group: producer

Parameters:

replyTo - the value to set

Returns:

the dsl builder

soapAction

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder soapAction(String soapAction)

SOAP action to include inside a SOAP request when accessing remote web services. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

soapAction - the value to set

Returns:

the dsl builder

timeout

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder timeout(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(). The option is a: <code>int</code> type. Group: producer

Parameters:

timeout - the value to set

Returns:

the dsl builder

timeout

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder timeout(String 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(). The option will be converted to a <code>int</code> type. Group: producer

Parameters:

timeout - the value to set

Returns:

the dsl builder

webServiceTemplate

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder webServiceTemplate(Object 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. The option is a: <code>org.springframework.ws.client.core.WebServiceTemplate</code> type. Group: producer

Parameters:

webServiceTemplate - the value to set

Returns:

the dsl builder

webServiceTemplate

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder webServiceTemplate(String 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. The option will be converted to a <code>org.springframework.ws.client.core.WebServiceTemplate</code> type. Group: producer

Parameters:

webServiceTemplate - the value to set

Returns:

the dsl builder

wsAddressingAction

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder wsAddressingAction(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). The option is a: <code>java.net.URI</code> type. Group: producer

Parameters:

wsAddressingAction - the value to set

Returns:

the dsl builder

wsAddressingAction

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder wsAddressingAction(String 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). The option will be converted to a <code>java.net.URI</code> type. Group: producer

Parameters:

wsAddressingAction - the value to set

Returns:

the dsl builder

sslContextParameters

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder sslContextParameters(Object sslContextParameters)

To configure security using SSLContextParameters. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder

sslContextParameters

default SpringWebserviceEndpointBuilderFactory.SpringWebserviceEndpointProducerBuilder sslContextParameters(String sslContextParameters)

To configure security using SSLContextParameters. The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder