Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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]

...

Div
classconfluenceTableSmall

Name

Default Value

Description

routeId

null

To specify a route by its id.

action

null

To denote an action that can be either: start, stop, suspend, resume, or status. To either start or stop a route, or to get the status of the route as output in the message body. You can use suspend and resume from Camel 2.11.1 onwards to either suspend or resume a route. And from Camel 2.11.1 onwards you can use stats to get performance statics returned in XML format; the routeId option can be used to define which route to get the performance stats for, if routeId is not defined, then you get statistics for the entire CamelContext.

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.

...

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);

...

To get statics for the entire CamelContext you just omit the routeId parameter as shown below:

Code Block

String xml = template.requestBody("controlbus:route?action=stats", null, String.class);

...

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:

Code Block

template.sendBody("controlbus:language:simple", "${camelContext.stopRoute('myRoute')}");

As this is a void operation, no result is returned. However, if you want the route status you can do:

Code Block

String status = template.requestBody("controlbus:language:simple", "${camelContext.getRouteStatus('myRoute')}", String.class);

...

For example to shutdown Camel itself you can do:

Code Block

template.sendBody("controlbus:language:simple?async=true", "${camelContext.stop()}");

...

Tip

You can also use other languages such as Groovy, etc.

Include Page
Endpoint See Also
Endpoint See Also