org.apache.camel.karaf.commands
Interface CamelController

All Known Implementing Classes:

CamelControllerImpl

public interface CamelController

CamelController interface defines the expected behaviors to manipulate Camel resources (context, route, etc).

Method Summary

org.apache.camel.CamelContext	getCamelContext(String name) Get a Camel context identified by the given name.
List<org.apache.camel.CamelContext>	getCamelContexts() Get the list of Camel context.
org.apache.camel.Route	getRoute(String routeId, String camelContextName) Return the route with the given route ID.
org.apache.camel.model.RouteDefinition	getRouteDefinition(String routeId, String camelContextName) Return the definition of a route identified by a ID and a Camel context.
List<org.apache.camel.model.RouteDefinition>	getRouteDefinitions(String camelContextName) Get all route definitions.
List<org.apache.camel.Route>	getRoutes(String camelContextName) Get all routes.

Method Detail

getCamelContexts

List<org.apache.camel.CamelContext> getCamelContexts()

Get the list of Camel context.

Returns:

the list of Camel contexts.

getCamelContext

org.apache.camel.CamelContext getCamelContext(String name)

Get a Camel context identified by the given name.

Parameters:

name - the Camel context name.

Returns:

the Camel context or null if not found.

getRoutes

List<org.apache.camel.Route> getRoutes(String camelContextName)

Get all routes. If Camel context name is null, all routes from all contexts are listed.

Parameters:

camelContextName - the Camel context name. If null, all contexts are considered.

Returns:

the list of the Camel routes.

getRouteDefinitions

List<org.apache.camel.model.RouteDefinition> getRouteDefinitions(String camelContextName)

Get all route definitions. If Camel context name is null, all route definitions from all contexts are listed.

Parameters:

camelContextName - the Camel context name. If null, all contexts are considered.

Returns:

the list of the Camel route definitions.

getRoute

org.apache.camel.Route getRoute(String routeId,
                                String camelContextName)

Return the route with the given route ID.

Parameters:

routeId - the route ID.

camelContextName - the Camel context name.

Returns:

the route.

getRouteDefinition

org.apache.camel.model.RouteDefinition getRouteDefinition(String routeId,
                                                          String camelContextName)

Return the definition of a route identified by a ID and a Camel context.

Parameters:

routeId - the route ID.

camelContextName - the Camel context.

Returns:

the RouteDefinition.