ControlBus Component
Available as of Camel 2.11
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.
controlbus:command[?options]
Where command can be any string to identify which type of command to use.
Commands
| Command |
Description |
| route |
To control routes using the routeId and action parameter. |
| language |
Allows to specify a Language to use for evaluating the message body. If there is any result from the evaluation, then the result is put on the message body. |
Options
| Name |
Default Value |
Description |
| routeId |
null |
To specify a route by its id. |
| action |
null |
To denote an action which can be either: start, stop, or status. To either start or stop a route. Og get the status of the route as output to the message body. |
| async |
false |
Whether to execute the control bus task asynchronously. Important: If this option is enabled, then any result from the task is not set on the Exchange. This is only possible if executing tasks synchronously. |
| loggingLevel |
INFO |
Logging level used for logging when task is done, or if any exceptions occurred during processing the task. |
You can append query options to the URI in the following format, ?option=value&option=value&...
Samples
Using route command
The route command allows to do common tasks on a given route very easily, for example to start a route you can send a empty message to this endpoint:
template.sendBody("controlbus:route?routeId=foo&action="">, null);
To get the status of the route you can do:
String status = template.requestBody("controlbus:route?routeId=foo&action="">, null, String.class);
Using Simple language
You can use 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:
template.sendBody("controlbus:language:simple", "${camelContext.stopRoute('myRoute')}");
As this operation is a void operation, then no result is returned. However if you want the route status you can do:
String status = template.requestBody("controlbus:language:simple", "${camelContext.getRouteStatus('myRoute')}", String.class);
Notice: its easier to use the route command to control lifecycle of routes. Though the language command allows to execute a language script which has stronger powers such as Groovy or to some extend the Simple language.
For example to shutdown Camel itself you can do:
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.
![]() | You can also use other languages such as Groovy etc. |
See Also
