Available as of Camel version 2.4
The Class component binds beans to Camel message exchanges. It works in the same way as the Bean component but instead of looking up beans from a Registry it creates the bean based on the class name.
URI format
class:className[?options]
Where className is the fully qualified class name to create and use as bean.
Options
The Class component supports 2 options, which are listed below.
Name | Description | Default | Type |
---|---|---|---|
cache (advanced) |
If enabled, Camel will cache the result of the first Registry look-up. Cache can be enabled if the bean in the Registry is defined as a singleton scope. |
Boolean |
|
basicPropertyBinding (advanced) |
Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
boolean |
The Class endpoint is configured using URI syntax:
class:beanName
with the following path and query parameters:
Path Parameters (1 parameters):
Name | Description | Default | Type |
---|---|---|---|
beanName |
Required Sets the name of the bean to invoke |
String |
Query Parameters (6 parameters):
Name | Description | Default | Type |
---|---|---|---|
cache (common) |
If enabled, Camel will cache the result of the first Registry look-up. Cache can be enabled if the bean in the Registry is defined as a singleton scope. |
Boolean |
|
method (common) |
Sets the name of the method to invoke on the bean |
String |
|
parameters (common) |
Used for configuring additional properties on the bean |
Map |
|
lazyStartProducer (producer) |
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
false |
boolean |
basicPropertyBinding (advanced) |
Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
boolean |
synchronous (advanced) |
Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). |
false |
boolean |
Using
You simply use the class component just as the Bean
component but by specifying the fully qualified classname instead.
For example to use the MyFooBean
you have to do as follows:
from("direct:start").to("class:org.apache.camel.component.bean.MyFooBean").to("mock:result");
You can also specify which method to invoke on the MyFooBean
, for
example hello
:
from("direct:start").to("class:org.apache.camel.component.bean.MyFooBean?method=hello").to("mock:result");
Setting properties on the created instance
In the endpoint uri you can specify properties to set on the created
instance, for example if it has a setPrefix
method:
from("direct:start")
.to("class:org.apache.camel.component.bean.MyPrefixBean?bean.prefix=Bye")
.to("mock:result");
And you can also use the #
syntax to refer to properties to be looked
up in the Registry.
from("direct:start")
.to("class:org.apache.camel.component.bean.MyPrefixBean?bean.cool=#foo")
.to("mock:result");
Which will lookup a bean from the Registry with the
id foo
and invoke the setCool
method on the created instance of the
MyPrefixBean
class.
TIP:See more details at the Bean component as the class component works in much the same way.