...
Available as of Camel 2.11
The The controlbus:
component provides easy management of Camel applications based on the Control Bus EIP pattern.
For example, by sending a message to an Endpoint you can control the lifecycle of routes, or gather performance statistics.
Code Block |
---|
controlbus:command[?options] |
Where command
can be any string to identify which type of command to use.
...
Div | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Options
Div | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
|
You can append query options to the URI in the following format, ?option=value&option=value&...
...
Examples
Using the route
...
Command
The route command allows you to do common tasks on a given route very easily, for example to start a route, you can send an empty message to this endpoint:
Code Block | ||
---|---|---|
| ||
template.sendBody("controlbus:route?routeId=foo&action=start", null); |
To get the status of the route, you can do:
Code Block | ||
---|---|---|
| ||
String status = template.requestBody("controlbus:route?routeId=foo&action=status", null, String.class); |
...
This requires JMX to be enabled (is by default) then you can get the performance statics per route, or for the CamelContext. For example to get the statics for a route named foo
, we can do:
Code Block |
---|
String xml = template.requestBody("controlbus:route?routeId=foo&action=stats", null, String.class); |
The returned statics is in XML format. Its the same data you can get from JMX with the dumpRouteStatsAsXml
operation on the ManagedRouteMBean
.
To get statics for the entire CamelContext you just omit the the routeId
parameter as shown below:
...
You can use the Simple language with the control bus, for example to stop a specific route, you can send a message to the "controlbus:language:simple
" endpoint containing the following message:
...
Notice: its easier to use the route
command to control lifecycle of routes. The language
command allows you to execute a language script that has stronger powers such as Groovy or to some extend the Simple language.
...
Code Block |
---|
template.sendBody("controlbus:language:simple?async=true", "${camelContext.stop()}"); |
Notice we use async=true
to stop Camel asynchronously as otherwise we would be trying to stop Camel while it was in-flight processing the message we sent to the control bus component.
...