Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NO

Name

Description

Example

Required?

default value

resourceClasses

The resource classes which you want to export as REST service. Multiple classes can be separated by comma.

resourceClasses=org.apache.camel.rs.Example1,
org.apache.camel.rs.Exchange2

No

None

resourceClass

Deprecated: Use resourceClasses The resource class which you want to export as REST service.

resourceClass =org.apache.camel.rs.Example1

No

None

httpClientAPI

new to Camel 2.1 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

httpClientAPI=true

No

true

synchronous

New in 2.5, this option will let CxfRsConsumer decide to use sync or async API to do the underlying work. The default value is false which means it will try to use async API by default.

synchronous=true

No

false

throwExceptionOnFailure

New in 2.6, this option tells the CxfRsProducer to inspect return codes and will generate an Exception if the return code is larger than 207.

throwExceptionOnFailure=true

No

true

maxClientCacheSize

New in 2.6, you can set a IN message header CamelDestinationOverrideUrl to dynamically override the target destination Web Service or REST Service defined in your routes.  The implementation caches CXF clients or ClientFactoryBean in CxfProvider and CxfRsProvider.  This option allows you to configure the maximum size of the cache.

maxClientCacheSize=5

No

10

setDefaultBus

New in 2.9.0. Will set the default bus when CXF endpoint create a bus by itself

setDefaultBus=true

No

false

bus

New in 2.9.0. A default bus created by CXF Bus Factory. Use # notation to reference a bus object from the registry. The referenced object must be an instance of org.apache.cxf.Bus.

bus=#busName

No

None

bindingStyle

As of 2.11. Sets how requests and responses will be mapped to/from Camel. Two values are possible:

bindingStyle=SimpleConsumer

No

Default

providersSince Camel 2.12.2 set custom JAX-RS providers list to the CxfRs endpoint.providers=#MyProvidersNoNone
schemaLocationsSince Camel 2.12.2 Sets the locations of the schemas which can be used to validate the incoming XML or JAXB-driven JSON.schemaLocations=#MySchemaLocationsNoNone
featuresSince Camel 2.12.3 Set the feature list to the CxfRs endpoint.features=#MyFeaturesNoNone
propertiesSince Camel 2.12.4 Set the properties to the CxfRs endpoint.properties=#MyPropertiesNoNone
inInterceptorsSince Camel 2.12.4 Set the inInterceptors to the CxfRs endpoint.inInterceptors=#MyInterceptorsNoNone
outInterceptorsSince Camel 2.12.4 Set the outInterceptor to the CxfRs endpoint.outInterceptors=#MyInterceptorsNoNone
inFaultInterceptorsSince Camel 2.12.4 Set the inFaultInterceptors to the CxfRs endpoint.inFaultInterceptors=#MyInterceptorsNoNone
outFaultIntercetprosSince Camel 2.12.4 Set the outFaultInterceptors to the CxfRs endpoint.outFaultInterceptors=#MyInterceptorsNoNone

You can also configure the CXF REST endpoint through the spring configuration. Since there are lots of difference between the CXF REST client and CXF REST Server, we provide different configuration for them.
Please check out the schema file and CXF REST user guide for more information.

...