org.apache.camel.commands

Interface CamelController

All Known Subinterfaces:

LocalCamelController

All Known Implementing Classes:

AbstractCamelController, AbstractLocalCamelController

public interface CamelController

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

Method Summary

Modifier and Type	Method and Description
List<Map<String,Object>>	browseInflightExchanges(String camelContextName, String route, int limit, boolean sortByLongestDuration) Browses the inflight exchanges
String	explainEipAsJSon(String camelContextName, String nameOrId, boolean allOptions) Explains an EIP
String	explainEndpointAsJSon(String camelContextName, String uri, boolean allOptions) Explains an endpoint uri
Map<String,Object>	getCamelContextInformation(String name) Gets information about a given Camel context by the given name.
List<Map<String,String>>	getCamelContexts() Get the list of Camel context.
List<Map<String,String>>	getCamelContexts(String filter) Get the list of Camel context filter by reg ex.
String	getCamelContextStatsAsXml(String camelContextName, boolean fullStats, boolean includeProcessors) Returns detailed CamelContext and route statistics as XML identified by a ID and a Camel context.
List<Map<String,String>>	getEndpointRuntimeStatistics(String camelContextName) Return endpoint runtime statistics
List<Map<String,String>>	getEndpoints(String camelContextName) Return the endpoints
String	getRestApiDocAsJson(String camelContextName) Return the REST services API documentation as JSon (requires camel-swagger-java on classpath)
String	getRestModelAsXml(String camelContextName) Return the definition of the REST services as XML for the given Camel context.
List<Map<String,String>>	getRestServices(String camelContextName) Return the REST services for the given Camel context.
String	getRouteModelAsXml(String routeId, String camelContextName) Return the definition of a route as XML identified by a ID and a Camel context.
List<Map<String,String>>	getRoutes(String camelContextName) Get all routes.
List<Map<String,String>>	getRoutes(String camelContextName, String filter) Get all routes filtered by the regex.
String	getRouteStatsAsXml(String routeId, String camelContextName, boolean fullStats, boolean includeProcessors) Returns detailed route statistics as XML identified by a ID and a Camel context.
List<Map<String,String>>	getTransformers(String camelContextName) Return the transformers
List<Map<String,String>>	getValidators(String camelContextName) Return the validators
List<Map<String,String>>	listComponents(String camelContextName) Lists Components which are in use or available on the classpath and include information
void	resetRouteStats(String camelContextName) Reset all the route stats for the given Camel context
void	resumeContext(String camelContextName) Resumes the given Camel context.
void	resumeRoute(String camelContextName, String routeId) Resumes the given route
void	startContext(String camelContextName) Starts the given Camel context.
void	startRoute(String camelContextName, String routeId) Starts the given route
void	stopContext(String camelContextName) Stops the given Camel context.
void	stopRoute(String camelContextName, String routeId) Stops the given route
void	suspendContext(String camelContextName) Suspends the given Camel context.
void	suspendRoute(String camelContextName, String routeId) Suspends the given route

Method Detail

getCamelContextInformation

Map<String,Object> getCamelContextInformation(String name)
                                       throws Exception

Gets information about a given Camel context by the given name.

Parameters:

name - the Camel context name.

Returns:

a list of key/value pairs with CamelContext information

Throws:

Exception - can be thrown

getCamelContexts

List<Map<String,String>> getCamelContexts()
                                   throws Exception

Get the list of Camel context.

Returns:

a list of key/value pairs with CamelContext information

Throws:

Exception - can be thrown

getCamelContexts

List<Map<String,String>> getCamelContexts(String filter)
                                   throws Exception

Get the list of Camel context filter by reg ex.

Parameters:

filter - the filter which supports * and ? as wildcards

Returns:

a list of key/value pairs with CamelContext information

Throws:

Exception - can be thrown

getCamelContextStatsAsXml

String getCamelContextStatsAsXml(String camelContextName,
                                 boolean fullStats,
                                 boolean includeProcessors)
                          throws Exception

Returns detailed CamelContext and route statistics as XML identified by a ID and a Camel context.

Parameters:

camelContextName - the Camel context.

fullStats - whether to include verbose stats

includeProcessors - whether to embed per processor stats from the route

Returns:

the CamelContext statistics as XML

Throws:

Exception - can be thrown

browseInflightExchanges

List<Map<String,Object>> browseInflightExchanges(String camelContextName,
                                                 String route,
                                                 int limit,
                                                 boolean sortByLongestDuration)
                                          throws Exception

Browses the inflight exchanges

Parameters:

camelContextName - the Camel context.

route - the Camel route ID

limit - maximum number of exchanges to return

sortByLongestDuration - true to sort by longest duration, false to sort by exchange id

Returns:

a list of key/value pairs with inflight exchange information

Throws:

Exception - can be thrown

startContext

void startContext(String camelContextName)
           throws Exception

Starts the given Camel context.

Parameters:

camelContextName - the Camel context.

Throws:

Exception - can be thrown

stopContext

void stopContext(String camelContextName)
          throws Exception

Stops the given Camel context.

Parameters:

camelContextName - the Camel context.

Throws:

Exception - can be thrown

suspendContext

void suspendContext(String camelContextName)
             throws Exception

Suspends the given Camel context.

Parameters:

camelContextName - the Camel context.

Throws:

Exception - can be thrown

resumeContext

void resumeContext(String camelContextName)
            throws Exception

Resumes the given Camel context.

Parameters:

camelContextName - the Camel context.

Throws:

Exception - can be thrown

getRoutes

List<Map<String,String>> getRoutes(String camelContextName)
                            throws Exception

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:

a list of key/value pairs with routes information

Throws:

Exception - can be thrown

getRoutes

List<Map<String,String>> getRoutes(String camelContextName,
                                   String filter)
                            throws Exception

Get all routes filtered by the regex.

Parameters:

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

filter - the filter which supports * and ? as wildcards

Returns:

a list of key/value pairs with routes information

Throws:

Exception - can be thrown

resetRouteStats

void resetRouteStats(String camelContextName)
              throws Exception

Reset all the route stats for the given Camel context

Parameters:

camelContextName - the Camel context.

Throws:

Exception - can be thrown

startRoute

void startRoute(String camelContextName,
                String routeId)
         throws Exception

Starts the given route

Parameters:

camelContextName - the Camel context.

routeId - the route ID.

Throws:

Exception - can be thrown

stopRoute

void stopRoute(String camelContextName,
               String routeId)
        throws Exception

Stops the given route

Parameters:

camelContextName - the Camel context.

routeId - the route ID.

Throws:

Exception - can be thrown

suspendRoute

void suspendRoute(String camelContextName,
                  String routeId)
           throws Exception

Suspends the given route

Parameters:

camelContextName - the Camel context.

routeId - the route ID.

Throws:

Exception - can be thrown

resumeRoute

void resumeRoute(String camelContextName,
                 String routeId)
          throws Exception

Resumes the given route

Parameters:

camelContextName - the Camel context.

routeId - the route ID.

Throws:

Exception - can be thrown

getRouteModelAsXml

String getRouteModelAsXml(String routeId,
                          String camelContextName)
                   throws Exception

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

Parameters:

routeId - the route ID.

camelContextName - the Camel context.

Returns:

the route model as XML

Throws:

Exception - can be thrown

getRouteStatsAsXml

String getRouteStatsAsXml(String routeId,
                          String camelContextName,
                          boolean fullStats,
                          boolean includeProcessors)
                   throws Exception

Returns detailed route statistics as XML identified by a ID and a Camel context.

Parameters:

routeId - the route ID.

camelContextName - the Camel context.

fullStats - whether to include verbose stats

includeProcessors - whether to embed per processor stats from the route

Returns:

the route statistics as XML

Throws:

Exception - can be thrown

getEndpoints

List<Map<String,String>> getEndpoints(String camelContextName)
                               throws Exception

Return the endpoints

Parameters:

camelContextName - the Camel context.

Returns:

a list of key/value pairs with endpoint information

Throws:

Exception - can be thrown

getEndpointRuntimeStatistics

List<Map<String,String>> getEndpointRuntimeStatistics(String camelContextName)
                                               throws Exception

Return endpoint runtime statistics

Parameters:

camelContextName - the Camel context

Returns:

a list of key/value pairs with endpoint runtime statistics

Throws:

Exception - can be thrown

getRestModelAsXml

String getRestModelAsXml(String camelContextName)
                  throws Exception

Return the definition of the REST services as XML for the given Camel context.

Parameters:

camelContextName - the Camel context.

Returns:

the REST model as xml

Throws:

Exception - can be thrown

getRestApiDocAsJson

String getRestApiDocAsJson(String camelContextName)
                    throws Exception

Return the REST services API documentation as JSon (requires camel-swagger-java on classpath)

Parameters:

camelContextName - the Camel context.

Returns:

the REST API documentation as JSon

Throws:

Exception - can be thrown

getRestServices

List<Map<String,String>> getRestServices(String camelContextName)
                                  throws Exception

Return the REST services for the given Camel context.

Parameters:

camelContextName - the Camel context.

Returns:

a list of key/value pairs with REST information

Throws:

Exception - can be thrown

explainEndpointAsJSon

String explainEndpointAsJSon(String camelContextName,
                             String uri,
                             boolean allOptions)
                      throws Exception

Explains an endpoint uri

Parameters:

camelContextName - the Camel context.

uri - the endpoint uri

allOptions - whether to explain all options, or only the explicit configured options from the uri

Returns:

a JSON schema with explanation of the options

Throws:

Exception - can be thrown

explainEipAsJSon

String explainEipAsJSon(String camelContextName,
                        String nameOrId,
                        boolean allOptions)
                 throws Exception

Explains an EIP

Parameters:

camelContextName - the Camel context.

nameOrId - the name of the EIP (NamedNode.getShortName() or a node id to refer to a specific node from the routes.

allOptions - whether to explain all options, or only the explicit configured options from the uri

Returns:

a JSON schema with explanation of the options

Throws:

Exception - can be thrown

listComponents

List<Map<String,String>> listComponents(String camelContextName)
                                 throws Exception

Lists Components which are in use or available on the classpath and include information

Parameters:

camelContextName - the Camel context.

Returns:

a list of key/value pairs with component information

Throws:

Exception - can be thrown

getTransformers

List<Map<String,String>> getTransformers(String camelContextName)
                                  throws Exception

Return the transformers

Parameters:

camelContextName - the Camel context.

Returns:

a list of key/value pairs with transformer information

Throws:

Exception - can be thrown

getValidators

List<Map<String,String>> getValidators(String camelContextName)
                                throws Exception

Return the validators

Parameters:

camelContextName - the Camel context.

Returns:

a list of key/value pairs with validator information

Throws:

Exception - can be thrown