Options - 6.3

Talend ESB Mediation Developer Guide

EnrichVersion
6.3
EnrichProdName
Talend Data Fabric
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for ESB
Talend Real-Time Big Data Platform
task
Design and Development
EnrichPlatform
Talend ESB

Name

Required

Description

resourceClasses

No

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

Default: None

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

httpClientAPI

No

new to Camel 2.1 If true, the CxfRsProducer will use the HttpClientAPI to invoke the service If false, the CxfRsProducer will use the ProxyClientAPI to invoke the service

Default: true

Example: httpClientAPI=true

synchronous

No

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.

Default:false

Example:synchronous=true

throwExceptionOnFailure

No

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.

Default:true

Example:throwExceptionOnFailure=true

maxClientCacheSize

No

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.

Default:10

Example:maxClientCacheSize=5

setDefaultBus

No

New in 2.9.0. If true, will set the default bus when CXF endpoint create a bus by itself.

Default: false

Example: setDefaultBus=true

bus

No

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.

Default: None

Example: bus=#busName

bindingStyle

No

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

Default: Default

Example: bindingStyle=SimpleConsumer

providers

No

Since Camel 2.12.2 set custom JAX-RS providers list to the CxfRs endpoint.

Default: None

Example: providers=#MyProviders

schemaLocations

No

Since Camel 2.12.2 Sets the locations of the schemas which can be used to validate the incoming XML or JAXB-driven JSON.

Default: None

Example: schemaLocations=#MySchemaLocations

features

No

Since Camel 2.12.3 Set the feature list to the CxfRs endpoint.

Default: None

Example: features=#MyFeatures

properties

No

Since Camel 2.12.4 Set the properties to the CxfRs endpoint.

Default: None

Example: properties=#MyProperties

inInterceptors

No

Since Camel 2.12.4 Set the inInterceptors to the CxfRs endpoint.

Default: None

Example: inInterceptors=#MyInterceptors

outInterceptors

No

Since Camel 2.12.4 Set the outInterceptor to the CxfRs endpoint.

Default: None

Example: outInterceptors=#MyInterceptors

inFaultInterceptors

No

Since Camel 2.12.4 Set the inFaultInterceptors to the CxfRs endpoint.

Default: None

Example: inFaultInterceptors=#MyInterceptors

outFaultIntercetpros

No

Since Camel 2.12.4 Set the outFaultInterceptors to the CxfRs endpoint.

Default: None

Example: outFaultInterceptors=#MyInterceptors

continuationTimeout

No

Since Camel 2.14.0 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. (Before Camel 2.14.0, CxfConsumer just set the continuation timeout to be 0, which means the continuation suspend operation never timeout.)

Default: 30000

Example: continuationTimeout=800000

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 JAX-RS documentation for more information.

See the Camel Website for the latest examples of this component in use.