From Camel 2.11 onwards we have introduced a new ControlBus Component that allows you to send messages to a control bus Endpoint that reacts accordingly.

ControlBus Component

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.

Commands

Options

Command	Description
`route`	To control routes using the `routeId` and `action` parameter.
`language`	Allows you to specify a Language to use for evaluating the message body. If there is any result from the evaluation, then the result is put in the message body.

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.

You can append query options to the URI in the following format, ?option=value&option=value&...

Samples

Using 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:

Getting performance statistics

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:

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 routeId parameter as shown below:

Using Simple language

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:

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

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.

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.

CXF Example OSGi Blueprint

Available as of Camel 2.8

Spring-DM vs. OSGi Blueprint

This example uses OSGi Blueprint for OSGi. There is another CXF Example OSGi that uses Spring-DM.

A simple example which receives web service calls (via a CXF consumer, using bean binding)
and writes these requests into the file system. It's not a very useful use case, but the goal
of this example is to show you how you can use the CXF consumer component in an OSGI
environment with the OSGI HTTP service. If your target co ntainer is Apache Karaf or Apache
ServiceMix, you can use PAX Web to setup and start an OSGI HTTP service. All Camel
bundles using a Camel CXF consumer can use this HTTP service without needing to start
individual Jetty instances. Another advantage is that all provided services can now share
the same port.

This example is located in the examples/camel-example-cxf-blueprint directory of the Camel distribution.
There is a README.txt file with instructions how to run it.

You will need to compile this example first:

  mvn install
-

To run the example on Apache ServiceMix 4.x or Apache Karaf 2.x

1) launch the server

  karaf.bat
-

Note for Karaf 2.2.x:
a) edit the etc/jre.properties file to add the following packages to be exported

      jre-1.6=, \
+

b) from the same file comment out the following exports already provided by the bundles
that will be imported next: javax.xml.bind*, javax.jws*, javax.xml.soap*, javax.xml.ws*,
javax.activation, javax.annotation, javax.xml.stream*.

2) Add features required

Note: Apache Camel 2.9.0 is being used above, but you should of course change the
version number to the exact version of Camel being used.

3) Deploy the example bundle

  osgi:install -s mvn:org.apache.camel/camel-example-cxf-blueprint
-

4) Verify that your service is available using the following url in the browser.
We assume you're using Karaf's default PAX Web configuration which uses
port 8181 for http. If you would like to use another port or https, change the configuration in
${KARAF_HOME}/etc/org.ops4j.pax.web.cfg. The immediate extension after the hostname and port ("cxf" in
the below URL) is configured via the org.apache.cxf.osgi.cfg file (Please see
http://team.ops4j.org/wiki//display/paxweb/Pax+Web for more information on PAX Web).

  http://localhost:8181/cxf/camel-example-cxf-blueprint/webservices/incident?wsdl
-

5) Start SOAPUI or use curl to send the request
Create a new project called camel-example-cxf-osgi
Point to the following url: http://localhost:8181/cxf/camel-example-cxf-blueprint/webservices/incident?wsdl
Open the request 1 (under camel-example-cxf-blueprint --> ReportIncidentBinding --> ReportIncident) and copy/paste a SOAP
message generated by the unit test, for example:

ex :
--> and the message formatted that you copy in SOAPUI

   
-   <xml version="1.0" encoding="UTF-8"?>
-   <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+

If you use curl, you need to save the upper message in a file (data.xml) first and use the blow command to send the message.

curl -X POST -T data.xml -H "Content-Type: text/xml" http://localhost:8181/cxf/camel-example-cxf-osgi/webservices/incident

The response message looks like this

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+

6) Check the file system
Check the folder "target/inbox/" in the Karaf base directory to see that a message has arrived.

The CXF JAXRS front end implements the JAX-RS (JSR-311) API, so we can export the resources classes as a REST service. And we leverage the CXF Invoker API to turn a REST request into a normal Java object method invocation.
Unlike the Camel Restlet 60;component, you don't need to specify the URI template within your endpoint, CXF takes care of the REST request URI to resource class method mapping according to the JSR-311 specification. All you need to do in Camel is delegate this method request to a right processor or endpoint.

How to invoke the REST service through camel-cxfrs producer

The CXF JAXRS front end implements a proxy-based client API, with this API you can invoke the remote REST service through a proxy. The camel-cxfrs producer is based on this proxy API.
You just need to specify the operation name in the message header and prepare the parameter in the message body, the camel-cxfrs producer will generate right REST request for you.

@@ -284,6 +263,8 @@ Exchange exchange = template.send(" inMessage.setHeader(CxfConstants.CAMEL_CXF_RS_USING_HTTP_API, Boolean.FALSE); // set a customer header inMessage.setHeader("key", "value"); + // setup the accept content type + inMessage.setHeader(Exchange.ACCEPT_CONTENT_TYPE, "application/json"); // set the parameters , if you just have one parameter // camel will put this object into an Object[] itself inMessage.setBody("123"); Modified: websites/production/camel/content/documentation.html ============================================================================== --- websites/production/camel/content/documentation.html (original) +++ websites/production/camel/content/documentation.html Tue Sep 22 14:26:24 2015 @@ -90,7 +90,7 @@

ControlBus Component

Commands

Options

Samples

Using route command

Getting performance statistics

Using Simple language

See Also

Search

Search

Apache Software Foundation

Apache Software Foundation

URI format

Search

Search

Apache Software Foundation

Apache Software Foundation

Search

Search

Apache Software Foundation

Apache Software Foundation

CXF Example OSGi Blueprint

See Also

Search

Search

Apache Software Foundation

Apache Software Foundation

Consuming a REST Request - Default Binding Style

How to invoke the REST service through camel-cxfrs producer

Search

Search

Apache Software Foundation

Apache Software Foundation