org.apache.camel.commands

Class AbstractLocalCamelController

java.lang.Object

org.apache.camel.commands.AbstractCamelController

org.apache.camel.commands.AbstractLocalCamelController

All Implemented Interfaces:

CamelController, LocalCamelController

public abstract class AbstractLocalCamelController
extends AbstractCamelController
implements LocalCamelController

Abstract LocalCamelController that implementators should extend when implementing a controller that runs locally in the same JVM as Camel.

Constructor Summary

Constructors

Constructor and Description
AbstractLocalCamelController()

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.
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
org.apache.camel.CamelContext	getLocalCamelContext(String name) Get a Camel context identified by the given name.
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

Methods inherited from class org.apache.camel.commands.AbstractCamelController

getCamelContexts, loadProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.camel.commands.LocalCamelController

getLocalCamelContexts

Methods inherited from interface org.apache.camel.commands.CamelController

getCamelContexts, getCamelContexts

Constructor Detail

AbstractLocalCamelController

public AbstractLocalCamelController()

Method Detail

getLocalCamelContext

public org.apache.camel.CamelContext getLocalCamelContext(String name)
                                                   throws Exception

Description copied from interface: LocalCamelController

Get a Camel context identified by the given name.

Specified by:

getLocalCamelContext in interface LocalCamelController

Parameters:

name - the Camel context name.

Returns:

the Camel context or null if not found.

Throws:

Exception - can be thrown

getCamelContextInformation

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

Description copied from interface: CamelController

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

Specified by:

getCamelContextInformation in interface CamelController

Parameters:

name - the Camel context name.

Returns:

a list of key/value pairs with CamelContext information

Throws:

Exception - can be thrown

getCamelContextStatsAsXml

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

Description copied from interface: CamelController

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

Specified by:

getCamelContextStatsAsXml in interface CamelController

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

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

Description copied from interface: CamelController

Browses the inflight exchanges

Specified by:

browseInflightExchanges in interface CamelController

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

public void startContext(String camelContextName)
                  throws Exception

Description copied from interface: CamelController

Starts the given Camel context.

Specified by:

startContext in interface CamelController

Parameters:

camelContextName - the Camel context.

Throws:

Exception - can be thrown

stopContext

public void stopContext(String camelContextName)
                 throws Exception

Description copied from interface: CamelController

Stops the given Camel context.

Specified by:

stopContext in interface CamelController

Parameters:

camelContextName - the Camel context.

Throws:

Exception - can be thrown

suspendContext

public void suspendContext(String camelContextName)
                    throws Exception

Description copied from interface: CamelController

Suspends the given Camel context.

Specified by:

suspendContext in interface CamelController

Parameters:

camelContextName - the Camel context.

Throws:

Exception - can be thrown

resumeContext

public void resumeContext(String camelContextName)
                   throws Exception

Description copied from interface: CamelController

Resumes the given Camel context.

Specified by:

resumeContext in interface CamelController

Parameters:

camelContextName - the Camel context.

Throws:

Exception - can be thrown

getRoutes

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

Description copied from interface: CamelController

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

Specified by:

getRoutes in interface CamelController

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

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

Description copied from interface: CamelController

Get all routes filtered by the regex.

Specified by:

getRoutes in interface CamelController

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

public void resetRouteStats(String camelContextName)
                     throws Exception

Description copied from interface: CamelController

Reset all the route stats for the given Camel context

Specified by:

resetRouteStats in interface CamelController

Parameters:

camelContextName - the Camel context.

Throws:

Exception - can be thrown

startRoute

public void startRoute(String camelContextName,
                       String routeId)
                throws Exception

Description copied from interface: CamelController

Starts the given route

Specified by:

startRoute in interface CamelController

Parameters:

camelContextName - the Camel context.

routeId - the route ID.

Throws:

Exception - can be thrown

stopRoute

public void stopRoute(String camelContextName,
                      String routeId)
               throws Exception

Description copied from interface: CamelController

Stops the given route

Specified by:

stopRoute in interface CamelController

Parameters:

camelContextName - the Camel context.

routeId - the route ID.

Throws:

Exception - can be thrown

suspendRoute

public void suspendRoute(String camelContextName,
                         String routeId)
                  throws Exception

Description copied from interface: CamelController

Suspends the given route

Specified by:

suspendRoute in interface CamelController

Parameters:

camelContextName - the Camel context.

routeId - the route ID.

Throws:

Exception - can be thrown

resumeRoute

public void resumeRoute(String camelContextName,
                        String routeId)
                 throws Exception

Description copied from interface: CamelController

Resumes the given route

Specified by:

resumeRoute in interface CamelController

Parameters:

camelContextName - the Camel context.

routeId - the route ID.

Throws:

Exception - can be thrown

getRouteModelAsXml

public String getRouteModelAsXml(String routeId,
                                 String camelContextName)
                          throws Exception

Description copied from interface: CamelController

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

Specified by:

getRouteModelAsXml in interface CamelController

Parameters:

routeId - the route ID.

camelContextName - the Camel context.

Returns:

the route model as XML

Throws:

Exception - can be thrown

getRouteStatsAsXml

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

Description copied from interface: CamelController

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

Specified by:

getRouteStatsAsXml in interface CamelController

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

getRestModelAsXml

public String getRestModelAsXml(String camelContextName)
                         throws Exception

Description copied from interface: CamelController

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

Specified by:

getRestModelAsXml in interface CamelController

Parameters:

camelContextName - the Camel context.

Returns:

the REST model as xml

Throws:

Exception - can be thrown

getRestApiDocAsJson

public String getRestApiDocAsJson(String camelContextName)
                           throws Exception

Description copied from interface: CamelController

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

Specified by:

getRestApiDocAsJson in interface CamelController

Parameters:

camelContextName - the Camel context.

Returns:

the REST API documentation as JSon

Throws:

Exception - can be thrown

getEndpoints

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

Description copied from interface: CamelController

Return the endpoints

Specified by:

getEndpoints in interface CamelController

Parameters:

camelContextName - the Camel context.

Returns:

a list of key/value pairs with endpoint information

Throws:

Exception - can be thrown

getEndpointRuntimeStatistics

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

Description copied from interface: CamelController

Return endpoint runtime statistics

Specified by:

getEndpointRuntimeStatistics in interface CamelController

Parameters:

camelContextName - the Camel context

Returns:

a list of key/value pairs with endpoint runtime statistics

Throws:

Exception - can be thrown

getRestServices

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

Description copied from interface: CamelController

Return the REST services for the given Camel context.

Specified by:

getRestServices in interface CamelController

Parameters:

camelContextName - the Camel context.

Returns:

a list of key/value pairs with REST information

Throws:

Exception - can be thrown

explainEndpointAsJSon

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

Description copied from interface: CamelController

Explains an endpoint uri

Specified by:

explainEndpointAsJSon in interface CamelController

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

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

Description copied from interface: CamelController

Explains an EIP

Specified by:

explainEipAsJSon in interface CamelController

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

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

Description copied from interface: CamelController

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

Specified by:

listComponents in interface CamelController

Parameters:

camelContextName - the Camel context.

Returns:

a list of key/value pairs with component information

Throws:

Exception - can be thrown

getTransformers

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

Description copied from interface: CamelController

Return the transformers

Specified by:

getTransformers in interface CamelController

Parameters:

camelContextName - the Camel context.

Returns:

a list of key/value pairs with transformer information

Throws:

Exception - can be thrown

getValidators

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

Description copied from interface: CamelController

Return the validators

Specified by:

getValidators in interface CamelController

Parameters:

camelContextName - the Camel context.

Returns:

a list of key/value pairs with validator information

Throws:

Exception - can be thrown