Package org.apache.camel.builder.endpoint.dsl

Interface CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder

All Superinterfaces:

CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder, CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder, org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

CxfEndpointBuilderFactory

public static interface CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder
extends CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder, CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Advanced builder for endpoint for the CXF component.

Method Summary

Modifier and Type	Method	Description
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	allowStreaming(Boolean allowStreaming)	This option controls whether the CXF component, when running in PAYLOAD mode, will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	allowStreaming(String allowStreaming)	This option controls whether the CXF component, when running in PAYLOAD mode, will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases.
default CxfEndpointBuilderFactory.CxfEndpointBuilder	basic()
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	bus(String bus)	To use a custom configured CXF Bus.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	bus(org.apache.cxf.Bus bus)	To use a custom configured CXF Bus.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	continuationTimeout(long continuationTimeout)	This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	continuationTimeout(String continuationTimeout)	This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	cxfBinding(String cxfBinding)	To use a custom CxfBinding to control the binding between Camel Message and CXF Message.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	cxfBinding(org.apache.camel.component.cxf.common.CxfBinding cxfBinding)	To use a custom CxfBinding to control the binding between Camel Message and CXF Message.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	cxfConfigurer(String cxfConfigurer)	This option could apply the implementation of org.apache.camel.component.cxf.CxfEndpointConfigurer which supports to configure the CXF endpoint in programmatic way.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	cxfConfigurer(org.apache.camel.component.cxf.jaxws.CxfConfigurer cxfConfigurer)	This option could apply the implementation of org.apache.camel.component.cxf.CxfEndpointConfigurer which supports to configure the CXF endpoint in programmatic way.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	defaultBus(boolean defaultBus)	Will set the default bus when CXF endpoint create a bus by itself.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	defaultBus(String defaultBus)	Will set the default bus when CXF endpoint create a bus by itself.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	headerFilterStrategy(String headerFilterStrategy)	To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)	To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	mergeProtocolHeaders(boolean mergeProtocolHeaders)	Whether to merge protocol headers.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	mergeProtocolHeaders(String mergeProtocolHeaders)	Whether to merge protocol headers.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	mtomEnabled(boolean mtomEnabled)	To enable MTOM (attachments).
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	mtomEnabled(String mtomEnabled)	To enable MTOM (attachments).
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	properties(String key, Object value)	To set additional CXF options using the key/value pairs from the Map.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	properties(Map values)	To set additional CXF options using the key/value pairs from the Map.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	schemaValidationEnabled(Boolean schemaValidationEnabled)	Enable schema validation for request and response.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	schemaValidationEnabled(String schemaValidationEnabled)	Enable schema validation for request and response.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	skipPayloadMessagePartCheck(boolean skipPayloadMessagePartCheck)	Sets whether SOAP message validation should be disabled.
default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder	skipPayloadMessagePartCheck(String skipPayloadMessagePartCheck)	Sets whether SOAP message validation should be disabled.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

bridgeErrorHandler, bridgeErrorHandler, exceptionHandler, exceptionHandler, exchangePattern, exchangePattern

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

lazyStartProducer, lazyStartProducer, synchronous, synchronous

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

basic

default CxfEndpointBuilderFactory.CxfEndpointBuilder basic()

Specified by:

basic in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

basic in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

allowStreaming

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder allowStreaming(Boolean allowStreaming)

This option controls whether the CXF component, when running in PAYLOAD mode, will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases. The option is a: <code>java.lang.Boolean</code> type. Group: advanced

Specified by:

allowStreaming in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

allowStreaming in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

allowStreaming - the value to set

Returns:

the dsl builder

allowStreaming

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder allowStreaming(String allowStreaming)

This option controls whether the CXF component, when running in PAYLOAD mode, will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases. The option will be converted to a <code>java.lang.Boolean</code> type. Group: advanced

Specified by:

allowStreaming in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

allowStreaming in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

allowStreaming - the value to set

Returns:

the dsl builder

bus

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder bus(org.apache.cxf.Bus bus)

To use a custom configured CXF Bus. The option is a: <code>org.apache.cxf.Bus</code> type. Group: advanced

Specified by:

bus in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

bus in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

bus - the value to set

Returns:

the dsl builder

bus

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder bus(String bus)

To use a custom configured CXF Bus. The option will be converted to a <code>org.apache.cxf.Bus</code> type. Group: advanced

Specified by:

bus in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

bus in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

bus - the value to set

Returns:

the dsl builder

continuationTimeout

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder continuationTimeout(long continuationTimeout)

This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport. The option is a: <code>long</code> type. Default: 30000 Group: advanced

Specified by:

continuationTimeout in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

continuationTimeout in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

continuationTimeout - the value to set

Returns:

the dsl builder

continuationTimeout

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder continuationTimeout(String continuationTimeout)

This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport. The option will be converted to a <code>long</code> type. Default: 30000 Group: advanced

Specified by:

continuationTimeout in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

continuationTimeout in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

continuationTimeout - the value to set

Returns:

the dsl builder

cxfBinding

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder cxfBinding(org.apache.camel.component.cxf.common.CxfBinding cxfBinding)

To use a custom CxfBinding to control the binding between Camel Message and CXF Message. The option is a: <code>org.apache.camel.component.cxf.common.CxfBinding</code> type. Group: advanced

Specified by:

cxfBinding in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

cxfBinding in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

cxfBinding - the value to set

Returns:

the dsl builder

cxfBinding

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder cxfBinding(String cxfBinding)

To use a custom CxfBinding to control the binding between Camel Message and CXF Message. The option will be converted to a <code>org.apache.camel.component.cxf.common.CxfBinding</code> type. Group: advanced

Specified by:

cxfBinding in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

cxfBinding in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

cxfBinding - the value to set

Returns:

the dsl builder

cxfConfigurer

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder cxfConfigurer(org.apache.camel.component.cxf.jaxws.CxfConfigurer cxfConfigurer)

This option could apply the implementation of org.apache.camel.component.cxf.CxfEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configure{ServerClient} method of CxfEndpointConfigurer. The option is a: <code>org.apache.camel.component.cxf.jaxws.CxfConfigurer</code> type. Group: advanced

Specified by:

cxfConfigurer in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

cxfConfigurer in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

cxfConfigurer - the value to set

Returns:

the dsl builder

cxfConfigurer

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder cxfConfigurer(String cxfConfigurer)

This option could apply the implementation of org.apache.camel.component.cxf.CxfEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configure{ServerClient} method of CxfEndpointConfigurer. The option will be converted to a <code>org.apache.camel.component.cxf.jaxws.CxfConfigurer</code> type. Group: advanced

Specified by:

cxfConfigurer in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

cxfConfigurer in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

cxfConfigurer - the value to set

Returns:

the dsl builder

defaultBus

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder defaultBus(boolean defaultBus)

Will set the default bus when CXF endpoint create a bus by itself. The option is a: <code>boolean</code> type. Default: false Group: advanced

Specified by:

defaultBus in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

defaultBus in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

defaultBus - the value to set

Returns:

the dsl builder

defaultBus

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder defaultBus(String defaultBus)

Will set the default bus when CXF endpoint create a bus by itself. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Specified by:

defaultBus in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

defaultBus in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

defaultBus - the value to set

Returns:

the dsl builder

headerFilterStrategy

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)

To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option is a: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: advanced

Specified by:

headerFilterStrategy in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

headerFilterStrategy in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

headerFilterStrategy

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder headerFilterStrategy(String headerFilterStrategy)

To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option will be converted to a <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: advanced

Specified by:

headerFilterStrategy in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

headerFilterStrategy in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

mergeProtocolHeaders

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder mergeProtocolHeaders(boolean mergeProtocolHeaders)

Whether to merge protocol headers. If enabled then propagating headers between Camel and CXF becomes more consistent and similar. For more details see CAMEL-6393. The option is a: <code>boolean</code> type. Default: false Group: advanced

Specified by:

mergeProtocolHeaders in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

mergeProtocolHeaders in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

mergeProtocolHeaders - the value to set

Returns:

the dsl builder

mergeProtocolHeaders

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder mergeProtocolHeaders(String mergeProtocolHeaders)

Whether to merge protocol headers. If enabled then propagating headers between Camel and CXF becomes more consistent and similar. For more details see CAMEL-6393. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Specified by:

mergeProtocolHeaders in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

mergeProtocolHeaders in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

mergeProtocolHeaders - the value to set

Returns:

the dsl builder

mtomEnabled

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder mtomEnabled(boolean mtomEnabled)

To enable MTOM (attachments). This requires to use POJO or PAYLOAD data format mode. The option is a: <code>boolean</code> type. Default: false Group: advanced

Specified by:

mtomEnabled in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

mtomEnabled in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

mtomEnabled - the value to set

Returns:

the dsl builder

mtomEnabled

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder mtomEnabled(String mtomEnabled)

To enable MTOM (attachments). This requires to use POJO or PAYLOAD data format mode. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Specified by:

mtomEnabled in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

mtomEnabled in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

mtomEnabled - the value to set

Returns:

the dsl builder

properties

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder properties(String key,
                                                                        Object value)

To set additional CXF options using the key/value pairs from the Map. For example to turn on stacktraces in SOAP faults, properties.faultStackTraceEnabled=true. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the properties(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced

Specified by:

properties in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

properties in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

properties

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder properties(Map values)

To set additional CXF options using the key/value pairs from the Map. For example to turn on stacktraces in SOAP faults, properties.faultStackTraceEnabled=true. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the properties(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced

Specified by:

properties in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

properties in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

values - the values

Returns:

the dsl builder

schemaValidationEnabled

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder schemaValidationEnabled(Boolean schemaValidationEnabled)

Enable schema validation for request and response. Disabled by default for performance reason. The option is a: <code>java.lang.Boolean</code> type. Default: false Group: advanced

Specified by:

schemaValidationEnabled in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

schemaValidationEnabled in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

schemaValidationEnabled - the value to set

Returns:

the dsl builder

schemaValidationEnabled

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder schemaValidationEnabled(String schemaValidationEnabled)

Enable schema validation for request and response. Disabled by default for performance reason. The option will be converted to a <code>java.lang.Boolean</code> type. Default: false Group: advanced

Specified by:

schemaValidationEnabled in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

schemaValidationEnabled in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

schemaValidationEnabled - the value to set

Returns:

the dsl builder

skipPayloadMessagePartCheck

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder skipPayloadMessagePartCheck(boolean skipPayloadMessagePartCheck)

Sets whether SOAP message validation should be disabled. The option is a: <code>boolean</code> type. Default: false Group: advanced

Specified by:

skipPayloadMessagePartCheck in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

skipPayloadMessagePartCheck in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

skipPayloadMessagePartCheck - the value to set

Returns:

the dsl builder

skipPayloadMessagePartCheck

default CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder skipPayloadMessagePartCheck(String skipPayloadMessagePartCheck)

Sets whether SOAP message validation should be disabled. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Specified by:

skipPayloadMessagePartCheck in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

Specified by:

skipPayloadMessagePartCheck in interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

Parameters:

skipPayloadMessagePartCheck - the value to set

Returns:

the dsl builder