public interface CamelContext extends SuspendableService, RuntimeConfiguration
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 messagesSuspendableService.resume()
- to resume after a suspendstop()
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.Modifier and Type | Method and Description |
---|---|
void |
addComponent(String componentName,
Component component)
Adds a component to the context.
|
Endpoint |
addEndpoint(String uri,
Endpoint endpoint)
Adds the endpoint to the context using the given URI.
|
void |
addInterceptStrategy(InterceptStrategy interceptStrategy)
Adds the given interceptor strategy
|
void |
addLifecycleStrategy(LifecycleStrategy lifecycleStrategy)
Adds the given lifecycle strategy to be used.
|
void |
addRegisterEndpointCallback(EndpointStrategy strategy)
Registers a
callback to allow you to do custom
logic when an Endpoint is about to be registered to the CamelContext endpoint registry. |
void |
addRouteDefinition(RouteDefinition routeDefinition)
|
void |
addRouteDefinitions(Collection<RouteDefinition> routeDefinitions)
Deprecated.
|
void |
addRoutes(RoutesBuilder builder)
Adds a collection of routes to this context using the given builder
to build them.
|
void |
addService(Object object)
Adds a service to this context, which allows this context to control the lifecycle, ensuring
the service is stopped when the context stops.
|
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. |
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 |
disableJMX()
Disables using JMX as
ManagementStrategy . |
Map<String,Properties> |
findComponents()
Find information about all the Camel components available in the classpath and
Registry . |
ClassLoader |
getApplicationContextClassLoader()
Gets the the application context class loader which may be helpful for running camel in other containers
|
ClassResolver |
getClassResolver()
Returns the class resolver to be used for loading/lookup of classes.
|
Component |
getComponent(String componentName)
Gets a component from the context by name.
|
Component |
getComponent(String name,
boolean autoCreateComponents)
Gets a component from the context by name.
|
<T extends Component> |
getComponent(String name,
Class<T> componentType)
Gets a component from the context by name and specifying the expected type of component.
|
String |
getComponentDocumentation(String componentName)
Returns the HTML documentation for the given camel component
|
List<String> |
getComponentNames()
Gets a readonly list of names of the components currently registered
|
DataFormatResolver |
getDataFormatResolver()
Gets the current data format resolver
|
Map<String,DataFormatDefinition> |
getDataFormats()
Deprecated.
|
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
|
Endpoint |
getEndpoint(String uri)
Resolves the given name to an
Endpoint of the specified type. |
<T extends Endpoint> |
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 active endpoints with the key of the map being their
unique key.
|
Collection<Endpoint> |
getEndpoints()
Returns the collection of all registered endpoints.
|
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.
|
FactoryFinder |
getFactoryFinder(String path)
Gets the FactoryFinder which will be used for the loading the factory class from META-INF in the given path
|
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.
|
List<LifecycleStrategy> |
getLifecycleStrategies()
Returns the lifecycle strategies used to handle lifecycle notifications
|
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
|
String |
getName()
Gets the name (id) of the this context.
|
CamelContextNameStrategy |
getNameStrategy()
Gets the current name strategy
|
NodeIdFactory |
getNodeIdFactory()
Gets the node id factory
|
PackageScanClassResolver |
getPackageScanClassResolver()
Returns the package scanning class resolver
|
ProcessorFactory |
getProcessorFactory()
Gets the current
ProcessorFactory |
ServicePool<Endpoint,Producer> |
getProducerServicePool()
Gets the service pool for
Producer pooling. |
Map<String,String> |
getProperties()
Gets the properties that can be referenced in the camel context
|
String |
getProperty(String name)
Gets the property value that can be referenced in the camel context
|
String |
getPropertyPrefixToken()
Returns the configured property placeholder prefix token if and only if the context has
property placeholder abilities, otherwise returns
null . |
String |
getPropertySuffixToken()
Returns the configured property placeholder suffix token if and only if the context 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
|
Route |
getRoute(String id)
Gets the route with the given id
|
RouteDefinition |
getRouteDefinition(String id)
Deprecated.
|
List<RouteDefinition> |
getRouteDefinitions()
Deprecated.
|
List<Route> |
getRoutes()
Returns the current routes in this context
|
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
|
RuntimeEndpointRegistry |
getRuntimeEndpointRegistry()
Gets the
RuntimeEndpointRegistry to use, or null if none is in use. |
ShutdownStrategy |
getShutdownStrategy()
Gets the current shutdown strategy
|
ServiceStatus |
getStatus()
Get the status of this context
|
StreamCachingStrategy |
getStreamCachingStrategy()
Gets the
StreamCachingStrategy to use. |
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
|
UuidGenerator |
getUuidGenerator()
Gets the current
UuidGenerator |
String |
getVersion()
Gets the version of the this context.
|
Component |
hasComponent(String componentName)
Is the given component already registered?
|
Endpoint |
hasEndpoint(String uri)
Is the given endpoint already registered?
|
boolean |
hasService(Object object)
Has the given service already been added to this context?
|
Boolean |
isLazyLoadTypeConverters()
Deprecated.
this option is no longer supported, will be removed in a future Camel release.
|
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 |
isUseMDCLogging()
Whether or not MDC logging is being enabled.
|
RoutesDefinition |
loadRoutesDefinition(InputStream is)
Deprecated.
|
Component |
removeComponent(String componentName)
Removes a previously added component.
|
Collection<Endpoint> |
removeEndpoints(String pattern)
Removes all endpoints with the given URI.
|
boolean |
removeRoute(String routeId)
Removes the given route (the route must be stopped before it can be removed).
|
void |
removeRouteDefinition(RouteDefinition routeDefinition)
|
void |
removeRouteDefinitions(Collection<RouteDefinition> routeDefinitions)
Deprecated.
|
boolean |
removeService(Object object)
Removes a service from this context.
|
DataFormat |
resolveDataFormat(String name)
Resolve a data format given its name
|
DataFormatDefinition |
resolveDataFormatDefinition(String name)
Deprecated.
|
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}}.
|
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 context class loader
|
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)
Deprecated.
|
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 |
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 |
setManagementNameStrategy(ManagementNameStrategy nameStrategy)
Sets a custom management name strategy
|
void |
setManagementStrategy(ManagementStrategy strategy)
Sets the management strategy to use
|
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 |
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)
Sets the properties that can be referenced in the camel context
|
void |
setRuntimeEndpointRegistry(RuntimeEndpointRegistry runtimeEndpointRegistry)
Sets a custom
RuntimeEndpointRegistry to use. |
void |
setShutdownStrategy(ShutdownStrategy shutdownStrategy)
Sets a custom shutdown strategy
|
void |
setStreamCachingStrategy(StreamCachingStrategy streamCachingStrategy)
Sets a custom
StreamCachingStrategy to use. |
void |
setTypeConverterStatisticsEnabled(Boolean typeConverterStatisticsEnabled)
Sets whether or not type converter statistics is enabled.
|
void |
setUnitOfWorkFactory(UnitOfWorkFactory unitOfWorkFactory)
Sets a custom
UnitOfWorkFactory to use. |
void |
setUseBreadcrumb(Boolean useBreadcrumb)
Set whether breadcrumb is enabled.
|
void |
setUseMDCLogging(Boolean useMDCLogging)
Set whether MDC is enabled.
|
void |
setUuidGenerator(UuidGenerator uuidGenerator)
Sets a custom
UuidGenerator (should only be set once) |
void |
shutdownRoute(String routeId)
Deprecated.
use
stopRoute(String) and removeRoute(String) |
void |
shutdownRoute(String routeId,
long timeout,
TimeUnit timeUnit)
Deprecated.
|
void |
start()
Starts the
CamelContext (important: the start method is not blocked, see more details
here). |
void |
startRoute(RouteDefinition route)
|
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)
|
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. |
isSuspended, resume, suspend
getDelayer, getShutdownRoute, getShutdownRunningTask, isAllowUseOriginalMessage, isAutoStartup, isHandleFault, isMessageHistory, isStreamCaching, isTracing, setAllowUseOriginalMessage, setAutoStartup, setDelayer, setHandleFault, setMessageHistory, setShutdownRoute, setShutdownRunningTask, setStreamCaching, setTracing
void start() throws Exception
CamelContext
(important: the start method is not blocked, see more details
here).
See more details at the class-level javadoc of this class.void stop() throws Exception
CamelContext
(will stop all routes/components/endpoints etc and clear internal state/cache).
See more details at the class-level javadoc of this class.CamelContextNameStrategy getNameStrategy()
void setNameStrategy(CamelContextNameStrategy nameStrategy)
nameStrategy
- name strategyManagementNameStrategy getManagementNameStrategy()
void setManagementNameStrategy(ManagementNameStrategy nameStrategy)
nameStrategy
- name strategyString getManagementName()
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 CamelContext
s in the same JVM. Camel will automatic reassign and use
a free name to avoid failing to start.String getVersion()
ServiceStatus getStatus()
String getUptime()
void addService(Object object) throws Exception
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.object
- the serviceException
- can be thrown when starting the serviceboolean removeService(Object object) throws Exception
addService(Object)
method.
This method will not change the service lifecycle.object
- the serviceException
- can be thrown if error removing the serviceboolean hasService(Object object)
object
- the servicevoid addStartupListener(StartupListener listener) throws Exception
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.listener
- the listenerException
- can be thrown if CamelContext
is already started and the listener is invoked
and cause an exception to be thrownvoid addComponent(String componentName, Component component)
componentName
- the name the component is registered ascomponent
- the componentComponent hasComponent(String componentName)
componentName
- the name of the componentComponent getComponent(String componentName)
componentName
- the name of the componentComponent getComponent(String name, boolean autoCreateComponents)
name
- the name of the componentautoCreateComponents
- whether or not the component should
be lazily created if it does not already exist<T extends Component> T getComponent(String name, Class<T> componentType)
name
- the name to lookupcomponentType
- the expected typeList<String> getComponentNames()
Component removeComponent(String componentName)
componentName
- the component name to removeEndpoint getEndpoint(String uri)
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.uri
- the URI of the endpoint<T extends Endpoint> T getEndpoint(String name, Class<T> endpointType)
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.name
- the name of the endpointendpointType
- the expected typeCollection<Endpoint> getEndpoints()
Map<String,Endpoint> getEndpointMap()
Endpoint hasEndpoint(String uri)
uri
- the URI of the endpointEndpoint addEndpoint(String uri, Endpoint endpoint) throws Exception
uri
- the URI to be used to resolve this endpointendpoint
- the endpoint to be added to the contextException
- if the new endpoint could not be started or the old endpoint could not be stoppedCollection<Endpoint> removeEndpoints(String pattern) throws Exception
pattern
- an uri or pattern to matchException
- if at least one endpoint could not be stoppedfor pattern
void addRegisterEndpointCallback(EndpointStrategy strategy)
callback
to allow you to do custom
logic when an Endpoint
is about to be registered to the CamelContext
endpoint registry.
When a callback is added it will be executed on the already registered endpoints allowing you to catch-upstrategy
- callback to be invoked@Deprecated List<RouteDefinition> getRouteDefinitions()
ModelCamelContext.getRouteDefinitions()
@Deprecated RouteDefinition getRouteDefinition(String id)
ModelCamelContext.getRouteDefinition(String)
id
- id of the routeList<RouteStartupOrder> getRouteStartupOrder()
List<Route> getRoutes()
Route getRoute(String id)
id
- id of the routevoid addRoutes(RoutesBuilder builder) throws Exception
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.builder
- the builder which will create the routes and add them to this contextException
- if the routes could not be created for whatever reason@Deprecated RoutesDefinition loadRoutesDefinition(InputStream is) throws Exception
ModelCamelContext.loadRoutesDefinition(java.io.InputStream)
InputStream
.is
- input stream with the route(s) definition to addException
- if the route definitions could not be loaded for whatever reason@Deprecated void addRouteDefinitions(Collection<RouteDefinition> routeDefinitions) throws Exception
ModelCamelContext.addRouteDefinitions(java.util.Collection)
routeDefinitions
- the route(s) definition to addException
- if the route definitions could not be created for whatever reason@Deprecated void addRouteDefinition(RouteDefinition routeDefinition) throws Exception
routeDefinition
- the route definition to addException
- if the route definition could not be created for whatever reason@Deprecated void removeRouteDefinitions(Collection<RouteDefinition> routeDefinitions) throws Exception
ModelCamelContext.removeRouteDefinitions(java.util.Collection)
routeDefinitions
- route(s) definitions to removeException
- if the route definitions could not be removed for whatever reason@Deprecated void removeRouteDefinition(RouteDefinition routeDefinition) throws Exception
routeDefinition
- route definition to removeException
- if the route definition could not be removed for whatever reason@Deprecated void startRoute(RouteDefinition route) throws Exception
route
- the route to startException
- is thrown if the route could not be started for whatever reasonvoid startRoute(String routeId) throws Exception
routeId
- the route idException
- is thrown if the route could not be started for whatever reason@Deprecated void stopRoute(RouteDefinition route) throws Exception
route
- the route to stopException
- is thrown if the route could not be stopped for whatever reasonvoid stopRoute(String routeId) throws Exception
ShutdownStrategy
.routeId
- the route idException
- is thrown if the route could not be stopped for whatever reasonsuspendRoute(String)
void stopRoute(String routeId, long timeout, TimeUnit timeUnit) throws Exception
ShutdownStrategy
with a specified timeout.routeId
- the route idtimeout
- timeouttimeUnit
- the unit to useException
- is thrown if the route could not be stopped for whatever reasonsuspendRoute(String, long, java.util.concurrent.TimeUnit)
boolean stopRoute(String routeId, long timeout, TimeUnit timeUnit, boolean abortAfterTimeout) throws Exception
ShutdownStrategy
with a specified timeout
and optional abortAfterTimeout mode.routeId
- the route idtimeout
- timeouttimeUnit
- the unit to useabortAfterTimeout
- should abort shutdown after timeoutException
- is thrown if the route could not be stopped for whatever reasonsuspendRoute(String, long, java.util.concurrent.TimeUnit)
@Deprecated void shutdownRoute(String routeId) throws Exception
ShutdownStrategy
.routeId
- the route idException
- is thrown if the route could not be shutdown for whatever reason@Deprecated void shutdownRoute(String routeId, long timeout, TimeUnit timeUnit) throws Exception
ShutdownStrategy
with a specified timeout.routeId
- the route idtimeout
- timeouttimeUnit
- the unit to useException
- is thrown if the route could not be shutdown for whatever reasonboolean removeRoute(String routeId) throws Exception
routeId
- the route idException
- is thrown if the route could not be shutdown for whatever reasonvoid resumeRoute(String routeId) throws Exception
routeId
- the route idException
- is thrown if the route could not be resumed for whatever reasonvoid suspendRoute(String routeId) throws Exception
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 insteadrouteId
- the route idException
- is thrown if the route could not be suspended for whatever reasonvoid suspendRoute(String routeId, long timeout, TimeUnit timeUnit) throws Exception
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 insteadrouteId
- the route idtimeout
- timeouttimeUnit
- the unit to useException
- is thrown if the route could not be suspended for whatever reasonServiceStatus getRouteStatus(String routeId)
routeId
- the route idboolean isStartingRoutes()
LifecycleStrategy
or the likes, in case
they need to react differently.TypeConverter getTypeConverter()
TypeConverterRegistry getTypeConverterRegistry()
Registry getRegistry()
<T> T getRegistry(Class<T> type)
type
- the registry type such as JndiRegistry
Injector getInjector()
ManagementMBeanAssembler getManagementMBeanAssembler()
List<LifecycleStrategy> getLifecycleStrategies()
void addLifecycleStrategy(LifecycleStrategy lifecycleStrategy)
lifecycleStrategy
- the strategyLanguage resolveLanguage(String language)
language
- name of the languageString resolvePropertyPlaceholders(String text) throws Exception
text
- the text such as an endpoint uri or the likesException
- is thrown if property placeholders was used and there was an error resolving themString getPropertyPrefixToken()
null
.null
String getPropertySuffixToken()
null
.null
List<String> getLanguageNames()
ProducerTemplate createProducerTemplate()
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.RuntimeCamelException
- is thrown if error starting the templateProducerTemplate createProducerTemplate(int maximumCacheSize)
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.maximumCacheSize
- the maximum cache sizeRuntimeCamelException
- is thrown if error starting the templateConsumerTemplate createConsumerTemplate()
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.RuntimeCamelException
- is thrown if error starting the templateConsumerTemplate createConsumerTemplate(int maximumCacheSize)
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.maximumCacheSize
- the maximum cache sizeRuntimeCamelException
- is thrown if error starting the templatevoid addInterceptStrategy(InterceptStrategy interceptStrategy)
interceptStrategy
- the strategyList<InterceptStrategy> getInterceptStrategies()
@Deprecated ErrorHandlerBuilder getErrorHandlerBuilder()
ErrorHandlerFactory
in Camel 3.0void setErrorHandlerBuilder(ErrorHandlerFactory errorHandlerBuilder)
errorHandlerBuilder
- the builderScheduledExecutorService getErrorHandlerExecutorService()
@Deprecated void setDataFormats(Map<String,DataFormatDefinition> dataFormats)
ModelCamelContext.setDataFormats(java.util.Map)
dataFormats
- the data formats@Deprecated Map<String,DataFormatDefinition> getDataFormats()
ModelCamelContext.getDataFormats()
DataFormat resolveDataFormat(String name)
name
- the data format name or a reference to it in the Registry
@Deprecated DataFormatDefinition resolveDataFormatDefinition(String name)
ModelCamelContext.resolveDataFormatDefinition(String)
name
- the data format definition name or a reference to it in the Registry
DataFormatResolver getDataFormatResolver()
void setDataFormatResolver(DataFormatResolver dataFormatResolver)
dataFormatResolver
- the resolvervoid setProperties(Map<String,String> properties)
properties
- propertiesMap<String,String> getProperties()
String getProperty(String name)
FactoryFinder getDefaultFactoryFinder()
void setFactoryFinderResolver(FactoryFinderResolver resolver)
resolver
- the factory finder resolverFactoryFinder getFactoryFinder(String path) throws NoFactoryAvailableException
path
- the META-INF pathNoFactoryAvailableException
- is thrown if a factory could not be foundClassResolver getClassResolver()
PackageScanClassResolver getPackageScanClassResolver()
void setClassResolver(ClassResolver resolver)
resolver
- the resolvervoid setPackageScanClassResolver(PackageScanClassResolver resolver)
resolver
- the resolvervoid setProducerServicePool(ServicePool<Endpoint,Producer> servicePool)
Producer
pooling.servicePool
- the poolServicePool<Endpoint,Producer> getProducerServicePool()
Producer
pooling.void setNodeIdFactory(NodeIdFactory factory)
factory
- custom factory to useNodeIdFactory getNodeIdFactory()
ManagementStrategy getManagementStrategy()
void setManagementStrategy(ManagementStrategy strategy)
strategy
- the management strategyInterceptStrategy getDefaultTracer()
void setDefaultTracer(InterceptStrategy tracer)
tracer
- the custom tracer to use as default tracerInterceptStrategy getDefaultBacklogTracer()
void setDefaultBacklogTracer(InterceptStrategy backlogTracer)
backlogTracer
- the custom tracer to use as default backlog tracerInterceptStrategy getDefaultBacklogDebugger()
void setDefaultBacklogDebugger(InterceptStrategy backlogDebugger)
backlogDebugger
- the custom debugger to use as default backlog debuggervoid disableJMX() throws IllegalStateException
ManagementStrategy
.
Important: This method must be called before the CamelContext
is started.IllegalStateException
- is thrown if the CamelContext
is not in stopped state.InflightRepository getInflightRepository()
void setInflightRepository(InflightRepository repository)
repository
- the repositoryClassLoader getApplicationContextClassLoader()
void setApplicationContextClassLoader(ClassLoader classLoader)
classLoader
- the class loaderShutdownStrategy getShutdownStrategy()
void setShutdownStrategy(ShutdownStrategy shutdownStrategy)
shutdownStrategy
- the custom strategyExecutorServiceManager getExecutorServiceManager()
ExecutorServiceManager
@Deprecated ExecutorServiceStrategy getExecutorServiceStrategy()
getExecutorServiceManager()
ExecutorServiceStrategy
void setExecutorServiceManager(ExecutorServiceManager executorServiceManager)
ExecutorServiceManager
executorServiceManager
- the custom managerProcessorFactory getProcessorFactory()
ProcessorFactory
void setProcessorFactory(ProcessorFactory processorFactory)
ProcessorFactory
processorFactory
- the custom factoryDebugger getDebugger()
Debugger
void setDebugger(Debugger debugger)
Debugger
debugger
- the debuggerUuidGenerator getUuidGenerator()
UuidGenerator
void setUuidGenerator(UuidGenerator uuidGenerator)
UuidGenerator
(should only be set once)uuidGenerator
- the UUID Generator@Deprecated Boolean isLazyLoadTypeConverters()
@Deprecated void setLazyLoadTypeConverters(Boolean lazyLoadTypeConverters)
lazyLoadTypeConverters
- true to load lazy, false to load on startupBoolean isTypeConverterStatisticsEnabled()
void setTypeConverterStatisticsEnabled(Boolean typeConverterStatisticsEnabled)
org.apache.camel.spi.TypeConverterRegistry#getStatistics()#setTypeConverterStatisticsEnabled(Boolean)
method,
or from JMX on the ManagedTypeConverterRegistryMBean
mbean.typeConverterStatisticsEnabled
- true to enable, false to disableBoolean isUseMDCLogging()
void setUseMDCLogging(Boolean useMDCLogging)
useMDCLogging
- true to enable MDC logging, false to disableBoolean isUseBreadcrumb()
void setUseBreadcrumb(Boolean useBreadcrumb)
useBreadcrumb
- true to enable breadcrumb, false to disableMap<String,Properties> findComponents() throws LoadPropertiesException, IOException
Registry
.LoadPropertiesException
- is thrown if error during classpath discovery of the componentsIOException
- is thrown if error during classpath discovery of the componentsString getComponentDocumentation(String componentName) throws IOException
IOException
String createRouteStaticEndpointJson(String routeId)
routeId
- for a particular route, or null for all routesString createRouteStaticEndpointJson(String routeId, boolean includeDynamic)
routeId
- for a particular route, or null for all routesincludeDynamic
- whether to include dynamic endpointsStreamCachingStrategy getStreamCachingStrategy()
StreamCachingStrategy
to use.void setStreamCachingStrategy(StreamCachingStrategy streamCachingStrategy)
StreamCachingStrategy
to use.UnitOfWorkFactory getUnitOfWorkFactory()
UnitOfWorkFactory
to use.void setUnitOfWorkFactory(UnitOfWorkFactory unitOfWorkFactory)
UnitOfWorkFactory
to use.RuntimeEndpointRegistry getRuntimeEndpointRegistry()
RuntimeEndpointRegistry
to use, or null if none is in use.void setRuntimeEndpointRegistry(RuntimeEndpointRegistry runtimeEndpointRegistry)
RuntimeEndpointRegistry
to use.Apache Camel