org.apache.camel.builder.endpoint.dsl

Interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder

Enclosing interface:

CxfRsEndpointBuilderFactory

public static interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Advanced builder for endpoint producers for the CXF-RS component.

Method Summary

Modifier and Type	Method and Description
default CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder	basic()
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	binding(Object binding) To use a custom CxfBinding to control the binding between Camel Message and CXF Message.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	binding(String binding) To use a custom CxfBinding to control the binding between Camel Message and CXF Message.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	bus(Object bus) To use a custom configured CXF Bus.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	bus(String bus) To use a custom configured CXF Bus.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	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 CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	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 CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	cxfRsConfigurer(Object cxfRsConfigurer) This option could apply the implementation of org.apache.camel.component.cxf.jaxrs.CxfRsEndpointConfigurer which supports to configure the CXF endpoint in programmatic way.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	cxfRsConfigurer(String cxfRsConfigurer) This option could apply the implementation of org.apache.camel.component.cxf.jaxrs.CxfRsEndpointConfigurer which supports to configure the CXF endpoint in programmatic way.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	defaultBus(boolean defaultBus) Will set the default bus when CXF endpoint create a bus by itself.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	defaultBus(String defaultBus) Will set the default bus when CXF endpoint create a bus by itself.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	headerFilterStrategy(String headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	httpClientAPI(boolean httpClientAPI) If it is true, the CxfRsProducer will use the HttpClientAPI to invoke the service.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	httpClientAPI(String httpClientAPI) If it is true, the CxfRsProducer will use the HttpClientAPI to invoke the service.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	ignoreDeleteMethodMessageBody(boolean ignoreDeleteMethodMessageBody) This option is used to tell CxfRsProducer to ignore the message body of the DELETE method when using HTTP API.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	ignoreDeleteMethodMessageBody(String ignoreDeleteMethodMessageBody) This option is used to tell CxfRsProducer to ignore the message body of the DELETE method when using HTTP API.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	maxClientCacheSize(int maxClientCacheSize) This option allows you to configure the maximum size of the cache.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	maxClientCacheSize(String maxClientCacheSize) This option allows you to configure the maximum size of the cache.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	performInvocation(boolean performInvocation) When the option is true, Camel will perform the invocation of the resource class instance and put the response object into the exchange for further processing.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	performInvocation(String performInvocation) When the option is true, Camel will perform the invocation of the resource class instance and put the response object into the exchange for further processing.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	propagateContexts(boolean propagateContexts) When the option is true, JAXRS UriInfo, HttpHeaders, Request and SecurityContext contexts will be available to custom CXFRS processors as typed Camel exchange properties.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	propagateContexts(String propagateContexts) When the option is true, JAXRS UriInfo, HttpHeaders, Request and SecurityContext contexts will be available to custom CXFRS processors as typed Camel exchange properties.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder	synchronous(String synchronous) Sets whether synchronous processing should be strictly used.

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

basic

default CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder basic()

httpClientAPI

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder httpClientAPI(boolean httpClientAPI)

If it is true, the CxfRsProducer will use the HttpClientAPI to invoke the service. If it is false, the CxfRsProducer will use the ProxyClientAPI to invoke the service. The option is a: <code>boolean</code> type. Default: true Group: producer (advanced)

Parameters:

httpClientAPI - the value to set

Returns:

the dsl builder

httpClientAPI

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder httpClientAPI(String httpClientAPI)

If it is true, the CxfRsProducer will use the HttpClientAPI to invoke the service. If it is false, the CxfRsProducer will use the ProxyClientAPI to invoke the service. The option will be converted to a <code>boolean</code> type. Default: true Group: producer (advanced)

Parameters:

httpClientAPI - the value to set

Returns:

the dsl builder

ignoreDeleteMethodMessageBody

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder ignoreDeleteMethodMessageBody(boolean ignoreDeleteMethodMessageBody)

This option is used to tell CxfRsProducer to ignore the message body of the DELETE method when using HTTP API. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)

Parameters:

ignoreDeleteMethodMessageBody - the value to set

Returns:

the dsl builder

ignoreDeleteMethodMessageBody

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder ignoreDeleteMethodMessageBody(String ignoreDeleteMethodMessageBody)

This option is used to tell CxfRsProducer to ignore the message body of the DELETE method when using HTTP API. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)

Parameters:

ignoreDeleteMethodMessageBody - the value to set

Returns:

the dsl builder

maxClientCacheSize

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder maxClientCacheSize(int maxClientCacheSize)

This option allows you to configure the maximum size of the cache. The implementation caches CXF clients or ClientFactoryBean in CxfProvider and CxfRsProvider. The option is a: <code>int</code> type. Default: 10 Group: producer (advanced)

Parameters:

maxClientCacheSize - the value to set

Returns:

the dsl builder

maxClientCacheSize

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder maxClientCacheSize(String maxClientCacheSize)

This option allows you to configure the maximum size of the cache. The implementation caches CXF clients or ClientFactoryBean in CxfProvider and CxfRsProvider. The option will be converted to a <code>int</code> type. Default: 10 Group: producer (advanced)

Parameters:

maxClientCacheSize - the value to set

Returns:

the dsl builder

synchronous

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder synchronous(boolean synchronous)

Sets whether synchronous processing should be strictly used. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)

Parameters:

synchronous - the value to set

Returns:

the dsl builder

synchronous

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder synchronous(String synchronous)

Sets whether synchronous processing should be strictly used. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)

Parameters:

synchronous - the value to set

Returns:

the dsl builder

binding

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder binding(Object binding)

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.jaxrs.CxfRsBinding</code> type. Group: advanced

Parameters:

binding - the value to set

Returns:

the dsl builder

binding

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder binding(String binding)

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.jaxrs.CxfRsBinding</code> type. Group: advanced

Parameters:

binding - the value to set

Returns:

the dsl builder

bus

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder bus(Object bus)

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

Parameters:

bus - the value to set

Returns:

the dsl builder

bus

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder 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

Parameters:

bus - the value to set

Returns:

the dsl builder

continuationTimeout

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder 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

Parameters:

continuationTimeout - the value to set

Returns:

the dsl builder

continuationTimeout

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder 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

Parameters:

continuationTimeout - the value to set

Returns:

the dsl builder

cxfRsConfigurer

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder cxfRsConfigurer(Object cxfRsConfigurer)

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

Parameters:

cxfRsConfigurer - the value to set

Returns:

the dsl builder

cxfRsConfigurer

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder cxfRsConfigurer(String cxfRsConfigurer)

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

Parameters:

cxfRsConfigurer - the value to set

Returns:

the dsl builder

defaultBus

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder 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

Parameters:

defaultBus - the value to set

Returns:

the dsl builder

defaultBus

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder 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

Parameters:

defaultBus - the value to set

Returns:

the dsl builder

headerFilterStrategy

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder 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

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

headerFilterStrategy

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder 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

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

performInvocation

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder performInvocation(boolean performInvocation)

When the option is true, Camel will perform the invocation of the resource class instance and put the response object into the exchange for further processing. The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

performInvocation - the value to set

Returns:

the dsl builder

performInvocation

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder performInvocation(String performInvocation)

When the option is true, Camel will perform the invocation of the resource class instance and put the response object into the exchange for further processing. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

performInvocation - the value to set

Returns:

the dsl builder

propagateContexts

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder propagateContexts(boolean propagateContexts)

When the option is true, JAXRS UriInfo, HttpHeaders, Request and SecurityContext contexts will be available to custom CXFRS processors as typed Camel exchange properties. These contexts can be used to analyze the current requests using JAX-RS API. The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

propagateContexts - the value to set

Returns:

the dsl builder

propagateContexts

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder propagateContexts(String propagateContexts)

When the option is true, JAXRS UriInfo, HttpHeaders, Request and SecurityContext contexts will be available to custom CXFRS processors as typed Camel exchange properties. These contexts can be used to analyze the current requests using JAX-RS API. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

propagateContexts - the value to set

Returns:

the dsl builder