Bean Component
The bean: component binds beans to Camel message exchanges.
URI format
bean:beanID[?options]
Where beanID can be any string which is used to look up the bean in the Registry
Options
Name |
Type |
Default |
Description |
---|---|---|---|
|
|
|
The method name from the bean that will be invoked. If not provided, Camel will try to determine the method itself. In case of ambiguity an exception will be thrown. See Bean Binding for more details. From Camel 2.8 onwards you can specify type qualifiers to pin-point exact method to use for overloaded methods. |
|
|
|
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. |
|
|
|
Camel 1.5: How to treat the parameters which are passed from the message body; if it is |
You can append query options to the URI in the following format, ?option=value&option=value&...
Using
The object instance that is used to consume messages must be explicitly registered with the Registry. For example, if you are using Spring you must define the bean in the Spring configuration, spring.xml
; or if you don't use Spring, by registering the bean in JNDI.
Once an endpoint has been registered, you can build Camel routes that use it to process exchanges.
A bean: endpoint cannot be defined as the input to the route; i.e. you cannot consume from it, you can only route from some inbound message Endpoint to the bean endpoint as output. So consider using a direct: or queue: endpoint as the input.
You can use the createProxy()
methods on ProxyHelper to create a proxy that will generate BeanExchanges and send them to any endpoint:
And the same route using Spring DSL:
<route> <from uri="direct:hello"> <to uri="bean:bye"/> </route>
Bean as endpoint
Camel also supports invoking Bean as an Endpoint. In the route below:
What happens is that when the exchange is routed to the myBean
Camel will use the Bean Binding to invoke the bean.
The source for the bean is just a plain POJO:
Camel will use Bean Binding to invoke the sayHello
method, by converting the Exchange's In body to the String
type and storing the output of the method on the Exchange Out body.
Bean Binding
How bean methods to be invoked are chosen (if they are not specified explicitly through the method parameter) and how parameter values are constructed from the Message are all defined by the Bean Binding mechanism which is used throughout all of the various Bean Integration mechanisms in Camel.
See Also
- Class component
- Bean Binding
- Bean Integration