Chapter 22. Class
Class Component
Available as of Apache Camel 2.4
The class: component binds beans to 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
| Name | Type | Default | Description |
|---|---|---|---|
method
|
String
|
null
|
The method name that bean will be invoked. If not provided, Apache Camel will try to pick the method itself. In case of ambiguity an exception is thrown. See Bean Binding for more details. |
multiParameterArray
|
boolean
|
false
|
How to treat the parameters which are passed from the message body; if it is true, the In message body should be an array of parameters.
|
bean.xxx
|
null
|
Camel 2.17: To configure additional options on the create bean instance from the class name. For example, to configure a
foo option on the bean, use bean.foo=123.
|
You can append query options to the URI in the following format,
?option=value&option=value&...
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:
// Camel 2.17 onwards
from("direct:start")
.to("class:org.apache.camel.component.bean.MyPrefixBean?bean.prefix=Bye")
.to("mock:result");
// Camel 2.16 and older
from("direct:start")
.to("class:org.apache.camel.component.bean.MyPrefixBean?prefix=Bye")
.to("mock:result");
And you can also use the
# syntax to refer to properties to be looked up in the Registry.
// Camel 2.17 onwards
from("direct:start")
.to("class:org.apache.camel.component.bean.MyPrefixBean?bean.cool=#foo")
.to("mock:result");
// Camel 2.16 and older
from("direct:start")
.to("class:org.apache.camel.component.bean.MyPrefixBean?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.
Note
See more details at the Bean component as the class component works in much the same way.
