CamelContext (Camel :: Core 2.21.0 API)

All Superinterfaces:

RuntimeConfiguration, Service, SuspendableService

All Known Subinterfaces:

ModelCamelContext

All Known Implementing Classes:

DefaultCamelContext
```
public interface CamelContext
extends SuspendableService, RuntimeConfiguration
```
Interface used to represent the CamelContext used to configure routes and the policies to use during message exchanges between endpoints.
The CamelContext offers the following methods to control the lifecycle:
- start() - to start (important: the start method is not blocked, see more details here)
- stop() - to shutdown (will stop all routes/components/endpoints etc and clear internal state/cache)
- SuspendableService.suspend() - to pause routing messages
- SuspendableService.resume() - to resume after a suspend
Notice: stop() and SuspendableService.suspend() will gracefully stop/suspend routes ensuring any messages in progress will be given time to complete. See more details at ShutdownStrategy.
If you are doing a hot restart then it's advised to use the suspend/resume methods which ensure a faster restart but also allows any internal state to be kept as is. The stop/start approach will do a cold restart of Camel, where all internal state is reset.
End users are advised to use suspend/resume. Using stop is for shutting down Camel and it's not guaranteed that when it's being started again using the start method that Camel will operate consistently.
Version:

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`<T extends CamelContext> T`	`adapt(Class<T> type)` Adapts this `CamelContext` to the specialized type.
`void`	`addComponent(String componentName, Component component)` Adds a component to the context.
`Endpoint`	`addEndpoint(String uri, Endpoint endpoint)` Adds the endpoint to the `EndpointRegistry` using the given URI.
`void`	`addHystrixConfiguration(String id, HystrixConfigurationDefinition configuration)` Adds the Hystrix configuration
`void`	`addInterceptStrategy(InterceptStrategy interceptStrategy)` Adds the given interceptor strategy
`void`	`addLifecycleStrategy(LifecycleStrategy lifecycleStrategy)` Adds the given lifecycle strategy to be used.
`void`	`addLogListener(LogListener listener)` Adds a `LogListener`.
`void`	`addRegisterEndpointCallback(EndpointStrategy strategy)` Registers a `callback` to allow you to do custom logic when an `Endpoint` is about to be registered to the `EndpointRegistry`.
`void`	`addRestConfiguration(RestConfiguration restConfiguration)` Sets a custom `RestConfiguration`
`void`	`addRestDefinitions(Collection<RestDefinition> restDefinitions)` Adds a collection of rest definitions to the context
`void`	`addRouteDefinition(RouteDefinition routeDefinition)` Add a route definition to the context
`void`	`addRouteDefinitions(Collection<RouteDefinition> routeDefinitions)` Adds a collection of route definitions to the context
`void`	`addRoutePolicyFactory(RoutePolicyFactory routePolicyFactory)` Adds the given route policy factory
`void`	`addRoutes(RoutesBuilder builder)` Adds a collection of routes to this CamelContext using the given builder to build them.
`void`	`addService(Object object)` Adds a service to this CamelContext, which allows this CamelContext to control the lifecycle, ensuring the service is stopped when the CamelContext stops.
`void`	`addService(Object object, boolean stopOnShutdown)` Adds a service to this CamelContext.
`void`	`addService(Object object, boolean stopOnShutdown, boolean forceStart)` Adds a service to this CamelContext.
`void`	`addServiceCallConfiguration(String serviceName, ServiceCallConfigurationDefinition configuration)` Adds the service call configuration
`void`	`addStartupListener(StartupListener listener)` Adds the given listener to be invoked when `CamelContext` have just been started.
`ConsumerTemplate`	`createConsumerTemplate()` Creates a new `ConsumerTemplate` which is started and therefore ready to use right away.
`ConsumerTemplate`	`createConsumerTemplate(int maximumCacheSize)` Creates a new `ConsumerTemplate` which is started and therefore ready to use right away.
`DataFormat`	`createDataFormat(String name)` Creates the given data format given its name.
`FluentProducerTemplate`	`createFluentProducerTemplate()` Creates a new `FluentProducerTemplate` which is started and therefore ready to use right away.
`FluentProducerTemplate`	`createFluentProducerTemplate(int maximumCacheSize)` Creates a new `FluentProducerTemplate` which is started and therefore ready to use right away.
`ProducerTemplate`	`createProducerTemplate()` Creates a new `ProducerTemplate` which is started and therefore ready to use right away.
`ProducerTemplate`	`createProducerTemplate(int maximumCacheSize)` Creates a new `ProducerTemplate` which is started and therefore ready to use right away.
`String`	`createRouteStaticEndpointJson(String routeId)` Creates a JSON representation of all the static and dynamic configured endpoints defined in the given route(s).
`String`	`createRouteStaticEndpointJson(String routeId, boolean includeDynamic)` Creates a JSON representation of all the static (and possible dynamic) configured endpoints defined in the given route(s).
`void`	`deferStartService(Object object, boolean stopOnShutdown)` Defers starting the service until `CamelContext` is (almost started) or started and has initialized all its prior services and routes.
`void`	`disableJMX()` Disables using JMX as `ManagementStrategy`.
`String`	`explainComponentJson(String componentName, boolean includeAllOptions)` Returns a JSON schema representation of the component parameters (not endpoint parameters) for the given component by its id.
`String`	`explainDataFormatJson(String dataFormatName, DataFormat dataFormat, boolean includeAllOptions)` Returns a JSON schema representation of the component parameters (not endpoint parameters) for the given component by its id.
`String`	`explainEipJson(String nameOrId, boolean includeAllOptions)` Returns a JSON schema representation of the EIP parameters for the given EIP by its id.
`String`	`explainEndpointJson(String uri, boolean includeAllOptions)` Returns a JSON schema representation of the endpoint parameters for the given endpoint uri.
`Map<String,Properties>`	`findComponents()` Find information about all the Camel components available in the classpath and `Registry`.
`Map<String,Properties>`	`findEips()` Find information about all the EIPs from camel-core.
`ClassLoader`	`getApplicationContextClassLoader()` Gets the the application CamelContext class loader which may be helpful for running camel in other containers
`AsyncProcessorAwaitManager`	`getAsyncProcessorAwaitManager()` Gets the `AsyncProcessor` await manager.
`ClassResolver`	`getClassResolver()` Returns the class resolver to be used for loading/lookup of classes.
`Component`	`getComponent(String componentName)` Gets a component from the CamelContext by name.
`Component`	`getComponent(String name, boolean autoCreateComponents)` Gets a component from the CamelContext by name.
`Component`	`getComponent(String name, boolean autoCreateComponents, boolean autoStart)` Gets a component from the CamelContext by name.
`<T extends Component> T`	`getComponent(String name, Class<T> componentType)` Gets a component from the CamelContext by name and specifying the expected type of component.
`String`	`getComponentDocumentation(String componentName)` Deprecated. use camel-catalog instead
`List<String>`	`getComponentNames()` Gets a readonly list of names of the components currently registered
`String`	`getComponentParameterJsonSchema(String componentName)` Returns the JSON schema representation of the component and endpoint parameters for the given component name.
`String`	`getDataFormatParameterJsonSchema(String dataFormatName)` Returns the JSON schema representation of the `DataFormat` parameters for the given data format name.
`DataFormatResolver`	`getDataFormatResolver()` Gets the current data format resolver
`Map<String,DataFormatDefinition>`	`getDataFormats()` Gets the data formats that can be referenced in the routes.
`Debugger`	`getDebugger()` Gets the current `Debugger`
`InterceptStrategy`	`getDefaultBacklogDebugger()` Gets the default backlog debugger
`InterceptStrategy`	`getDefaultBacklogTracer()` Gets the default backlog tracer
`FactoryFinder`	`getDefaultFactoryFinder()` Gets the default FactoryFinder which will be used for the loading the factory class from META-INF
`InterceptStrategy`	`getDefaultTracer()` Gets the default tracer
`String`	`getEipParameterJsonSchema(String eipName)` Returns the JSON schema representation of the EIP parameters for the given EIP name.
`Endpoint`	`getEndpoint(String uri)` Resolves the given name to an `Endpoint` of the specified type.
`<T extends Endpoint> T`	`getEndpoint(String name, Class<T> endpointType)` Resolves the given name to an `Endpoint` of the specified type.
`Map<String,Endpoint>`	`getEndpointMap()` Returns a new `Map` containing all of the endpoints from the `EndpointRegistry`
`EndpointRegistry<String>`	`getEndpointRegistry()` Gets the `EndpointRegistry`
`Collection<Endpoint>`	`getEndpoints()` Returns a new `Collection` of all of the endpoints from the `EndpointRegistry`
`ErrorHandlerBuilder`	`getErrorHandlerBuilder()` Deprecated. The return type will be switched to `ErrorHandlerFactory` in Camel 3.0
`ScheduledExecutorService`	`getErrorHandlerExecutorService()` Gets the default shared thread pool for error handlers which leverages this for asynchronous redelivery tasks.
`ExecutorServiceManager`	`getExecutorServiceManager()` Gets the current `ExecutorServiceManager`
`ExecutorServiceStrategy`	`getExecutorServiceStrategy()` Deprecated. use `getExecutorServiceManager()`
`FactoryFinder`	`getFactoryFinder(String path)` Gets the FactoryFinder which will be used for the loading the factory class from META-INF in the given path
`String`	`getGlobalOption(String key)` Gets the global option value that can be referenced in the camel context Important: This has nothing to do with property placeholders, and is just a plain set of key/value pairs which are used to configure global options on CamelContext, such as a maximum debug logging length etc.
`Map<String,String>`	`getGlobalOptions()` Gets global options that can be referenced in the camel context.
`HeadersMapFactory`	`getHeadersMapFactory()` Gets the `HeadersMapFactory` to use.
`HealthCheckRegistry`	`getHealthCheckRegistry()` Returns an optional `HealthCheckRegistry`, by default no registry is present and it must be explicit activated.
`HystrixConfigurationDefinition`	`getHystrixConfiguration(String id)` Gets the Hystrix configuration by the given name.
`InflightRepository`	`getInflightRepository()` Gets the inflight repository
`Injector`	`getInjector()` Returns the injector used to instantiate objects by type
`List<InterceptStrategy>`	`getInterceptStrategies()` Gets the interceptor strategies
`List<String>`	`getLanguageNames()` Gets a readonly list with the names of the languages currently registered.
`String`	`getLanguageParameterJsonSchema(String languageName)` Returns the JSON schema representation of the `Language` parameters for the given language name.
`List<LifecycleStrategy>`	`getLifecycleStrategies()` Returns the lifecycle strategies used to handle lifecycle notifications
`Set<LogListener>`	`getLogListeners()` Gets a list of `LogListener`.
`ManagedCamelContextMBean`	`getManagedCamelContext()` Gets the managed Camel CamelContext client api
`<T extends ManagedProcessorMBean> T`	`getManagedProcessor(String id, Class<T> type)` Gets the managed processor client api from any of the routes which with the given id
`<T extends ManagedRouteMBean> T`	`getManagedRoute(String routeId, Class<T> type)` Gets the managed route client api with the given route id
`ManagementMBeanAssembler`	`getManagementMBeanAssembler()` Returns the management mbean assembler
`String`	`getManagementName()` Gets the name this `CamelContext` was registered in JMX.
`ManagementNameStrategy`	`getManagementNameStrategy()` Gets the current management name strategy
`ManagementStrategy`	`getManagementStrategy()` Gets the management strategy
`MessageHistoryFactory`	`getMessageHistoryFactory()` Gets the current `MessageHistoryFactory`
`ModelJAXBContextFactory`	`getModelJAXBContextFactory()` Returns the JAXB Context factory used to create Models.
`String`	`getName()` Gets the name (id) of the this CamelContext.
`CamelContextNameStrategy`	`getNameStrategy()` Gets the current name strategy
`NodeIdFactory`	`getNodeIdFactory()` Gets the node id factory
`PackageScanClassResolver`	`getPackageScanClassResolver()` Returns the package scanning class resolver
`ServicePool<Endpoint,PollingConsumer>`	`getPollingConsumerServicePool()` Gets the service pool for `Producer` pooling.
`Processor`	`getProcessor(String id)` Gets the processor from any of the routes which with the given id
`<T extends Processor> T`	`getProcessor(String id, Class<T> type)` Gets the processor from any of the routes which with the given id
`ProcessorDefinition`	`getProcessorDefinition(String id)` Gets the processor definition from any of the routes which with the given id
`<T extends ProcessorDefinition> T`	`getProcessorDefinition(String id, Class<T> type)` Gets the processor definition from any of the routes which with the given id
`ProcessorFactory`	`getProcessorFactory()` Gets the current `ProcessorFactory`
`ServicePool<Endpoint,Producer>`	`getProducerServicePool()` Gets the service pool for `Producer` pooling.
`Map<String,String>`	`getProperties()` Deprecated. use `getGlobalOptions()` instead.
`String`	`getProperty(String key)` Deprecated. use `getGlobalOption(String)` instead.
`String`	`getPropertyPrefixToken()` Returns the configured property placeholder prefix token if and only if the CamelContext has property placeholder abilities, otherwise returns `null`.
`String`	`getPropertySuffixToken()` Returns the configured property placeholder suffix token if and only if the CamelContext has property placeholder abilities, otherwise returns `null`.
`Registry`	`getRegistry()` Returns the registry used to lookup components by name and type such as the Spring ApplicationContext, JNDI or the OSGi Service Registry
`<T> T`	`getRegistry(Class<T> type)` Returns the registry used to lookup components by name and as the given type
`ReloadStrategy`	`getReloadStrategy()` Returns the `ReloadStrategy` if in use.
`RestConfiguration`	`getRestConfiguration()` Gets the default REST configuration
`RestConfiguration`	`getRestConfiguration(String component, boolean defaultIfNotFound)` Gets the REST configuration for the given component
`Collection<RestConfiguration>`	`getRestConfigurations()` Gets all the RestConfiguration's
`List<RestDefinition>`	`getRestDefinitions()` Returns a list of the current REST definitions
`RestRegistry`	`getRestRegistry()` Gets the `RestRegistry` to use
`Route`	`getRoute(String id)` Gets the route with the given id
`RouteController`	`getRouteController()` NOTE: experimental api
`RouteDefinition`	`getRouteDefinition(String id)` Gets the route definition with the given id
`List<RouteDefinition>`	`getRouteDefinitions()` Returns a list of the current route definitions
`List<RoutePolicyFactory>`	`getRoutePolicyFactories()` Gets the route policy factories
`List<Route>`	`getRoutes()` Returns the current routes in this CamelContext
`List<RouteStartupOrder>`	`getRouteStartupOrder()` Returns the order in which the route inputs was started.
`ServiceStatus`	`getRouteStatus(String routeId)` Returns the current status of the given route
`RuntimeCamelCatalog`	`getRuntimeCamelCatalog()` Gets the associated `RuntimeCamelCatalog` for this CamelContext.
`RuntimeEndpointRegistry`	`getRuntimeEndpointRegistry()` Gets the `RuntimeEndpointRegistry` to use, or `null` if none is in use.
`ServiceCallConfigurationDefinition`	`getServiceCallConfiguration(String serviceName)` Gets the service call configuration by the given name.
`ShutdownStrategy`	`getShutdownStrategy()` Gets the current shutdown strategy
`SSLContextParameters`	`getSSLContextParameters()` Gets the global SSL context parameters if configured.
`ServiceStatus`	`getStatus()` Get the status of this CamelContext
`StreamCachingStrategy`	`getStreamCachingStrategy()` Gets the `StreamCachingStrategy` to use.
`TransformerRegistry`	`getTransformerRegistry()` Gets the `TransformerRegistry`
`List<TransformerDefinition>`	`getTransformers()` Gets the transformers that can be referenced in the routes.
`TypeConverter`	`getTypeConverter()` Returns the type converter used to coerce types from one type to another
`TypeConverterRegistry`	`getTypeConverterRegistry()` Returns the type converter registry where type converters can be added or looked up
`UnitOfWorkFactory`	`getUnitOfWorkFactory()` Gets the `UnitOfWorkFactory` to use.
`String`	`getUptime()` Gets the uptime in a human readable format
`long`	`getUptimeMillis()` Gets the uptime in milli seconds
`UuidGenerator`	`getUuidGenerator()` Gets the current `UuidGenerator`
`ValidatorRegistry`	`getValidatorRegistry()` Gets the `ValidatorRegistry`
`List<ValidatorDefinition>`	`getValidators()` Gets the validators that can be referenced in the routes.
`String`	`getVersion()` Gets the version of the this CamelContext.
`Component`	`hasComponent(String componentName)` Is the given component already registered?
`Endpoint`	`hasEndpoint(String uri)` Is the given endpoint already registered in the `EndpointRegistry`
`<T> T`	`hasService(Class<T> type)` Has the given service type already been added to this CamelContext?
`boolean`	`hasService(Object object)` Has the given service already been added to this CamelContext?
`<T> Set<T>`	`hasServices(Class<T> type)` Has the given service type already been added to this CamelContext?
`Boolean`	`isLazyLoadTypeConverters()` Deprecated. this option is no longer supported, will be removed in a future Camel release.
`Boolean`	`isLoadTypeConverters()` Sets whether to load custom type converters by scanning classpath.
`boolean`	`isSetupRoutes()` Indicates whether current thread is setting up route(s) as part of starting Camel from spring/blueprint.
`boolean`	`isStartingRoutes()` Indicates whether current thread is starting route(s).
`Boolean`	`isTypeConverterStatisticsEnabled()` Whether or not type converter statistics is enabled.
`Boolean`	`isUseBreadcrumb()` Whether or not breadcrumb is enabled.
`Boolean`	`isUseDataType()` Whether to enable using data type on Camel messages.
`Boolean`	`isUseMDCLogging()` Whether or not MDC logging is being enabled.
`boolean`	`isVetoStarted()` If CamelContext during the start procedure was vetoed, and therefore causing Camel to not start.
`RestsDefinition`	`loadRestsDefinition(InputStream is)` Loads a collection of rest definitions from the given `InputStream`.
`RoutesDefinition`	`loadRoutesDefinition(InputStream is)` Loads a collection of route definitions from the given `InputStream`.
`Component`	`removeComponent(String componentName)` Removes a previously added component.
`void`	`removeEndpoint(Endpoint endpoint)` Removes the endpoint from the `EndpointRegistry`.
`Collection<Endpoint>`	`removeEndpoints(String pattern)` Removes all endpoints with the given URI from the `EndpointRegistry`.
`boolean`	`removeRoute(String routeId)` Removes the given route (the route must be stopped before it can be removed).
`void`	`removeRouteDefinition(RouteDefinition routeDefinition)` Removes a route definition from the CamelContext - stopping any previously running routes if any of them are actively running
`void`	`removeRouteDefinitions(Collection<RouteDefinition> routeDefinitions)` Removes a collection of route definitions from the CamelContext - stopping any previously running routes if any of them are actively running
`boolean`	`removeService(Object object)` Removes a service from this CamelContext.
`String`	`resolveComponentDefaultName(String javaType)` Resolves a component's default name from its java type.
`DataFormat`	`resolveDataFormat(String name)` Resolve a data format given its name
`DataFormatDefinition`	`resolveDataFormatDefinition(String name)` Resolve a data format definition given its name
`Language`	`resolveLanguage(String language)` Resolves a language for creating expressions
`String`	`resolvePropertyPlaceholders(String text)` Parses the given text and resolve any property placeholders - using {{key}}.
`Transformer`	`resolveTransformer(DataType from, DataType to)` Resolve a transformer given from/to data type.
`Transformer`	`resolveTransformer(String model)` Resolve a transformer given a scheme
`Validator`	`resolveValidator(DataType type)` Resolve a validator given from/to data type.
`void`	`resumeRoute(String routeId)` Resumes the given route if it has been previously suspended If the route does not support suspension the route will be started instead
`void`	`setApplicationContextClassLoader(ClassLoader classLoader)` Sets the application CamelContext class loader
`void`	`setAsyncProcessorAwaitManager(AsyncProcessorAwaitManager manager)` Sets a custom `AsyncProcessor` await manager.
`void`	`setClassResolver(ClassResolver resolver)` Sets the class resolver to be use
`void`	`setDataFormatResolver(DataFormatResolver dataFormatResolver)` Sets a custom data format resolver
`void`	`setDataFormats(Map<String,DataFormatDefinition> dataFormats)` Sets the data formats that can be referenced in the routes.
`void`	`setDebugger(Debugger debugger)` Sets a custom `Debugger`
`void`	`setDefaultBacklogDebugger(InterceptStrategy backlogDebugger)` Sets a custom backlog debugger to be used as the default backlog debugger.
`void`	`setDefaultBacklogTracer(InterceptStrategy backlogTracer)` Sets a custom backlog tracer to be used as the default backlog tracer.
`void`	`setDefaultTracer(InterceptStrategy tracer)` Sets a custom tracer to be used as the default tracer.
`void`	`setErrorHandlerBuilder(ErrorHandlerFactory errorHandlerBuilder)` Sets the default error handler builder which is inherited by the routes
`void`	`setExecutorServiceManager(ExecutorServiceManager executorServiceManager)` Sets a custom `ExecutorServiceManager`
`void`	`setFactoryFinderResolver(FactoryFinderResolver resolver)` Sets the factory finder resolver to use.
`void`	`setGlobalOptions(Map<String,String> globalOptions)` Sets global options that can be referenced in the camel context Important: This has nothing to do with property placeholders, and is just a plain set of key/value pairs which are used to configure global options on CamelContext, such as a maximum debug logging length etc.
`void`	`setHeadersMapFactory(HeadersMapFactory factory)` Sets a custom `HeadersMapFactory` to be used.
`void`	`setHealthCheckRegistry(HealthCheckRegistry healthCheckRegistry)` Sets a `HealthCheckRegistry`.
`void`	`setHystrixConfiguration(HystrixConfigurationDefinition configuration)` Sets the default Hystrix configuration
`void`	`setHystrixConfigurations(List<HystrixConfigurationDefinition> configurations)` Sets the Hystrix configurations
`void`	`setInflightRepository(InflightRepository repository)` Sets a custom inflight repository to use
`void`	`setLazyLoadTypeConverters(Boolean lazyLoadTypeConverters)` Deprecated. this option is no longer supported, will be removed in a future Camel release.
`void`	`setLoadTypeConverters(Boolean loadTypeConverters)` Sets whether to load custom type converters by scanning classpath.
`void`	`setManagementNameStrategy(ManagementNameStrategy nameStrategy)` Sets a custom management name strategy
`void`	`setManagementStrategy(ManagementStrategy strategy)` Sets the management strategy to use
`void`	`setMessageHistoryFactory(MessageHistoryFactory messageHistoryFactory)` Sets a custom `MessageHistoryFactory`
`void`	`setModelJAXBContextFactory(ModelJAXBContextFactory modelJAXBContextFactory)` Sets a custom JAXB Context factory to be used
`void`	`setNameStrategy(CamelContextNameStrategy nameStrategy)` Sets a custom name strategy
`void`	`setNodeIdFactory(NodeIdFactory factory)` Uses a custom node id factory when generating auto assigned ids to the nodes in the route definitions
`void`	`setPackageScanClassResolver(PackageScanClassResolver resolver)` Sets the package scanning class resolver to use
`void`	`setPollingConsumerServicePool(ServicePool<Endpoint,PollingConsumer> servicePool)` Sets a pluggable service pool to use for `PollingConsumer` pooling.
`void`	`setProcessorFactory(ProcessorFactory processorFactory)` Sets a custom `ProcessorFactory`
`void`	`setProducerServicePool(ServicePool<Endpoint,Producer> servicePool)` Sets a pluggable service pool to use for `Producer` pooling.
`void`	`setProperties(Map<String,String> properties)` Deprecated. use `setGlobalOptions(Map) instead`.
`void`	`setReloadStrategy(ReloadStrategy reloadStrategy)` Sets a custom `ReloadStrategy` to be used
`void`	`setRestConfiguration(RestConfiguration restConfiguration)` Sets a custom `RestConfiguration`
`void`	`setRestRegistry(RestRegistry restRegistry)` Sets a custom `RestRegistry` to use.
`void`	`setRouteController(RouteController routeController)` NOTE: experimental api
`void`	`setRuntimeEndpointRegistry(RuntimeEndpointRegistry runtimeEndpointRegistry)` Sets a custom `RuntimeEndpointRegistry` to use.
`void`	`setServiceCallConfiguration(ServiceCallConfigurationDefinition configuration)` Sets the default service call configuration
`void`	`setServiceCallConfigurations(List<ServiceCallConfigurationDefinition> configurations)` Sets the service call configurations
`void`	`setShutdownStrategy(ShutdownStrategy shutdownStrategy)` Sets a custom shutdown strategy
`void`	`setSSLContextParameters(SSLContextParameters sslContextParameters)` Sets the global SSL context parameters.
`void`	`setStreamCachingStrategy(StreamCachingStrategy streamCachingStrategy)` Sets a custom `StreamCachingStrategy` to use.
`void`	`setTransformers(List<TransformerDefinition> transformers)` Sets the transformers that can be referenced in the routes.
`void`	`setTypeConverterStatisticsEnabled(Boolean typeConverterStatisticsEnabled)` Sets whether or not type converter statistics is enabled.
`void`	`setUnitOfWorkFactory(UnitOfWorkFactory unitOfWorkFactory)` Sets a custom `UnitOfWorkFactory` to use.
`void`	`setupRoutes(boolean done)` Method to signal to `CamelContext` that the process to initialize setup routes is in progress.
`void`	`setUseBreadcrumb(Boolean useBreadcrumb)` Set whether breadcrumb is enabled.
`void`	`setUseDataType(Boolean useDataType)` Whether to enable using data type on Camel messages.
`void`	`setUseMDCLogging(Boolean useMDCLogging)` Set whether MDC is enabled.
`void`	`setUuidGenerator(UuidGenerator uuidGenerator)` Sets a custom `UuidGenerator` (should only be set once)
`void`	`setValidators(List<ValidatorDefinition> validators)` Sets the validators that can be referenced in the routes.
`void`	`shutdownRoute(String routeId)` Deprecated. use `stopRoute(String)` and `removeRoute(String)`
`void`	`shutdownRoute(String routeId, long timeout, TimeUnit timeUnit)` Deprecated. use `stopRoute(String, long, java.util.concurrent.TimeUnit)` and `removeRoute(String)`
`void`	`start()` Starts the `CamelContext` (important: the start method is not blocked, see more details here).
`void`	`startAllRoutes()` Starts all the routes which currently is not started.
`void`	`startRoute(RouteDefinition route)` Deprecated. favor using `startRoute(String)`
`void`	`startRoute(String routeId)` Starts the given route if it has been previously stopped
`void`	`stop()` Stop and shutdown the `CamelContext` (will stop all routes/components/endpoints etc and clear internal state/cache).
`void`	`stopRoute(RouteDefinition route)` Deprecated. favor using `stopRoute(String)`
`void`	`stopRoute(String routeId)` Stops the given route using `ShutdownStrategy`.
`void`	`stopRoute(String routeId, long timeout, TimeUnit timeUnit)` Stops the given route using `ShutdownStrategy` with a specified timeout.
`boolean`	`stopRoute(String routeId, long timeout, TimeUnit timeUnit, boolean abortAfterTimeout)` Stops the given route using `ShutdownStrategy` with a specified timeout and optional abortAfterTimeout mode.
`void`	`suspendRoute(String routeId)` Suspends the given route using `ShutdownStrategy`.
`void`	`suspendRoute(String routeId, long timeout, TimeUnit timeUnit)` Suspends the given route using `ShutdownStrategy` with a specified timeout.

Methods inherited from interface org.apache.camel.SuspendableService
isSuspended, resume, suspend

Methods inherited from interface org.apache.camel.RuntimeConfiguration
getDelayer, getShutdownRoute, getShutdownRunningTask, isAllowUseOriginalMessage, isAutoStartup, isHandleFault, isLogExhaustedMessageBody, isLogMask, isMessageHistory, isStreamCaching, isTracing, setAllowUseOriginalMessage, setAutoStartup, setDelayer, setHandleFault, setLogExhaustedMessageBody, setLogMask, setMessageHistory, setShutdownRoute, setShutdownRunningTask, setStreamCaching, setTracing

- Method Detail
  - adapt
```
<T extends CamelContext> T adapt(Class<T> type)
```
    Adapts this CamelContext to the specialized type.
    For example to adapt to ModelCamelContext, or SpringCamelContext, or CdiCamelContext, etc.
    
    Parameters:
    
    type - the type to adapt to
    
    Returns:
    
    this CamelContext adapted to the given type
  - isVetoStarted
```
boolean isVetoStarted()
```
    If CamelContext during the start procedure was vetoed, and therefore causing Camel to not start.
  - start
```
void start()
    throws Exception
```
    Starts the CamelContext (important: the start method is not blocked, see more details here)

Specified by:: start in interface Service
Throws:: Exception - is thrown if starting failed

stop
```
void stop()
   throws Exception
```
Stop and shutdown the CamelContext (will stop all routes/components/endpoints etc and clear internal state/cache).
See more details at the class-level javadoc of this class.

Specified by:

stop in interface Service

Throws:

Exception - is thrown if stopping failed

getName
```
String getName()
```
Gets the name (id) of the this CamelContext.

Returns:

the name

getNameStrategy
```
CamelContextNameStrategy getNameStrategy()
```
Gets the current name strategy

Returns:

name strategy

setNameStrategy
```
void setNameStrategy(CamelContextNameStrategy nameStrategy)
```
Sets a custom name strategy

Parameters:

nameStrategy - name strategy

getManagementNameStrategy
```
ManagementNameStrategy getManagementNameStrategy()
```
Gets the current management name strategy

Returns:

management name strategy

setManagementNameStrategy
```
void setManagementNameStrategy(ManagementNameStrategy nameStrategy)
```
Sets a custom management name strategy

Parameters:

nameStrategy - name strategy

getManagementName
```
String getManagementName()
```
Gets the name this CamelContext was registered in JMX.
The reason that a CamelContext can have a different name in JMX is the fact to remedy for name clash in JMX when having multiple CamelContexts in the same JVM. Camel will automatic reassign and use a free name to avoid failing to start.

Returns:

the management name

getVersion
```
String getVersion()
```
Gets the version of the this CamelContext.

Returns:

the version

getStatus
```
ServiceStatus getStatus()
```
Get the status of this CamelContext

Returns:

the status

getUptime
```
String getUptime()
```
Gets the uptime in a human readable format

Returns:

the uptime in days/hours/minutes

getUptimeMillis
```
long getUptimeMillis()
```
Gets the uptime in milli seconds

Returns:

the uptime in millis seconds

addService
```
void addService(Object object)
         throws Exception
```
Adds a service to this CamelContext, which allows this CamelContext to control the lifecycle, ensuring the service is stopped when the CamelContext stops.
The service will also have CamelContext injected if its CamelContextAware. The service will also be enlisted in JMX for management (if JMX is enabled). The service will be started, if its not already started.

Parameters:

object - the service

Throws:

Exception - can be thrown when starting the service

addService
```
void addService(Object object,
                boolean stopOnShutdown)
         throws Exception
```
Adds a service to this CamelContext.
The service will also have CamelContext injected if its CamelContextAware. The service will also be enlisted in JMX for management (if JMX is enabled). The service will be started, if its not already started.
If the option closeOnShutdown is true then this CamelContext will control the lifecycle, ensuring the service is stopped when the CamelContext stops. If the option closeOnShutdown is false then this CamelContext will not stop the service when the CamelContext stops.

Parameters:

object - the service

stopOnShutdown - whether to stop the service when this CamelContext shutdown.

Throws:

Exception - can be thrown when starting the service

addService
```
void addService(Object object,
                boolean stopOnShutdown,
                boolean forceStart)
         throws Exception
```
Adds a service to this CamelContext.
The service will also have CamelContext injected if its CamelContextAware. The service will also be enlisted in JMX for management (if JMX is enabled). The service will be started, if its not already started.
If the option closeOnShutdown is true then this CamelContext will control the lifecycle, ensuring the service is stopped when the CamelContext stops. If the option closeOnShutdown is false then this CamelContext will not stop the service when the CamelContext stops.

Parameters:

object - the service

stopOnShutdown - whether to stop the service when this CamelContext shutdown.

forceStart - whether to force starting the service right now, as otherwise the service may be deferred being started to later using deferStartService(Object, boolean)

Throws:

Exception - can be thrown when starting the service

removeService
```
boolean removeService(Object object)
               throws Exception
```
Removes a service from this CamelContext.
The service is assumed to have been previously added using addService(Object) method. This method will not change the service lifecycle.

Parameters:

object - the service

Returns:

true if the service was removed, false if no service existed

Throws:

Exception - can be thrown if error removing the service

hasService
```
boolean hasService(Object object)
```
Has the given service already been added to this CamelContext?

Parameters:

object - the service

Returns:

true if already added, false if not.

hasService
```
<T> T hasService(Class<T> type)
```
Has the given service type already been added to this CamelContext?

Parameters:

type - the class type

Returns:

the service instance or null if not already added.

hasServices
```
<T> Set<T> hasServices(Class<T> type)
```
Has the given service type already been added to this CamelContext?

Parameters:

type - the class type

Returns:

the services instance or empty set.

deferStartService
```
void deferStartService(Object object,
                       boolean stopOnShutdown)
                throws Exception
```
Defers starting the service until CamelContext is (almost started) or started and has initialized all its prior services and routes.
If CamelContext is already started then the service is started immediately.

Parameters:

object - the service

stopOnShutdown - whether to stop the service when this CamelContext shutdown. Setting this to true will keep a reference to the service in this CamelContext until the CamelContext is stopped. So do not use it for short lived services.

Throws:

Exception - can be thrown when starting the service, which is only attempted if CamelContext has already been started when calling this method.

addStartupListener
```
void addStartupListener(StartupListener listener)
                 throws Exception
```
Adds the given listener to be invoked when CamelContext have just been started.
This allows listeners to do any custom work after the routes and other services have been started and are running.
Important: The listener will always be invoked, also if the CamelContext has already been started, see the StartupListener.onCamelContextStarted(CamelContext, boolean) method.

Parameters:

listener - the listener

Throws:

Exception - can be thrown if CamelContext is already started and the listener is invoked and cause an exception to be thrown

addComponent
```
void addComponent(String componentName,
                  Component component)
```
Adds a component to the context.

Parameters:

componentName - the name the component is registered as

component - the component

hasComponent
```
Component hasComponent(String componentName)
```
Is the given component already registered?

Parameters:

componentName - the name of the component

Returns:

the registered Component or null if not registered

getComponent
```
Component getComponent(String componentName)
```
Gets a component from the CamelContext by name.
Notice the returned component will be auto-started. If you do not intend to do that then use getComponent(String, boolean, boolean).

Parameters:

componentName - the name of the component

Returns:

the component

getComponent
```
Component getComponent(String name,
                       boolean autoCreateComponents)
```
Gets a component from the CamelContext by name.
Notice the returned component will be auto-started. If you do not intend to do that then use getComponent(String, boolean, boolean).

Parameters:

name - the name of the component

autoCreateComponents - whether or not the component should be lazily created if it does not already exist

Returns:

the component

getComponent
```
Component getComponent(String name,
                       boolean autoCreateComponents,
                       boolean autoStart)
```
Gets a component from the CamelContext by name.

Parameters:

name - the name of the component

autoCreateComponents - whether or not the component should be lazily created if it does not already exist

autoStart - whether to auto start the component if CamelContext is already started.

Returns:

the component

getComponent
```
<T extends Component> T getComponent(String name,
                                     Class<T> componentType)
```
Gets a component from the CamelContext by name and specifying the expected type of component.

Parameters:

name - the name to lookup

componentType - the expected type

Returns:

the component

getComponentNames
```
List<String> getComponentNames()
```
Gets a readonly list of names of the components currently registered

Returns:

a readonly list with the names of the the components

removeComponent
```
Component removeComponent(String componentName)
```
Removes a previously added component.
The component being removed will be stopped first.

Parameters:

componentName - the component name to remove

Returns:

the previously added component or null if it had not been previously added.

getEndpointRegistry

EndpointRegistry<String> getEndpointRegistry()

Gets the EndpointRegistry

getEndpoint
```
Endpoint getEndpoint(String uri)
```
Resolves the given name to an Endpoint of the specified type. If the name has a singleton endpoint registered, then the singleton is returned. Otherwise, a new Endpoint is created and registered in the EndpointRegistry.

Parameters:

uri - the URI of the endpoint

Returns:

the endpoint

getEndpoint
```
<T extends Endpoint> T getEndpoint(String name,
                                   Class<T> endpointType)
```
Resolves the given name to an Endpoint of the specified type. If the name has a singleton endpoint registered, then the singleton is returned. Otherwise, a new Endpoint is created and registered in the EndpointRegistry.

Parameters:

name - the name of the endpoint

endpointType - the expected type

Returns:

the endpoint

getEndpoints
```
Collection<Endpoint> getEndpoints()
```
Returns a new Collection of all of the endpoints from the EndpointRegistry

Returns:

all endpoints

getEndpointMap
```
Map<String,Endpoint> getEndpointMap()
```
Returns a new Map containing all of the endpoints from the EndpointRegistry

Returns:

map of endpoints

hasEndpoint
```
Endpoint hasEndpoint(String uri)
```
Is the given endpoint already registered in the EndpointRegistry

Parameters:

uri - the URI of the endpoint

Returns:

the registered endpoint or null if not registered

addEndpoint
```
Endpoint addEndpoint(String uri,
                     Endpoint endpoint)
              throws Exception
```
Adds the endpoint to the EndpointRegistry using the given URI.

Parameters:

uri - the URI to be used to resolve this endpoint

endpoint - the endpoint to be added to the registry

Returns:

the old endpoint that was previously registered or null if none was registered

Throws:

Exception - if the new endpoint could not be started or the old endpoint could not be stopped

removeEndpoint
```
void removeEndpoint(Endpoint endpoint)
             throws Exception
```
Removes the endpoint from the EndpointRegistry.
The endpoint being removed will be stopped first.

Parameters:

endpoint - the endpoint

Throws:

Exception - if the endpoint could not be stopped

removeEndpoints
```
Collection<Endpoint> removeEndpoints(String pattern)
                              throws Exception
```
Removes all endpoints with the given URI from the EndpointRegistry.
The endpoints being removed will be stopped first.

Parameters:

pattern - an uri or pattern to match

Returns:

a collection of endpoints removed which could be empty if there are no endpoints found for the given pattern

Throws:

Exception - if at least one endpoint could not be stopped

See Also:

for pattern

addRegisterEndpointCallback
```
void addRegisterEndpointCallback(EndpointStrategy strategy)
```
Registers a callback to allow you to do custom logic when an Endpoint is about to be registered to the EndpointRegistry.
When a callback is added it will be executed on the already registered endpoints allowing you to catch-up

Parameters:

strategy - callback to be invoked

setRouteController
```
void setRouteController(RouteController routeController)
```
NOTE: experimental api

Parameters:

routeController - the route controller

getRouteController
```
RouteController getRouteController()
```
NOTE: experimental api

Returns:

the route controller or null if not set.

setupRoutes
```
void setupRoutes(boolean done)
```
Method to signal to CamelContext that the process to initialize setup routes is in progress.

Parameters:

done - false to start the process, call again with true to signal its done.

See Also:

isSetupRoutes()

getRouteDefinitions
```
List<RouteDefinition> getRouteDefinitions()
```
Returns a list of the current route definitions

Returns:

list of the current route definitions

getRouteDefinition
```
RouteDefinition getRouteDefinition(String id)
```
Gets the route definition with the given id

Parameters:

id - id of the route

Returns:

the route definition or null if not found

getRestDefinitions
```
List<RestDefinition> getRestDefinitions()
```
Returns a list of the current REST definitions

Returns:

list of the current REST definitions

addRestDefinitions
```
void addRestDefinitions(Collection<RestDefinition> restDefinitions)
                 throws Exception
```
Adds a collection of rest definitions to the context

Parameters:

restDefinitions - the rest(s) definition to add

Throws:

Exception

setRestConfiguration
```
void setRestConfiguration(RestConfiguration restConfiguration)
```
Sets a custom RestConfiguration

Parameters:

restConfiguration - the REST configuration

getRestConfiguration
```
RestConfiguration getRestConfiguration()
```
Gets the default REST configuration

Returns:

the configuration, or null if none has been configured.

addRestConfiguration
```
void addRestConfiguration(RestConfiguration restConfiguration)
```
Sets a custom RestConfiguration

Parameters:

restConfiguration - the REST configuration

getRestConfiguration
```
RestConfiguration getRestConfiguration(String component,
                                       boolean defaultIfNotFound)
```
Gets the REST configuration for the given component

Parameters:

component - the component name to get the configuration

defaultIfNotFound - determine if the default configuration is returned if there isn't a specific configuration for the given component

Returns:

the configuration, or null if none has been configured.

getRestConfigurations

Collection<RestConfiguration> getRestConfigurations()

Gets all the RestConfiguration's

getServiceCallConfiguration
```
ServiceCallConfigurationDefinition getServiceCallConfiguration(String serviceName)
```
Gets the service call configuration by the given name. If no name is given the default configuration is returned, see setServiceCallConfiguration

Parameters:

serviceName - name of service, or null to return the default configuration

Returns:

the configuration, or null if no configuration has been registered

setServiceCallConfiguration
```
void setServiceCallConfiguration(ServiceCallConfigurationDefinition configuration)
```
Sets the default service call configuration

Parameters:

configuration - the configuration

setServiceCallConfigurations
```
void setServiceCallConfigurations(List<ServiceCallConfigurationDefinition> configurations)
```
Sets the service call configurations

Parameters:

configurations - the configuration list

addServiceCallConfiguration

void addServiceCallConfiguration(String serviceName,
                                 ServiceCallConfigurationDefinition configuration)

Adds the service call configuration

Parameters:: serviceName - name of the service; configuration - the configuration

getHystrixConfiguration
```
HystrixConfigurationDefinition getHystrixConfiguration(String id)
```
Gets the Hystrix configuration by the given name. If no name is given the default configuration is returned, see setHystrixConfiguration

Parameters:

id - id of the configuration, or null to return the default configuration

Returns:

the configuration, or null if no configuration has been registered

setHystrixConfiguration
```
void setHystrixConfiguration(HystrixConfigurationDefinition configuration)
```
Sets the default Hystrix configuration

Parameters:

configuration - the configuration

setHystrixConfigurations
```
void setHystrixConfigurations(List<HystrixConfigurationDefinition> configurations)
```
Sets the Hystrix configurations

Parameters:

configurations - the configuration list

addHystrixConfiguration

void addHystrixConfiguration(String id,
                             HystrixConfigurationDefinition configuration)

Adds the Hystrix configuration

Parameters:: id - name of the configuration; configuration - the configuration

getRouteStartupOrder
```
List<RouteStartupOrder> getRouteStartupOrder()
```
Returns the order in which the route inputs was started.
The order may not be according to the startupOrder defined on the route. For example a route could be started manually later, or new routes added at runtime.

Returns:

a list in the order how routes was started

getRoutes
```
List<Route> getRoutes()
```
Returns the current routes in this CamelContext

Returns:

the current routes

getRoute
```
Route getRoute(String id)
```
Gets the route with the given id

Parameters:

id - id of the route

Returns:

the route or null if not found

getProcessor
```
Processor getProcessor(String id)
```
Gets the processor from any of the routes which with the given id

Parameters:

id - id of the processor

Returns:

the processor or null if not found

getProcessor
```
<T extends Processor> T getProcessor(String id,
                                     Class<T> type)
```
Gets the processor from any of the routes which with the given id

Parameters:

id - id of the processor

type - the processor type

Returns:

the processor or null if not found

Throws:

ClassCastException - is thrown if the type is not correct type

getManagedProcessor
```
<T extends ManagedProcessorMBean> T getManagedProcessor(String id,
                                                        Class<T> type)
```
Gets the managed processor client api from any of the routes which with the given id

Parameters:

id - id of the processor

type - the managed processor type from the org.apache.camel.api.management.mbean package.

Returns:

the processor or null if not found

Throws:

IllegalArgumentException - if the type is not compliant

getManagedRoute
```
<T extends ManagedRouteMBean> T getManagedRoute(String routeId,
                                                Class<T> type)
```
Gets the managed route client api with the given route id

Parameters:

routeId - id of the route

type - the managed route type from the org.apache.camel.api.management.mbean package.

Returns:

the route or null if not found

Throws:

IllegalArgumentException - if the type is not compliant

getManagedCamelContext
```
ManagedCamelContextMBean getManagedCamelContext()
```
Gets the managed Camel CamelContext client api

getProcessorDefinition
```
ProcessorDefinition getProcessorDefinition(String id)
```
Gets the processor definition from any of the routes which with the given id

Parameters:

id - id of the processor definition

Returns:

the processor definition or null if not found

getProcessorDefinition
```
<T extends ProcessorDefinition> T getProcessorDefinition(String id,
                                                         Class<T> type)
```
Gets the processor definition from any of the routes which with the given id

Parameters:

id - id of the processor definition

type - the processor definition type

Returns:

the processor definition or null if not found

Throws:

ClassCastException - is thrown if the type is not correct type

addRoutes
```
void addRoutes(RoutesBuilder builder)
        throws Exception
```
Adds a collection of routes to this CamelContext using the given builder to build them.
Important: The added routes will only be started, if CamelContext is already started. You may want to check the state of CamelContext before adding the routes, using the getStatus() method.
Important: Each route in the same CamelContext must have an unique route id. If you use the API from CamelContext or ModelCamelContext to add routes, then any new routes which has a route id that matches an old route, then the old route is replaced by the new route.

Parameters:

builder - the builder which will create the routes and add them to this CamelContext

Throws:

Exception - if the routes could not be created for whatever reason

loadRoutesDefinition
```
RoutesDefinition loadRoutesDefinition(InputStream is)
                               throws Exception
```
Loads a collection of route definitions from the given InputStream.

Parameters:

is - input stream with the route(s) definition to add

Returns:

the route definitions

Throws:

Exception - if the route definitions could not be loaded for whatever reason

loadRestsDefinition
```
RestsDefinition loadRestsDefinition(InputStream is)
                             throws Exception
```
Loads a collection of rest definitions from the given InputStream.

Parameters:

is - input stream with the rest(s) definition to add

Returns:

the rest definitions

Throws:

Exception - if the rest definitions could not be loaded for whatever reason

addRouteDefinitions
```
void addRouteDefinitions(Collection<RouteDefinition> routeDefinitions)
                  throws Exception
```
Adds a collection of route definitions to the context

Parameters:

routeDefinitions - the route(s) definition to add

Throws:

Exception - if the route definitions could not be created for whatever reason

addRouteDefinition
```
void addRouteDefinition(RouteDefinition routeDefinition)
                 throws Exception
```
Add a route definition to the context

Parameters:

routeDefinition - the route definition to add

Throws:

Exception - if the route definition could not be created for whatever reason

removeRouteDefinitions
```
void removeRouteDefinitions(Collection<RouteDefinition> routeDefinitions)
                     throws Exception
```
Removes a collection of route definitions from the CamelContext - stopping any previously running routes if any of them are actively running

Parameters:

routeDefinitions - route(s) definitions to remove

Throws:

Exception - if the route definitions could not be removed for whatever reason

removeRouteDefinition
```
void removeRouteDefinition(RouteDefinition routeDefinition)
                    throws Exception
```
Removes a route definition from the CamelContext - stopping any previously running routes if any of them are actively running

Parameters:

routeDefinition - route definition to remove

Throws:

Exception - if the route definition could not be removed for whatever reason

startRoute
```
@Deprecated
void startRoute(RouteDefinition route)
                     throws Exception
```
Deprecated. favor using startRoute(String)

Starts the given route if it has been previously stopped

Parameters:

route - the route to start

Throws:

Exception - is thrown if the route could not be started for whatever reason

startAllRoutes
```
void startAllRoutes()
             throws Exception
```
Starts all the routes which currently is not started.

Throws:

Exception - is thrown if a route could not be started for whatever reason

startRoute
```
void startRoute(String routeId)
         throws Exception
```
Starts the given route if it has been previously stopped

Parameters:

routeId - the route id

Throws:

Exception - is thrown if the route could not be started for whatever reason

stopRoute
```
@Deprecated
void stopRoute(RouteDefinition route)
                    throws Exception
```
Deprecated. favor using stopRoute(String)

Stops the given route.

Parameters:

route - the route to stop

Throws:

Exception - is thrown if the route could not be stopped for whatever reason

stopRoute
```
void stopRoute(String routeId)
        throws Exception
```
Stops the given route using ShutdownStrategy.

Parameters:

routeId - the route id

Throws:

Exception - is thrown if the route could not be stopped for whatever reason

See Also:

suspendRoute(String)

stopRoute
```
void stopRoute(String routeId,
               long timeout,
               TimeUnit timeUnit)
        throws Exception
```
Stops the given route using ShutdownStrategy with a specified timeout.

Parameters:

routeId - the route id

timeout - timeout

timeUnit - the unit to use

Throws:

Exception - is thrown if the route could not be stopped for whatever reason

See Also:

suspendRoute(String, long, java.util.concurrent.TimeUnit)

stopRoute
```
boolean stopRoute(String routeId,
                  long timeout,
                  TimeUnit timeUnit,
                  boolean abortAfterTimeout)
           throws Exception
```
Stops the given route using ShutdownStrategy with a specified timeout and optional abortAfterTimeout mode.

Parameters:

routeId - the route id

timeout - timeout

timeUnit - the unit to use

abortAfterTimeout - should abort shutdown after timeout

Returns:

true if the route is stopped before the timeout

Throws:

Exception - is thrown if the route could not be stopped for whatever reason

See Also:

suspendRoute(String, long, java.util.concurrent.TimeUnit)

shutdownRoute
```
@Deprecated
void shutdownRoute(String routeId)
                        throws Exception
```
Deprecated. use stopRoute(String) and removeRoute(String)

Shutdown and removes the given route using ShutdownStrategy.

Parameters:

routeId - the route id

Throws:

Exception - is thrown if the route could not be shutdown for whatever reason

shutdownRoute
```
@Deprecated
void shutdownRoute(String routeId,
                               long timeout,
                               TimeUnit timeUnit)
                        throws Exception
```
Deprecated. use stopRoute(String, long, java.util.concurrent.TimeUnit) and removeRoute(String)

Shutdown and removes the given route using ShutdownStrategy with a specified timeout.

Parameters:

routeId - the route id

timeout - timeout

timeUnit - the unit to use

Throws:

Exception - is thrown if the route could not be shutdown for whatever reason

removeRoute
```
boolean removeRoute(String routeId)
             throws Exception
```
Removes the given route (the route must be stopped before it can be removed).
A route which is removed will be unregistered from JMX, have its services stopped/shutdown and the route definition etc. will also be removed. All the resources related to the route will be stopped and cleared.
Important: When removing a route, the Endpoints which are in the static cache of EndpointRegistry and are only used by the route (not used by other routes) will also be removed. But Endpoints which may have been created as part of routing messages by the route, and those endpoints are enlisted in the dynamic cache of EndpointRegistry are not removed. To remove those dynamic kind of endpoints, use the removeEndpoints(String) method. If not removing those endpoints, they will be kept in the dynamic cache of EndpointRegistry, but my eventually be removed (evicted) when they have not been in use for a longer period of time; and the dynamic cache upper limit is hit, and it evicts the least used endpoints.
End users can use this method to remove unwanted routes or temporary routes which no longer is in demand.

Parameters:

routeId - the route id

Returns:

true if the route was removed, false if the route could not be removed because its not stopped

Throws:

Exception - is thrown if the route could not be shutdown for whatever reason

resumeRoute
```
void resumeRoute(String routeId)
          throws Exception
```
Resumes the given route if it has been previously suspended
If the route does not support suspension the route will be started instead

Parameters:

routeId - the route id

Throws:

Exception - is thrown if the route could not be resumed for whatever reason

suspendRoute
```
void suspendRoute(String routeId)
           throws Exception
```
Suspends the given route using ShutdownStrategy.
Suspending a route is more gently than stopping, as the route consumers will be suspended (if they support) otherwise the consumers will be stopped.
By suspending the route services will be kept running (if possible) and therefore its faster to resume the route.
If the route does not support suspension the route will be stopped instead

Parameters:

routeId - the route id

Throws:

Exception - is thrown if the route could not be suspended for whatever reason

suspendRoute
```
void suspendRoute(String routeId,
                  long timeout,
                  TimeUnit timeUnit)
           throws Exception
```
Suspends the given route using ShutdownStrategy with a specified timeout.
Suspending a route is more gently than stopping, as the route consumers will be suspended (if they support) otherwise the consumers will be stopped.
By suspending the route services will be kept running (if possible) and therefore its faster to resume the route.
If the route does not support suspension the route will be stopped instead

Parameters:

routeId - the route id

timeout - timeout

timeUnit - the unit to use

Throws:

Exception - is thrown if the route could not be suspended for whatever reason

getRouteStatus
```
ServiceStatus getRouteStatus(String routeId)
```
Returns the current status of the given route

Parameters:

routeId - the route id

Returns:

the status for the route

isStartingRoutes
```
boolean isStartingRoutes()
```
Indicates whether current thread is starting route(s).
This can be useful to know by LifecycleStrategy or the likes, in case they need to react differently.

Returns:

true if current thread is starting route(s), or false if not.

isSetupRoutes
```
boolean isSetupRoutes()
```
Indicates whether current thread is setting up route(s) as part of starting Camel from spring/blueprint.
This can be useful to know by LifecycleStrategy or the likes, in case they need to react differently.
As the startup procedure of CamelContext is slightly different when using plain Java versus Spring or Blueprint, then we need to know when Spring/Blueprint is setting up the routes, which can happen after the CamelContext itself is in started state, due the asynchronous event nature of especially Blueprint.

Returns:

true if current thread is setting up route(s), or false if not.

getTypeConverter
```
TypeConverter getTypeConverter()
```
Returns the type converter used to coerce types from one type to another

Returns:

the converter

getTypeConverterRegistry
```
TypeConverterRegistry getTypeConverterRegistry()
```
Returns the type converter registry where type converters can be added or looked up

Returns:

the type converter registry

getRegistry
```
Registry getRegistry()
```
Returns the registry used to lookup components by name and type such as the Spring ApplicationContext, JNDI or the OSGi Service Registry

Returns:

the registry

getRegistry
```
<T> T getRegistry(Class<T> type)
```
Returns the registry used to lookup components by name and as the given type

Parameters:

type - the registry type such as JndiRegistry

Returns:

the registry, or null if the given type was not found as a registry implementation

getInjector
```
Injector getInjector()
```
Returns the injector used to instantiate objects by type

Returns:

the injector

getManagementMBeanAssembler
```
ManagementMBeanAssembler getManagementMBeanAssembler()
```
Returns the management mbean assembler

Returns:

the mbean assembler

getLifecycleStrategies
```
List<LifecycleStrategy> getLifecycleStrategies()
```
Returns the lifecycle strategies used to handle lifecycle notifications

Returns:

the lifecycle strategies

addLifecycleStrategy
```
void addLifecycleStrategy(LifecycleStrategy lifecycleStrategy)
```
Adds the given lifecycle strategy to be used.

Parameters:

lifecycleStrategy - the strategy

resolveLanguage
```
Language resolveLanguage(String language)
```
Resolves a language for creating expressions

Parameters:

language - name of the language

Returns:

the resolved language

resolvePropertyPlaceholders
```
String resolvePropertyPlaceholders(String text)
                            throws Exception
```
Parses the given text and resolve any property placeholders - using {{key}}.

Parameters:

text - the text such as an endpoint uri or the likes

Returns:

the text with resolved property placeholders

Throws:

Exception - is thrown if property placeholders was used and there was an error resolving them

getPropertyPrefixToken
```
String getPropertyPrefixToken()
```
Returns the configured property placeholder prefix token if and only if the CamelContext has property placeholder abilities, otherwise returns null.

Returns:

the prefix token or null

getPropertySuffixToken
```
String getPropertySuffixToken()
```
Returns the configured property placeholder suffix token if and only if the CamelContext has property placeholder abilities, otherwise returns null.

Returns:

the suffix token or null

getLanguageNames
```
List<String> getLanguageNames()
```
Gets a readonly list with the names of the languages currently registered.

Returns:

a readonly list with the names of the the languages

createProducerTemplate
```
ProducerTemplate createProducerTemplate()
```
Creates a new ProducerTemplate which is started and therefore ready to use right away.
See this FAQ before use: Why does Camel use too many threads with ProducerTemplate?
Important: Make sure to call Service.stop() when you are done using the template, to clean up any resources.
Will use cache size defined in Camel property with key Exchange.MAXIMUM_CACHE_POOL_SIZE. If no key was defined then it will fallback to a default size of 1000. You can also use the ProducerTemplate.setMaximumCacheSize(int) method to use a custom value before starting the template.

Returns:

the template

Throws:

RuntimeCamelException - is thrown if error starting the template

createProducerTemplate
```
ProducerTemplate createProducerTemplate(int maximumCacheSize)
```
Creates a new ProducerTemplate which is started and therefore ready to use right away.
See this FAQ before use: Why does Camel use too many threads with ProducerTemplate?
Important: Make sure to call Service.stop() when you are done using the template, to clean up any resources.

Parameters:

maximumCacheSize - the maximum cache size

Returns:

the template

Throws:

RuntimeCamelException - is thrown if error starting the template

createFluentProducerTemplate
```
FluentProducerTemplate createFluentProducerTemplate()
```
Creates a new FluentProducerTemplate which is started and therefore ready to use right away.
See this FAQ before use: Why does Camel use too many threads with ProducerTemplate?
Important: Make sure to call Service.stop() when you are done using the template, to clean up any resources.
Will use cache size defined in Camel property with key Exchange.MAXIMUM_CACHE_POOL_SIZE. If no key was defined then it will fallback to a default size of 1000. You can also use the FluentProducerTemplate.setMaximumCacheSize(int) method to use a custom value before starting the template.

Returns:

the template

Throws:

RuntimeCamelException - is thrown if error starting the template

createFluentProducerTemplate
```
FluentProducerTemplate createFluentProducerTemplate(int maximumCacheSize)
```
Creates a new FluentProducerTemplate which is started and therefore ready to use right away.
See this FAQ before use: Why does Camel use too many threads with ProducerTemplate?
Important: Make sure to call Service.stop() when you are done using the template, to clean up any resources.

Parameters:

maximumCacheSize - the maximum cache size

Returns:

the template

Throws:

RuntimeCamelException - is thrown if error starting the template

createConsumerTemplate
```
ConsumerTemplate createConsumerTemplate()
```
Creates a new ConsumerTemplate which is started and therefore ready to use right away.
See this FAQ before use: Why does Camel use too many threads with ProducerTemplate? as it also applies for ConsumerTemplate.
Important: Make sure to call Service.stop() when you are done using the template, to clean up any resources.
Will use cache size defined in Camel property with key Exchange.MAXIMUM_CACHE_POOL_SIZE. If no key was defined then it will fallback to a default size of 1000. You can also use the ConsumerTemplate.setMaximumCacheSize(int) method to use a custom value before starting the template.

Returns:

the template

Throws:

RuntimeCamelException - is thrown if error starting the template

createConsumerTemplate
```
ConsumerTemplate createConsumerTemplate(int maximumCacheSize)
```
Creates a new ConsumerTemplate which is started and therefore ready to use right away.
See this FAQ before use: Why does Camel use too many threads with ProducerTemplate? as it also applies for ConsumerTemplate.
Important: Make sure to call Service.stop() when you are done using the template, to clean up any resources.

Parameters:

maximumCacheSize - the maximum cache size

Returns:

the template

Throws:

RuntimeCamelException - is thrown if error starting the template

addInterceptStrategy
```
void addInterceptStrategy(InterceptStrategy interceptStrategy)
```
Adds the given interceptor strategy

Parameters:

interceptStrategy - the strategy

getInterceptStrategies
```
List<InterceptStrategy> getInterceptStrategies()
```
Gets the interceptor strategies

Returns:

the list of current interceptor strategies

getErrorHandlerBuilder
```
@Deprecated
ErrorHandlerBuilder getErrorHandlerBuilder()
```
Deprecated. The return type will be switched to ErrorHandlerFactory in Camel 3.0

Gets the default error handler builder which is inherited by the routes

Returns:

the builder

setErrorHandlerBuilder
```
void setErrorHandlerBuilder(ErrorHandlerFactory errorHandlerBuilder)
```
Sets the default error handler builder which is inherited by the routes

Parameters:

errorHandlerBuilder - the builder

getErrorHandlerExecutorService
```
ScheduledExecutorService getErrorHandlerExecutorService()
```
Gets the default shared thread pool for error handlers which leverages this for asynchronous redelivery tasks.

setDataFormats
```
void setDataFormats(Map<String,DataFormatDefinition> dataFormats)
```
Sets the data formats that can be referenced in the routes.

Parameters:

dataFormats - the data formats

getDataFormats
```
Map<String,DataFormatDefinition> getDataFormats()
```
Gets the data formats that can be referenced in the routes.

Returns:

the data formats available

resolveDataFormat
```
DataFormat resolveDataFormat(String name)
```
Resolve a data format given its name

Parameters:

name - the data format name or a reference to it in the Registry

Returns:

the resolved data format, or null if not found

createDataFormat
```
DataFormat createDataFormat(String name)
```
Creates the given data format given its name.

Parameters:

name - the data format name or a reference to a data format factory in the Registry

Returns:

the resolved data format, or null if not found

resolveDataFormatDefinition
```
DataFormatDefinition resolveDataFormatDefinition(String name)
```
Resolve a data format definition given its name

Parameters:

name - the data format definition name or a reference to it in the Registry

Returns:

the resolved data format definition, or null if not found

getDataFormatResolver
```
DataFormatResolver getDataFormatResolver()
```
Gets the current data format resolver

Returns:

the resolver

setDataFormatResolver
```
void setDataFormatResolver(DataFormatResolver dataFormatResolver)
```
Sets a custom data format resolver

Parameters:

dataFormatResolver - the resolver

setTransformers
```
void setTransformers(List<TransformerDefinition> transformers)
```
Sets the transformers that can be referenced in the routes.

Parameters:

transformers - the transformers

getTransformers
```
List<TransformerDefinition> getTransformers()
```
Gets the transformers that can be referenced in the routes.

Returns:

the transformers available

resolveTransformer
```
Transformer resolveTransformer(String model)
```
Resolve a transformer given a scheme

Parameters:

model - data model name.

Returns:

the resolved transformer, or null if not found

resolveTransformer
```
Transformer resolveTransformer(DataType from,
                               DataType to)
```
Resolve a transformer given from/to data type.

Parameters:

from - from data type

to - to data type

Returns:

the resolved transformer, or null if not found

getTransformerRegistry
```
TransformerRegistry getTransformerRegistry()
```
Gets the TransformerRegistry

Returns:

the TransformerRegistry

setValidators
```
void setValidators(List<ValidatorDefinition> validators)
```
Sets the validators that can be referenced in the routes.

Parameters:

validators - the validators

getValidators
```
List<ValidatorDefinition> getValidators()
```
Gets the validators that can be referenced in the routes.

Returns:

the validators available

resolveValidator
```
Validator resolveValidator(DataType type)
```
Resolve a validator given from/to data type.

Parameters:

type - the data type

Returns:

the resolved validator, or null if not found

getValidatorRegistry
```
ValidatorRegistry getValidatorRegistry()
```
Gets the ValidatorRegistry

Returns:

the ValidatorRegistry

setProperties

@Deprecated
void setProperties(Map<String,String> properties)

Deprecated. use setGlobalOptions(Map) instead.

setGlobalOptions
```
void setGlobalOptions(Map<String,String> globalOptions)
```
Sets global options that can be referenced in the camel context
Important: This has nothing to do with property placeholders, and is just a plain set of key/value pairs which are used to configure global options on CamelContext, such as a maximum debug logging length etc. For property placeholders use resolvePropertyPlaceholders(String) method and see more details at the property placeholder documentation.

Parameters:

globalOptions - global options that can be referenced in the camel context

getProperties
```
@Deprecated
Map<String,String> getProperties()
```
Deprecated. use getGlobalOptions() instead.

getGlobalOptions
```
Map<String,String> getGlobalOptions()
```
Gets global options that can be referenced in the camel context.
Important: This has nothing to do with property placeholders, and is just a plain set of key/value pairs which are used to configure global options on CamelContext, such as a maximum debug logging length etc. For property placeholders use resolvePropertyPlaceholders(String) method and see more details at the property placeholder documentation.

Returns:

global options for this context

getProperty
```
String getProperty(String key)
```
Deprecated. use getGlobalOption(String) instead.

getGlobalOption
```
String getGlobalOption(String key)
```
Gets the global option value that can be referenced in the camel context
Important: This has nothing to do with property placeholders, and is just a plain set of key/value pairs which are used to configure global options on CamelContext, such as a maximum debug logging length etc. For property placeholders use resolvePropertyPlaceholders(String) method and see more details at the property placeholder documentation.

Returns:

the string value of the global option

getDefaultFactoryFinder
```
FactoryFinder getDefaultFactoryFinder()
```
Gets the default FactoryFinder which will be used for the loading the factory class from META-INF

Returns:

the default factory finder

setFactoryFinderResolver
```
void setFactoryFinderResolver(FactoryFinderResolver resolver)
```
Sets the factory finder resolver to use.

Parameters:

resolver - the factory finder resolver

getFactoryFinder
```
FactoryFinder getFactoryFinder(String path)
                        throws NoFactoryAvailableException
```
Gets the FactoryFinder which will be used for the loading the factory class from META-INF in the given path

Parameters:

path - the META-INF path

Returns:

the factory finder

Throws:

NoFactoryAvailableException - is thrown if a factory could not be found

getClassResolver
```
ClassResolver getClassResolver()
```
Returns the class resolver to be used for loading/lookup of classes.

Returns:

the resolver

getPackageScanClassResolver
```
PackageScanClassResolver getPackageScanClassResolver()
```
Returns the package scanning class resolver

Returns:

the resolver

setClassResolver
```
void setClassResolver(ClassResolver resolver)
```
Sets the class resolver to be use

Parameters:

resolver - the resolver

setPackageScanClassResolver
```
void setPackageScanClassResolver(PackageScanClassResolver resolver)
```
Sets the package scanning class resolver to use

Parameters:

resolver - the resolver

setProducerServicePool
```
void setProducerServicePool(ServicePool<Endpoint,Producer> servicePool)
```
Sets a pluggable service pool to use for Producer pooling.

Parameters:

servicePool - the pool

getProducerServicePool
```
ServicePool<Endpoint,Producer> getProducerServicePool()
```
Gets the service pool for Producer pooling.

Returns:

the service pool

setPollingConsumerServicePool
```
void setPollingConsumerServicePool(ServicePool<Endpoint,PollingConsumer> servicePool)
```
Sets a pluggable service pool to use for PollingConsumer pooling.

Parameters:

servicePool - the pool

getPollingConsumerServicePool
```
ServicePool<Endpoint,PollingConsumer> getPollingConsumerServicePool()
```
Gets the service pool for Producer pooling.

Returns:

the service pool

setNodeIdFactory
```
void setNodeIdFactory(NodeIdFactory factory)
```
Uses a custom node id factory when generating auto assigned ids to the nodes in the route definitions

Parameters:

factory - custom factory to use

getNodeIdFactory
```
NodeIdFactory getNodeIdFactory()
```
Gets the node id factory

Returns:

the node id factory

getManagementStrategy
```
ManagementStrategy getManagementStrategy()
```
Gets the management strategy

Returns:

the management strategy

setManagementStrategy
```
void setManagementStrategy(ManagementStrategy strategy)
```
Sets the management strategy to use

Parameters:

strategy - the management strategy

getDefaultTracer
```
InterceptStrategy getDefaultTracer()
```
Gets the default tracer

Returns:

the default tracer

setDefaultTracer
```
void setDefaultTracer(InterceptStrategy tracer)
```
Sets a custom tracer to be used as the default tracer.
Note: This must be set before any routes are created, changing the default tracer for existing routes is not supported.

Parameters:

tracer - the custom tracer to use as default tracer

getDefaultBacklogTracer
```
InterceptStrategy getDefaultBacklogTracer()
```
Gets the default backlog tracer

Returns:

the default backlog tracer

setDefaultBacklogTracer
```
void setDefaultBacklogTracer(InterceptStrategy backlogTracer)
```
Sets a custom backlog tracer to be used as the default backlog tracer.
Note: This must be set before any routes are created, changing the default backlog tracer for existing routes is not supported.

Parameters:

backlogTracer - the custom tracer to use as default backlog tracer

getDefaultBacklogDebugger
```
InterceptStrategy getDefaultBacklogDebugger()
```
Gets the default backlog debugger

Returns:

the default backlog debugger

setDefaultBacklogDebugger
```
void setDefaultBacklogDebugger(InterceptStrategy backlogDebugger)
```
Sets a custom backlog debugger to be used as the default backlog debugger.
Note: This must be set before any routes are created, changing the default backlog debugger for existing routes is not supported.

Parameters:

backlogDebugger - the custom debugger to use as default backlog debugger

disableJMX
```
void disableJMX()
         throws IllegalStateException
```
Disables using JMX as ManagementStrategy.
Important: This method must be called before the CamelContext is started.

Throws:

IllegalStateException - is thrown if the CamelContext is not in stopped state.

getInflightRepository
```
InflightRepository getInflightRepository()
```
Gets the inflight repository

Returns:

the repository

setInflightRepository
```
void setInflightRepository(InflightRepository repository)
```
Sets a custom inflight repository to use

Parameters:

repository - the repository

getAsyncProcessorAwaitManager
```
AsyncProcessorAwaitManager getAsyncProcessorAwaitManager()
```
Gets the AsyncProcessor await manager.

Returns:

the manager

setAsyncProcessorAwaitManager
```
void setAsyncProcessorAwaitManager(AsyncProcessorAwaitManager manager)
```
Sets a custom AsyncProcessor await manager.

Parameters:

manager - the manager

getApplicationContextClassLoader
```
ClassLoader getApplicationContextClassLoader()
```
Gets the the application CamelContext class loader which may be helpful for running camel in other containers

Returns:

the application CamelContext class loader

setApplicationContextClassLoader
```
void setApplicationContextClassLoader(ClassLoader classLoader)
```
Sets the application CamelContext class loader

Parameters:

classLoader - the class loader

getShutdownStrategy
```
ShutdownStrategy getShutdownStrategy()
```
Gets the current shutdown strategy

Returns:

the strategy

setShutdownStrategy
```
void setShutdownStrategy(ShutdownStrategy shutdownStrategy)
```
Sets a custom shutdown strategy

Parameters:

shutdownStrategy - the custom strategy

getExecutorServiceManager
```
ExecutorServiceManager getExecutorServiceManager()
```
Gets the current ExecutorServiceManager

Returns:

the manager

getExecutorServiceStrategy
```
@Deprecated
ExecutorServiceStrategy getExecutorServiceStrategy()
```
Deprecated. use getExecutorServiceManager()

Gets the current ExecutorServiceStrategy

Returns:

the manager

setExecutorServiceManager
```
void setExecutorServiceManager(ExecutorServiceManager executorServiceManager)
```
Sets a custom ExecutorServiceManager

Parameters:

executorServiceManager - the custom manager

getProcessorFactory
```
ProcessorFactory getProcessorFactory()
```
Gets the current ProcessorFactory

Returns:

the factory, can be null if no custom factory has been set

setProcessorFactory
```
void setProcessorFactory(ProcessorFactory processorFactory)
```
Sets a custom ProcessorFactory

Parameters:

processorFactory - the custom factory

getMessageHistoryFactory
```
MessageHistoryFactory getMessageHistoryFactory()
```
Gets the current MessageHistoryFactory

Returns:

the factory

setMessageHistoryFactory
```
void setMessageHistoryFactory(MessageHistoryFactory messageHistoryFactory)
```
Sets a custom MessageHistoryFactory

Parameters:

messageHistoryFactory - the custom factory

getDebugger
```
Debugger getDebugger()
```
Gets the current Debugger

Returns:

the debugger

setDebugger
```
void setDebugger(Debugger debugger)
```
Sets a custom Debugger

Parameters:

debugger - the debugger

getUuidGenerator
```
UuidGenerator getUuidGenerator()
```
Gets the current UuidGenerator

Returns:

the uuidGenerator

setUuidGenerator
```
void setUuidGenerator(UuidGenerator uuidGenerator)
```
Sets a custom UuidGenerator (should only be set once)

Parameters:

uuidGenerator - the UUID Generator

isLazyLoadTypeConverters
```
@Deprecated
Boolean isLazyLoadTypeConverters()
```
Deprecated. this option is no longer supported, will be removed in a future Camel release.

Whether or not type converters should be loaded lazy

Returns:

true to load lazy, false to load on startup

setLazyLoadTypeConverters
```
@Deprecated
void setLazyLoadTypeConverters(Boolean lazyLoadTypeConverters)
```
Deprecated. this option is no longer supported, will be removed in a future Camel release.

Sets whether type converters should be loaded lazy

Parameters:

lazyLoadTypeConverters - true to load lazy, false to load on startup

isLoadTypeConverters
```
Boolean isLoadTypeConverters()
```
Sets whether to load custom type converters by scanning classpath. This can be turned off if you are only using Camel components that does not provide type converters which is needed at runtime. In such situations setting this option to false, can speedup starting Camel.

setLoadTypeConverters
```
void setLoadTypeConverters(Boolean loadTypeConverters)
```
Sets whether to load custom type converters by scanning classpath. This can be turned off if you are only using Camel components that does not provide type converters which is needed at runtime. In such situations setting this option to false, can speedup starting Camel.

Parameters:

loadTypeConverters - whether to load custom type converters.

isTypeConverterStatisticsEnabled
```
Boolean isTypeConverterStatisticsEnabled()
```
Whether or not type converter statistics is enabled.
By default the type converter utilization statistics is disabled. Notice: If enabled then there is a slight performance impact under very heavy load.

Returns:

true if enabled, false if disabled (default).

setTypeConverterStatisticsEnabled
```
void setTypeConverterStatisticsEnabled(Boolean typeConverterStatisticsEnabled)
```
Sets whether or not type converter statistics is enabled.
By default the type converter utilization statistics is disabled. Notice: If enabled then there is a slight performance impact under very heavy load.
You can enable/disable the statistics at runtime using the org.apache.camel.spi.TypeConverterRegistry#getStatistics()#setTypeConverterStatisticsEnabled(Boolean) method, or from JMX on the ManagedTypeConverterRegistryMBean mbean.

Parameters:

typeConverterStatisticsEnabled - true to enable, false to disable

isUseMDCLogging
```
Boolean isUseMDCLogging()
```
Whether or not MDC logging is being enabled.

Returns:

true if MDC logging is enabled

setUseMDCLogging
```
void setUseMDCLogging(Boolean useMDCLogging)
```
Set whether MDC is enabled.

Parameters:

useMDCLogging - true to enable MDC logging, false to disable

isUseDataType
```
Boolean isUseDataType()
```
Whether to enable using data type on Camel messages.
Data type are automatic turned on if one ore more routes has been explicit configured with input and output types. Otherwise data type is default off.

Returns:

true if data type is enabled

setUseDataType
```
void setUseDataType(Boolean useDataType)
```
Whether to enable using data type on Camel messages.
Data type are automatic turned on if one ore more routes has been explicit configured with input and output types. Otherwise data type is default off.

Parameters:

useDataType - true to enable data type on Camel messages.

isUseBreadcrumb
```
Boolean isUseBreadcrumb()
```
Whether or not breadcrumb is enabled.

Returns:

true if breadcrumb is enabled

setUseBreadcrumb
```
void setUseBreadcrumb(Boolean useBreadcrumb)
```
Set whether breadcrumb is enabled.

Parameters:

useBreadcrumb - true to enable breadcrumb, false to disable

resolveComponentDefaultName
```
String resolveComponentDefaultName(String javaType)
```
Resolves a component's default name from its java type.
A component may be used with a non default name such as activemq, wmq for the JMS component. This method can resolve the default component name by its java type.

Parameters:

javaType - the FQN name of the java type

Returns:

the default component name.

findComponents
```
Map<String,Properties> findComponents()
                               throws LoadPropertiesException,
                                      IOException
```
Find information about all the Camel components available in the classpath and Registry.

Returns:

a map with the component name, and value with component details.

Throws:

LoadPropertiesException - is thrown if error during classpath discovery of the components

IOException - is thrown if error during classpath discovery of the components

findEips
```
Map<String,Properties> findEips()
                         throws LoadPropertiesException,
                                IOException
```
Find information about all the EIPs from camel-core.

Returns:

a map with node id, and value with EIP details.

Throws:

LoadPropertiesException - is thrown if error during classpath discovery of the EIPs

IOException - is thrown if error during classpath discovery of the EIPs

getComponentDocumentation
```
@Deprecated
String getComponentDocumentation(String componentName)
                                      throws IOException
```
Deprecated. use camel-catalog instead

Returns the HTML documentation for the given Camel component

Returns:

the HTML or null if the component is not built with HTML document included.

Throws:

IOException

getComponentParameterJsonSchema
```
String getComponentParameterJsonSchema(String componentName)
                                throws IOException
```
Returns the JSON schema representation of the component and endpoint parameters for the given component name.

Returns:

the json or null if the component is not built with JSon schema support

Throws:

IOException

getDataFormatParameterJsonSchema
```
String getDataFormatParameterJsonSchema(String dataFormatName)
                                 throws IOException
```
Returns the JSON schema representation of the DataFormat parameters for the given data format name.

Returns:

the json or null if the data format does not exist

Throws:

IOException

getLanguageParameterJsonSchema
```
String getLanguageParameterJsonSchema(String languageName)
                               throws IOException
```
Returns the JSON schema representation of the Language parameters for the given language name.

Returns:

the json or null if the language does not exist

Throws:

IOException

getEipParameterJsonSchema
```
String getEipParameterJsonSchema(String eipName)
                          throws IOException
```
Returns the JSON schema representation of the EIP parameters for the given EIP name.

Returns:

the json or null if the EIP does not exist

Throws:

IOException

explainEipJson
```
String explainEipJson(String nameOrId,
                      boolean includeAllOptions)
```
Returns a JSON schema representation of the EIP parameters for the given EIP by its id.

Parameters:

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

includeAllOptions - whether to include non configured options also (eg default options)

Returns:

the json or null if the eipName or the id was not found

explainComponentJson
```
String explainComponentJson(String componentName,
                            boolean includeAllOptions)
```
Returns a JSON schema representation of the component parameters (not endpoint parameters) for the given component by its id.

Parameters:

componentName - the name of the component.

includeAllOptions - whether to include non configured options also (eg default options)

Returns:

the json or null if the component was not found

explainDataFormatJson
```
String explainDataFormatJson(String dataFormatName,
                             DataFormat dataFormat,
                             boolean includeAllOptions)
```
Returns a JSON schema representation of the component parameters (not endpoint parameters) for the given component by its id.

Parameters:

dataFormat - the data format instance.

includeAllOptions - whether to include non configured options also (eg default options)

Returns:

the json

explainEndpointJson
```
String explainEndpointJson(String uri,
                           boolean includeAllOptions)
```
Returns a JSON schema representation of the endpoint parameters for the given endpoint uri.

Parameters:

uri - the endpoint uri

includeAllOptions - whether to include non configured options also (eg default options)

Returns:

the json or null if uri parameters is invalid, or the component is not built with JSon schema support

createRouteStaticEndpointJson
```
String createRouteStaticEndpointJson(String routeId)
```
Creates a JSON representation of all the static and dynamic configured endpoints defined in the given route(s).

Parameters:

routeId - for a particular route, or null for all routes

Returns:

a JSON string

createRouteStaticEndpointJson
```
String createRouteStaticEndpointJson(String routeId,
                                     boolean includeDynamic)
```
Creates a JSON representation of all the static (and possible dynamic) configured endpoints defined in the given route(s).

Parameters:

routeId - for a particular route, or null for all routes

includeDynamic - whether to include dynamic endpoints

Returns:

a JSON string

getStreamCachingStrategy
```
StreamCachingStrategy getStreamCachingStrategy()
```
Gets the StreamCachingStrategy to use.

setStreamCachingStrategy

void setStreamCachingStrategy(StreamCachingStrategy streamCachingStrategy)

Sets a custom StreamCachingStrategy to use.

getUnitOfWorkFactory
```
UnitOfWorkFactory getUnitOfWorkFactory()
```
Gets the UnitOfWorkFactory to use.

setUnitOfWorkFactory

void setUnitOfWorkFactory(UnitOfWorkFactory unitOfWorkFactory)

Sets a custom UnitOfWorkFactory to use.

getRuntimeEndpointRegistry
```
RuntimeEndpointRegistry getRuntimeEndpointRegistry()
```
Gets the RuntimeEndpointRegistry to use, or null if none is in use.

setRuntimeEndpointRegistry

void setRuntimeEndpointRegistry(RuntimeEndpointRegistry runtimeEndpointRegistry)

Sets a custom RuntimeEndpointRegistry to use.

getRestRegistry
```
RestRegistry getRestRegistry()
```
Gets the RestRegistry to use

setRestRegistry

void setRestRegistry(RestRegistry restRegistry)

Sets a custom RestRegistry to use.

addRoutePolicyFactory
```
void addRoutePolicyFactory(RoutePolicyFactory routePolicyFactory)
```
Adds the given route policy factory

Parameters:

routePolicyFactory - the factory

getRoutePolicyFactories
```
List<RoutePolicyFactory> getRoutePolicyFactories()
```
Gets the route policy factories

Returns:

the list of current route policy factories

getModelJAXBContextFactory
```
ModelJAXBContextFactory getModelJAXBContextFactory()
```
Returns the JAXB Context factory used to create Models.

Returns:

the JAXB Context factory used to create Models.

setModelJAXBContextFactory
```
void setModelJAXBContextFactory(ModelJAXBContextFactory modelJAXBContextFactory)
```
Sets a custom JAXB Context factory to be used

Parameters:

modelJAXBContextFactory - a JAXB Context factory

getReloadStrategy
```
ReloadStrategy getReloadStrategy()
```
Returns the ReloadStrategy if in use.

Returns:

the strategy, or null if none has been configured.

setReloadStrategy

void setReloadStrategy(ReloadStrategy reloadStrategy)

Sets a custom ReloadStrategy to be used

getRuntimeCamelCatalog
```
RuntimeCamelCatalog getRuntimeCamelCatalog()
```
Gets the associated RuntimeCamelCatalog for this CamelContext.

getLogListeners
```
Set<LogListener> getLogListeners()
```
Gets a list of LogListener.

addLogListener

void addLogListener(LogListener listener)

Adds a LogListener.

setSSLContextParameters

void setSSLContextParameters(SSLContextParameters sslContextParameters)

Sets the global SSL context parameters.

getSSLContextParameters
```
SSLContextParameters getSSLContextParameters()
```
Gets the global SSL context parameters if configured.

getHeadersMapFactory
```
HeadersMapFactory getHeadersMapFactory()
```
Gets the HeadersMapFactory to use.

setHeadersMapFactory
```
void setHeadersMapFactory(HeadersMapFactory factory)
```
Sets a custom HeadersMapFactory to be used.

getHealthCheckRegistry
```
HealthCheckRegistry getHealthCheckRegistry()
```
Returns an optional HealthCheckRegistry, by default no registry is present and it must be explicit activated. Components can register/unregister health checks in response to life-cycle events (i.e. start/stop). This registry is not used by the camel context but it is up to the impl to properly use it, i.e. - a RouteController could use the registry to decide to restart a route with failing health checks - spring boot could integrate such checks within its health endpoint or make it available only as separate endpoint.

setHealthCheckRegistry

void setHealthCheckRegistry(HealthCheckRegistry healthCheckRegistry)

Sets a HealthCheckRegistry.

Interface CamelContext

Method Summary

Methods inherited from interface org.apache.camel.SuspendableService

Methods inherited from interface org.apache.camel.RuntimeConfiguration

Method Detail

adapt

isVetoStarted

start

stop

getName

getNameStrategy

setNameStrategy

getManagementNameStrategy

setManagementNameStrategy

getManagementName

getVersion

getStatus

getUptime

getUptimeMillis

addService

addService

addService

removeService

hasService

hasService

hasServices

deferStartService

addStartupListener

addComponent

hasComponent

getComponent

getComponent

getComponent

getComponent

getComponentNames

removeComponent

getEndpointRegistry

getEndpoint

getEndpoint

getEndpoints

getEndpointMap

hasEndpoint

addEndpoint

removeEndpoint

removeEndpoints

addRegisterEndpointCallback

setRouteController

getRouteController

setupRoutes

getRouteDefinitions

getRouteDefinition

getRestDefinitions

addRestDefinitions

setRestConfiguration

getRestConfiguration

addRestConfiguration

getRestConfiguration

getRestConfigurations

getServiceCallConfiguration

setServiceCallConfiguration

setServiceCallConfigurations

addServiceCallConfiguration

getHystrixConfiguration

setHystrixConfiguration

setHystrixConfigurations

addHystrixConfiguration

getRouteStartupOrder

getRoutes

getRoute

getProcessor

getProcessor

getManagedProcessor

getManagedRoute

getManagedCamelContext

getProcessorDefinition

getProcessorDefinition

addRoutes

loadRoutesDefinition

loadRestsDefinition

addRouteDefinitions