org.apache.camel

Interface ExtendedCamelContext

All Superinterfaces:

AutoCloseable, CamelContext, RuntimeConfiguration, Service, ShutdownableService, StatefulService, SuspendableService

public interface ExtendedCamelContext
extends CamelContext

Extended CamelContext which contains the methods and APIs that are not primary intended for Camel end users but for SPI, custom components, or more advanced used-cases with Camel.

Method Summary

Modifier and Type	Method and Description
void	addInterceptStrategy(InterceptStrategy interceptStrategy) Adds the given interceptor strategy
void	addLogListener(LogListener listener) Adds a LogListener.
AsyncProcessor	createMulticast(Collection<Processor> processors, ExecutorService executor, boolean shutdownExecutorService) Creates a new multicast processor which sends an exchange to all the processors.
AnnotationBasedProcessorFactory	getAnnotationBasedProcessorFactory() Gets the AnnotationBasedProcessorFactory to use.
AsyncProcessorAwaitManager	getAsyncProcessorAwaitManager() Gets the AsyncProcessor await manager.
BeanIntrospection	getBeanIntrospection() Gets the BeanIntrospection
CamelBeanPostProcessor	getBeanPostProcessor() Returns the bean post processor used to do any bean customization.
BeanProcessorFactory	getBeanProcessorFactory() Gets the BeanProcessorFactory to use.
BeanProxyFactory	getBeanProxyFactory() Gets the BeanProxyFactory to use.
ComponentResolver	getComponentResolver() Gets the ComponentResolver to use.
ConfigurerResolver	getConfigurerResolver() Gets the ConfigurerResolver to use.
DataFormatResolver	getDataFormatResolver() Gets the current data format resolver
FactoryFinder	getDefaultFactoryFinder() Gets the default FactoryFinder which will be used for the loading the factory class from META-INF
DeferServiceFactory	getDeferServiceFactory() Gets the DeferServiceFactory to use.
ScheduledExecutorService	getErrorHandlerExecutorService() Gets the default shared thread pool for error handlers which leverages this for asynchronous redelivery tasks.
ErrorHandlerFactory	getErrorHandlerFactory() Gets the default error handler builder which is inherited by the routes
FactoryFinder	getFactoryFinder(String path) Gets the FactoryFinder which will be used for the loading the factory class from META-INF in the given path
FactoryFinderResolver	getFactoryFinderResolver() Gets the factory finder resolver to use
HeadersMapFactory	getHeadersMapFactory() Gets the HeadersMapFactory to use.
List<InterceptStrategy>	getInterceptStrategies() Gets the interceptor strategies
LanguageResolver	getLanguageResolver() Gets the LanguageResolver to use.
Set<LogListener>	getLogListeners() Gets a list of LogListener.
ManagementMBeanAssembler	getManagementMBeanAssembler() Returns the management mbean assembler
ModelJAXBContextFactory	getModelJAXBContextFactory() Returns the JAXB Context factory used to create Models.
ModelToXMLDumper	getModelToXMLDumper() Gets the ModelToXMLDumper to be used.
NodeIdFactory	getNodeIdFactory() Gets the node id factory
PackageScanClassResolver	getPackageScanClassResolver() Returns the package scanning class resolver
PackageScanResourceResolver	getPackageScanResourceResolver() Returns the package scanning resource resolver
ProcessorFactory	getProcessorFactory() Gets the current ProcessorFactory
ReactiveExecutor	getReactiveExecutor() Gets the ReactiveExecutor to use.
List<RouteStartupOrder>	getRouteStartupOrder() Returns the order in which the route inputs was started.
RuntimeCamelCatalog	getRuntimeCamelCatalog() Gets the RuntimeCamelCatalog if available on the classpath.
UnitOfWorkFactory	getUnitOfWorkFactory() Gets the UnitOfWorkFactory to use.
XMLRoutesDefinitionLoader	getXMLRoutesDefinitionLoader() Gets the XMLRoutesDefinitionLoader to be used.
boolean	isAllowAddingNewRoutes() Whether its allowed to add new routes after Camel has been started.
boolean	isEventNotificationApplicable() Whether event notification is applicable (possible).
boolean	isSetupRoutes() Indicates whether current thread is setting up route(s) as part of starting Camel from spring/blueprint.
void	registerEndpointCallback(EndpointStrategy strategy) Registers a callback to allow you to do custom logic when an Endpoint is about to be registered to the EndpointRegistry.
void	setAllowAddingNewRoutes(boolean allowAddingNewRoutes) Whether its allowed to add new routes after Camel has been started.
void	setAsyncProcessorAwaitManager(AsyncProcessorAwaitManager manager) Sets a custom AsyncProcessor await manager.
void	setBeanIntrospection(BeanIntrospection beanIntrospection) Sets a custom BeanIntrospection.
void	setComponentResolver(ComponentResolver componentResolver) Sets a custom ComponentResolver to use.
void	setConfigurerResolver(ConfigurerResolver configurerResolver) Sets the ConfigurerResolver to use.
void	setDataFormatResolver(DataFormatResolver dataFormatResolver) Sets a custom data format resolver
void	setErrorHandlerFactory(ErrorHandlerFactory errorHandlerFactory) Sets the default error handler builder which is inherited by the routes
void	setEventNotificationApplicable(boolean eventNotificationApplicable) Used as internal optimization in Camel to flag whether event notification is applicable or not.
void	setFactoryFinderResolver(FactoryFinderResolver resolver) Sets the factory finder resolver to use.
void	setHeadersMapFactory(HeadersMapFactory factory) Sets a custom HeadersMapFactory to be used.
void	setLanguageResolver(LanguageResolver languageResolver) Sets a custom LanguageResolver to use.
void	setModelJAXBContextFactory(ModelJAXBContextFactory modelJAXBContextFactory) Sets a custom JAXB Context factory to be used
void	setModelToXMLDumper(ModelToXMLDumper modelToXMLDumper) Sets a custom ModelToXMLDumper to be used.
void	setName(String name) Sets the name (id) of the this context.
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	setPackageScanResourceResolver(PackageScanResourceResolver resolver) Sets the package scanning resource resolver to use
void	setProcessorFactory(ProcessorFactory processorFactory) Sets a custom ProcessorFactory
void	setReactiveExecutor(ReactiveExecutor reactiveExecutor) Sets a custom ReactiveExecutor to be used.
void	setRegistry(Registry registry) Sets the registry Camel should use for looking up beans by name or type.
void	setRuntimeCamelCatalog(RuntimeCamelCatalog runtimeCamelCatalog) Sets the RuntimeCamelCatalog to use.
void	setUnitOfWorkFactory(UnitOfWorkFactory unitOfWorkFactory) Sets a custom UnitOfWorkFactory to use.
void	setupManagement(Map<String,Object> options) Setup management according to whether JMX is enabled or disabled.
void	setupRoutes(boolean done) Method to signal to CamelContext that the process to initialize setup routes is in progress.
void	setXMLRoutesDefinitionLoader(XMLRoutesDefinitionLoader xmlRoutesDefinitionLoader) Sets a custom XMLRoutesDefinitionLoader to be used.

Methods inherited from interface org.apache.camel.CamelContext

adapt, addComponent, addEndpoint, addLifecycleStrategy, addRestConfiguration, addRoutePolicyFactory, addRoutes, addService, addService, addService, addStartupListener, createConsumerTemplate, createConsumerTemplate, createDataFormat, createFluentProducerTemplate, createFluentProducerTemplate, createProducerTemplate, createProducerTemplate, deferStartService, disableJMX, getApplicationContextClassLoader, getClassResolver, getComponent, getComponent, getComponent, getComponent, getComponentNames, getDebugger, getEndpoint, getEndpoint, getEndpoint, getEndpointMap, getEndpointRegistry, getEndpoints, getExecutorServiceManager, getExtension, getGlobalEndpointConfiguration, getGlobalOption, getGlobalOptions, getInflightRepository, getInjector, getLanguageNames, getLifecycleStrategies, getManagementName, getManagementNameStrategy, getManagementStrategy, getMDCLoggingKeysPattern, getMessageHistoryFactory, getName, getNameStrategy, getProcessor, getProcessor, getPropertiesComponent, getRegistry, getRegistry, getRestConfiguration, getRestConfiguration, getRestConfigurations, getRestRegistry, getRoute, getRouteController, getRoutePolicyFactories, getRoutes, getRoutesSize, getRuntimeEndpointRegistry, getShutdownStrategy, getSSLContextParameters, getStartDate, getStatus, getStreamCachingStrategy, getTracer, getTransformerRegistry, getTypeConverter, getTypeConverterRegistry, getUptime, getUptimeMillis, getUuidGenerator, getValidatorRegistry, getVersion, hasComponent, hasEndpoint, hasService, hasService, hasServices, isLoadTypeConverters, isTypeConverterStatisticsEnabled, isUseBreadcrumb, isUseDataType, isUseMDCLogging, isVetoStarted, removeComponent, removeEndpoint, removeEndpoints, removeRoute, removeService, resolveDataFormat, resolveLanguage, resolvePropertyPlaceholders, resolveTransformer, resolveTransformer, resolveValidator, setApplicationContextClassLoader, setClassResolver, setDebugger, setExecutorServiceManager, setExtension, setGlobalOptions, setInflightRepository, setInjector, setLoadTypeConverters, setManagementName, setManagementNameStrategy, setManagementStrategy, setMDCLoggingKeysPattern, setMessageHistoryFactory, setNameStrategy, setPropertiesComponent, setRestConfiguration, setRestRegistry, setRouteController, setRuntimeEndpointRegistry, setShutdownStrategy, setSSLContextParameters, setStreamCachingStrategy, setTracer, setTypeConverterRegistry, setTypeConverterStatisticsEnabled, setUseBreadcrumb, setUseDataType, setUseMDCLogging, setUuidGenerator, start, stop

Methods inherited from interface org.apache.camel.StatefulService

isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

Methods inherited from interface org.apache.camel.Service

build, close, init

Methods inherited from interface org.apache.camel.RuntimeConfiguration

getDelayer, getShutdownRoute, getShutdownRunningTask, getTracingPattern, isAllowUseOriginalMessage, isAutoStartup, isBacklogTracing, isCaseInsensitiveHeaders, isDebugging, isLogExhaustedMessageBody, isLogMask, isMessageHistory, isStreamCaching, isTracing, setAllowUseOriginalMessage, setAutoStartup, setBacklogTracing, setCaseInsensitiveHeaders, setDebugging, setDelayer, setLogExhaustedMessageBody, setLogMask, setMessageHistory, setShutdownRoute, setShutdownRunningTask, setStreamCaching, setTracing, setTracingPattern

Method Detail

setName

void setName(String name)

Sets the name (id) of the this context.

This operation is mostly only used by different Camel runtimes such as camel-spring, camel-cdi, camel-spring-boot etc. Important: Setting the name should only be set before CamelContext is started.

Parameters:

name - the name

setRegistry

void setRegistry(Registry registry)

Sets the registry Camel should use for looking up beans by name or type.

This operation is mostly only used by different Camel runtimes such as camel-spring, camel-cdi, camel-spring-boot etc. Important: Setting the registry should only be set before CamelContext is started.

Parameters:

registry - the registry such as DefaultRegistry or

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()

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.

registerEndpointCallback

void registerEndpointCallback(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 registered it will be executed on the already registered endpoints allowing you to catch-up

Parameters:

strategy - callback to be invoked

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

getBeanPostProcessor

CamelBeanPostProcessor getBeanPostProcessor()

Returns the bean post processor used to do any bean customization.

Returns:

the bean post processor.

getManagementMBeanAssembler

ManagementMBeanAssembler getManagementMBeanAssembler()

Returns the management mbean assembler

Returns:

the mbean assembler

createMulticast

AsyncProcessor createMulticast(Collection<Processor> processors,
                               ExecutorService executor,
                               boolean shutdownExecutorService)

Creates a new multicast processor which sends an exchange to all the processors.

Parameters:

processors - the list of processors to send to

executor - the executor to use

Returns:

a multicasting processor

getErrorHandlerFactory

ErrorHandlerFactory getErrorHandlerFactory()

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

Returns:

the builder

setErrorHandlerFactory

void setErrorHandlerFactory(ErrorHandlerFactory errorHandlerFactory)

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

Parameters:

errorHandlerFactory - the builder

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

getComponentResolver

ComponentResolver getComponentResolver()

Gets the ComponentResolver to use.

setComponentResolver

void setComponentResolver(ComponentResolver componentResolver)

Sets a custom ComponentResolver to use.

getLanguageResolver

LanguageResolver getLanguageResolver()

Gets the LanguageResolver to use.

setLanguageResolver

void setLanguageResolver(LanguageResolver languageResolver)

Sets a custom LanguageResolver to use.

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

getPackageScanClassResolver

PackageScanClassResolver getPackageScanClassResolver()

Returns the package scanning class resolver

Returns:

the resolver

setPackageScanClassResolver

void setPackageScanClassResolver(PackageScanClassResolver resolver)

Sets the package scanning class resolver to use

Parameters:

resolver - the resolver

getPackageScanResourceResolver

PackageScanResourceResolver getPackageScanResourceResolver()

Returns the package scanning resource resolver

Returns:

the resolver

setPackageScanResourceResolver

void setPackageScanResourceResolver(PackageScanResourceResolver resolver)

Sets the package scanning resource resolver to use

Parameters:

resolver - the resolver

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

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

setFactoryFinderResolver

void setFactoryFinderResolver(FactoryFinderResolver resolver)

Sets the factory finder resolver to use.

Parameters:

resolver - the factory finder resolver

getFactoryFinderResolver

FactoryFinderResolver getFactoryFinderResolver()

Gets the factory finder resolver to use

Returns:

the factory finder resolver

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

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

getDeferServiceFactory

DeferServiceFactory getDeferServiceFactory()

Gets the DeferServiceFactory to use.

getUnitOfWorkFactory

UnitOfWorkFactory getUnitOfWorkFactory()

Gets the UnitOfWorkFactory to use.

setUnitOfWorkFactory

void setUnitOfWorkFactory(UnitOfWorkFactory unitOfWorkFactory)

Sets a custom UnitOfWorkFactory to use.

getAnnotationBasedProcessorFactory

AnnotationBasedProcessorFactory getAnnotationBasedProcessorFactory()

Gets the AnnotationBasedProcessorFactory to use.

getBeanProxyFactory

BeanProxyFactory getBeanProxyFactory()

Gets the BeanProxyFactory to use.

getBeanProcessorFactory

BeanProcessorFactory getBeanProcessorFactory()

Gets the BeanProcessorFactory to use.

getErrorHandlerExecutorService

ScheduledExecutorService getErrorHandlerExecutorService()

Gets the default shared thread pool for error handlers which leverages this for asynchronous redelivery tasks.

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

setupManagement

void setupManagement(Map<String,Object> options)

Setup management according to whether JMX is enabled or disabled.

Parameters:

options - optional parameters to configure ManagementAgent.

getLogListeners

Set<LogListener> getLogListeners()

Gets a list of LogListener.

addLogListener

void addLogListener(LogListener listener)

Adds a LogListener.

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

getBeanIntrospection

BeanIntrospection getBeanIntrospection()

Gets the BeanIntrospection

setBeanIntrospection

void setBeanIntrospection(BeanIntrospection beanIntrospection)

Sets a custom BeanIntrospection.

getHeadersMapFactory

HeadersMapFactory getHeadersMapFactory()

Gets the HeadersMapFactory to use.

setHeadersMapFactory

void setHeadersMapFactory(HeadersMapFactory factory)

Sets a custom HeadersMapFactory to be used.

getReactiveExecutor

ReactiveExecutor getReactiveExecutor()

Gets the ReactiveExecutor to use.

setReactiveExecutor

void setReactiveExecutor(ReactiveExecutor reactiveExecutor)

Sets a custom ReactiveExecutor to be used.

isEventNotificationApplicable

boolean isEventNotificationApplicable()

Whether event notification is applicable (possible). This API is used internally in Camel as optimization.

setEventNotificationApplicable

void setEventNotificationApplicable(boolean eventNotificationApplicable)

Used as internal optimization in Camel to flag whether event notification is applicable or not.

setXMLRoutesDefinitionLoader

void setXMLRoutesDefinitionLoader(XMLRoutesDefinitionLoader xmlRoutesDefinitionLoader)

Sets a custom XMLRoutesDefinitionLoader to be used.

getXMLRoutesDefinitionLoader

XMLRoutesDefinitionLoader getXMLRoutesDefinitionLoader()

Gets the XMLRoutesDefinitionLoader to be used.

setModelToXMLDumper

void setModelToXMLDumper(ModelToXMLDumper modelToXMLDumper)

Sets a custom ModelToXMLDumper to be used.

getModelToXMLDumper

ModelToXMLDumper getModelToXMLDumper()

Gets the ModelToXMLDumper to be used.

getRuntimeCamelCatalog

RuntimeCamelCatalog getRuntimeCamelCatalog()

Gets the RuntimeCamelCatalog if available on the classpath.

setRuntimeCamelCatalog

void setRuntimeCamelCatalog(RuntimeCamelCatalog runtimeCamelCatalog)

Sets the RuntimeCamelCatalog to use.

getConfigurerResolver

ConfigurerResolver getConfigurerResolver()

Gets the ConfigurerResolver to use.

setConfigurerResolver

void setConfigurerResolver(ConfigurerResolver configurerResolver)

Sets the ConfigurerResolver to use.

setAllowAddingNewRoutes

void setAllowAddingNewRoutes(boolean allowAddingNewRoutes)

Whether its allowed to add new routes after Camel has been started. This is enabled by default. Setting this to false allows Camel to do some internal optimizations to reduce memory footprint.

This should only be done on a JVM with a single Camel application (microservice like camel-main, camel-quarkus, camel-spring-boot). As this affects the entire JVM where Camel JARs are on the classpath.

isAllowAddingNewRoutes

boolean isAllowAddingNewRoutes()

Whether its allowed to add new routes after Camel has been started. This is enabled by default. Setting this to false allows Camel to do some internal optimizations to reduce memory footprint.

This should only be done on a JVM with a single Camel application (microservice like camel-main, camel-quarkus, camel-spring-boot). As this affects the entire JVM where Camel JARs are on the classpath.