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

Interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder

All Superinterfaces:

CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder, CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder, org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

CxfRsEndpointBuilderFactory

public static interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder
extends CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder, CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

Advanced builder for endpoint for the CXF-RS component.

Method Summary

Modifier and Type	Method	Description
default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder	basic()
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder	binding(String binding)	To use a custom CxfBinding to control the binding between Camel Message and CXF Message.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder	binding(org.apache.camel.component.cxf.jaxrs.CxfRsBinding binding)	To use a custom CxfBinding to control the binding between Camel Message and CXF Message.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder	bus(String bus)	To use a custom configured CXF Bus.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder	bus(org.apache.cxf.Bus bus)	To use a custom configured CXF Bus.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder	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.AdvancedCxfRsEndpointBuilder	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.AdvancedCxfRsEndpointBuilder	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.AdvancedCxfRsEndpointBuilder	cxfRsConfigurer(org.apache.camel.component.cxf.jaxrs.CxfRsConfigurer 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.AdvancedCxfRsEndpointBuilder	defaultBus(boolean defaultBus)	Will set the default bus when CXF endpoint create a bus by itself.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder	defaultBus(String defaultBus)	Will set the default bus when CXF endpoint create a bus by itself.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder	headerFilterStrategy(String headerFilterStrategy)	To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)	To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder	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.AdvancedCxfRsEndpointBuilder	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.AdvancedCxfRsEndpointBuilder	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.AdvancedCxfRsEndpointBuilder	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.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

bridgeErrorHandler, bridgeErrorHandler, exceptionHandler, exceptionHandler, exchangePattern, exchangePattern, serviceBeans

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

httpClientAPI, httpClientAPI, ignoreDeleteMethodMessageBody, ignoreDeleteMethodMessageBody, lazyStartProducer, lazyStartProducer, maxClientCacheSize, maxClientCacheSize, 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 Details

basic

default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder basic()

Specified by:

basic in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

Specified by:

basic in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

binding

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder binding(org.apache.camel.component.cxf.jaxrs.CxfRsBinding 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

Specified by:

binding in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

Specified by:

binding in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

Parameters:

binding - the value to set

Returns:

the dsl builder

binding

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

Specified by:

binding in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

Specified by:

binding in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

Parameters:

binding - the value to set

Returns:

the dsl builder

bus

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder 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 CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

Specified by:

bus in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

Parameters:

bus - the value to set

Returns:

the dsl builder

bus

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder 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 CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

Specified by:

bus in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

Parameters:

bus - the value to set

Returns:

the dsl builder

continuationTimeout

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder 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 CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

Specified by:

continuationTimeout in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

Parameters:

continuationTimeout - the value to set

Returns:

the dsl builder

continuationTimeout

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder 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 CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

Specified by:

continuationTimeout in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

Parameters:

continuationTimeout - the value to set

Returns:

the dsl builder

cxfRsConfigurer

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder cxfRsConfigurer(org.apache.camel.component.cxf.jaxrs.CxfRsConfigurer 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

Specified by:

cxfRsConfigurer in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

Specified by:

cxfRsConfigurer in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

Parameters:

cxfRsConfigurer - the value to set

Returns:

the dsl builder

cxfRsConfigurer

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

Specified by:

cxfRsConfigurer in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

Specified by:

cxfRsConfigurer in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

Parameters:

cxfRsConfigurer - the value to set

Returns:

the dsl builder

defaultBus

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder 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 CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

Specified by:

defaultBus in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

Parameters:

defaultBus - the value to set

Returns:

the dsl builder

defaultBus

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder 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 CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

Specified by:

defaultBus in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

Parameters:

defaultBus - the value to set

Returns:

the dsl builder

headerFilterStrategy

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder 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 CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

Specified by:

headerFilterStrategy in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

headerFilterStrategy

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder 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 CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

Specified by:

headerFilterStrategy in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

performInvocation

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

Specified by:

performInvocation in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

Specified by:

performInvocation in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

Parameters:

performInvocation - the value to set

Returns:

the dsl builder

performInvocation

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

Specified by:

performInvocation in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

Specified by:

performInvocation in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

Parameters:

performInvocation - the value to set

Returns:

the dsl builder

propagateContexts

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

Specified by:

propagateContexts in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

Specified by:

propagateContexts in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

Parameters:

propagateContexts - the value to set

Returns:

the dsl builder

propagateContexts

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

Specified by:

propagateContexts in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

Specified by:

propagateContexts in interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointProducerBuilder

Parameters:

propagateContexts - the value to set

Returns:

the dsl builder