org.apache.camel.builder.endpoint.dsl

Interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder

Enclosing interface:

CxfRsEndpointBuilderFactory

public static interface CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

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

Method Summary

Modifier and Type	Method and Description
default CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder	basic()
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder	binding(Object binding) To use a custom CxfBinding to control the binding between Camel Message and CXF Message.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder	binding(String binding) To use a custom CxfBinding to control the binding between Camel Message and CXF Message.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder	bus(Object bus) To use a custom configured CXF Bus.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder	bus(String bus) To use a custom configured CXF Bus.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder	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.AdvancedCxfRsEndpointConsumerBuilder	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.AdvancedCxfRsEndpointConsumerBuilder	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.AdvancedCxfRsEndpointConsumerBuilder	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.AdvancedCxfRsEndpointConsumerBuilder	defaultBus(boolean defaultBus) Will set the default bus when CXF endpoint create a bus by itself.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder	defaultBus(String defaultBus) Will set the default bus when CXF endpoint create a bus by itself.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder	exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler) To let the consumer use a custom ExceptionHandler.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder	exceptionHandler(String exceptionHandler) To let the consumer use a custom ExceptionHandler.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder	exchangePattern(org.apache.camel.ExchangePattern exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder	exchangePattern(String exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder	headerFilterStrategy(String headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder	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.AdvancedCxfRsEndpointConsumerBuilder	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.AdvancedCxfRsEndpointConsumerBuilder	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.AdvancedCxfRsEndpointConsumerBuilder	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.AdvancedCxfRsEndpointConsumerBuilder	serviceBeans(List<Object> serviceBeans) The service beans (the bean ids to lookup in the registry) which you want to export as REST service.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder	serviceBeans(String serviceBeans) The service beans (the bean ids to lookup in the registry) which you want to export as REST service.
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder	synchronous(String synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

basic

default CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder basic()

exceptionHandler

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)

Parameters:

exceptionHandler - the value to set

Returns:

the dsl builder

exceptionHandler

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder exceptionHandler(String exceptionHandler)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)

Parameters:

exceptionHandler - the value to set

Returns:

the dsl builder

exchangePattern

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)

Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)

Parameters:

exchangePattern - the value to set

Returns:

the dsl builder

exchangePattern

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder exchangePattern(String exchangePattern)

Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)

Parameters:

exchangePattern - the value to set

Returns:

the dsl builder

serviceBeans

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder serviceBeans(List<Object> serviceBeans)

The service beans (the bean ids to lookup in the registry) which you want to export as REST service. Multiple beans can be separated by comma. The option is a: <code>java.util.List&lt;java.lang.Object&gt;</code> type. Group: consumer (advanced)

Parameters:

serviceBeans - the value to set

Returns:

the dsl builder

serviceBeans

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder serviceBeans(String serviceBeans)

The service beans (the bean ids to lookup in the registry) which you want to export as REST service. Multiple beans can be separated by comma. The option will be converted to a <code>java.util.List&lt;java.lang.Object&gt;</code> type. Group: consumer (advanced)

Parameters:

serviceBeans - the value to set

Returns:

the dsl builder

binding

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

synchronous

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder synchronous(boolean synchronous)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

synchronous - the value to set

Returns:

the dsl builder

synchronous

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointConsumerBuilder synchronous(String synchronous)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

synchronous - the value to set

Returns:

the dsl builder