Page History

Karaf Support

Apache Camel is designed to work nicely into inside Apache Karaf OSGi container.

...

• Camel features descriptor allowing to easily and quickly install Camel in Karaf.
• Karaf commands allowing you to view, start, stop, get info, about the Camel contexts and routes running in the Karaf instance. NB: Karaf commands are available starting with Camel 2.8.0.

It is recommended to use at least Apache Karaf 4.x with current Camel versions.

Install Camel in Karaf

Assuming that you have a running Karaf instance, you can register the Camel features descriptor:

karaf@root> featuresfeature:addurl mvn:org.apache.camel.karaf/apache-camel/2.8.0/xml/featuresrepo-add camel 2.18.4

Now, we have all Camel features available:

karaf@root> features:list|grep -i camel
[uninstalled] [2.8.0          ] camel                         repo-0                 
[uninstalled] [2.8.0          ] camel-core                    repo-0                 
[uninstalled] [2.8.0          ] camel-spring                  repo-0                 
[uninstalled] [2.8.0          ] camel-blueprint               repo-0                 
[uninstalled] [2.8.0          ] camel-test                    repo-0                 
[uninstalled] [2.8.0          ] camel-cxf                     repo-0
...

It is a good start to at least install camel-blueprint

karaf@root> features:install camel-blueprint

You might need other features depending on what components you use in your routes. So for example if you use stream:out then you need the camel-stream feature.

karaf@root>               
[uninstalled] [2features:install camel-stream

Karaf commands

The camel commands below help managing your integrations. In many cases the commands support tab completion for context and route names.

camel:route-list

karaf@root> camel:route-list
[route1.8.0          ] camel-cache              ]

You can also filter the routes by CamelContext:

karaf@root>     repo-0camel:route-list 66-camel-3
[route1              ]

Tip: use the TAB key to completion on the CamelContext ID.

camel:context-info

Displays detailed information about a given CamelContext:

add the *--verbose* option (following the context name) to also list the endpoints

karaf@root> camel:context-info 66-camel-3
Camel Context 66-camel-3
   
[uninstalled] [2.8.0          ] camel-castor                  repo-0Name: 66-camel-3
                 
[uninstalled] [Version: 2.8.0
        Status: Started
 ]  camel-crypto     Uptime: 1 minute

Advanced
        Auto Startup: true
  repo-0      Starting Routes: false
        Suspended: false
[uninstalled] [2.8.0       Tracing: false

Properties

Components
  ] camel-http     timer
        properties
       repo-0  log

Endpoints
        timer://test
        
[uninstalled] [2.8.0log://test

Routes
           ] camel-http4   route1

Used Languages

You can see the current Camel version used by the CamelContext, some context attributes, the components involved in the context, and the endpoints defined.

Tip: use TAB key for completion on the CamelContext name.

camel:route-info

The *camel:route-info* command provides detail information about a Camel route:

karaf@root> camel:route-info route1
Camel Route route1
        Camel Context: 66-camel-3

Properties
      repo-0          id =      
[uninstalled] [2.8.0route1
           ] camel-mina    parent = 2e7aacc1

Statistics
        Exchanges Total: 98
    repo-0    Exchanges Completed: 98
        Exchanges Failed:  0
[uninstalled] [2.8.0       Min Processing Time: ]1ms
 camel-jetty       Max Processing Time: 2ms
        Mean repo-0Processing Time: 1ms
        Total Processing      
[uninstalled] [2.8.0Time: 134ms
        Last Processing Time: ]1ms
 camel-servlet       First Exchange         repo-0 Date: 2011-06-29 07:21:57
        Last Exchange Completed Date: 2011-06-29 07:23:34

Definition
<?xml version="1.0" encoding="UTF-8" 
[uninstalled] [2.8.0standalone="yes"?>
<route id="route1" xmlns="http://camel.apache.org/schema/spring">
    <from uri="timer:test"/>
     ] camel-jms                     repo-0                 
...

To install Camel, just install the camel feature:

karaf@root> features:install camel

You have to install the Camel features depending of your requirements.

For instance, if you want to use blueprint as Camel DSL, you have to install the camel-blueprint feature:

karaf@root> features:install camel-blueprint

If, if your route, you use an endpoint like "stream:out", you have to install the camel-stream feature:

karaf@root> features:install camel-stream

Karaf commands

When you install the camel feature, new Karaf commands become available automatically.

camel:list-contexts

<to uri="log:test" id="to1"/>
</route>

You can see some statistics (the number of processed exchanges, the processing time, etc) and a XML rendering of your route (whatever DSL used to define the route).

Tip: use TAB key for completion on the route name.

camel:route-show

The *camel:route-show* command renders the route in XML. It's independent from the DSL used to define the route:

karaf@root> camel:route-show route1
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<route id="route1" xmlns="http://camel.apache.org/schema/spring">
    <from uri="timer:test"/>
    <to uri="log:test" id="to1"/>
</route>

Tip: use TAB key for completion on the route name.

camel:route-suspend

The *camel:route-suspend* command suspends a Camel route:

karaf@root> camel:route-suspend route1

Tip: use TAB key for completion on the route name.

camel:route-resume

The *camel:route-resume* command resume a Camel route:

karaf@root> camel:route-resume route1

Tip: use TAB key for completion on the route name.

camel:endpoint-list

The *camel:endpoint-list* command displays the list of the endpoints available in all camel contexts of The *camel:list-contexts* command displays the list of CamelContext available in the current Karaf instance:

karaf@root> camel:endpoint-list-contexts 
Namecamel-id              uri   Status               UptimeStatus              
[66-camel-3test         ] [Started    ] [timer://test      ] [14.559 secondsStarted         ]

It displays the context name/ID (used in others commands), the current status (started/stopped), the uptime (since when the context has been started).

camel:list-routes

The *camel:list-routes* command displays the list of Camel routes available in the current Karaf instance:

karaf@root> camel:list-routes ]
[route1test              ]

You can also filter the routes by CamelContext:

karaf@root> camel:list-routes 66-camel-3 
[route1    [direct://A        ] [Started           ]

It displays the context name/ID (used in others commands), the URI of the endpoint and the current status (started/stopped).

 Tip: use the TAB key to completion on the CamelContext ID.