Package org.apache.camel.spring

Class CamelContextFactoryBean

    • Method Detail

      • getBeanForType

        protected <S> S getBeanForType​(Class<S> clazz)
        Specified by:
        getBeanForType in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • findRouteBuildersByContextScan

        protected void findRouteBuildersByContextScan​(org.apache.camel.spi.PackageScanFilter filter,
                                              boolean includeNonSingletons,
                                              List<org.apache.camel.RoutesBuilder> builders)
                                       throws Exception
        Specified by:
        findRouteBuildersByContextScan in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>
        Throws:
        Exception

      • postProcessBeforeInit

        protected void postProcessBeforeInit​(org.apache.camel.builder.RouteBuilder builder)
        Specified by:
        postProcessBeforeInit in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • getRoutes

        public List<org.apache.camel.model.RouteDefinition> getRoutes()
        Specified by:
        getRoutes in interface org.apache.camel.model.RouteContainer
        Specified by:
        getRoutes in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setRoutes

        public void setRoutes​(List<org.apache.camel.model.RouteDefinition> routes)
        Contains the Camel routes
        Specified by:
        setRoutes in interface org.apache.camel.model.RouteContainer

      • getRests

        public List<org.apache.camel.model.rest.RestDefinition> getRests()
        Specified by:
        getRests in interface org.apache.camel.model.rest.RestContainer
        Specified by:
        getRests in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setRests

        public void setRests​(List<org.apache.camel.model.rest.RestDefinition> rests)
        Contains the rest services defined using the rest-dsl
        Specified by:
        setRests in interface org.apache.camel.model.rest.RestContainer

      • getRestConfiguration

        public org.apache.camel.model.rest.RestConfigurationDefinition getRestConfiguration()
        Specified by:
        getRestConfiguration in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setRestConfiguration

        public void setRestConfiguration​(org.apache.camel.model.rest.RestConfigurationDefinition restConfiguration)
        Configuration for rest-dsl

      • getIntercepts

        public List<org.apache.camel.model.InterceptDefinition> getIntercepts()
        Specified by:
        getIntercepts in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setIntercepts

        public void setIntercepts​(List<org.apache.camel.model.InterceptDefinition> intercepts)
        Configuration of interceptors.

      • getInterceptFroms

        public List<org.apache.camel.model.InterceptFromDefinition> getInterceptFroms()
        Specified by:
        getInterceptFroms in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setInterceptFroms

        public void setInterceptFroms​(List<org.apache.camel.model.InterceptFromDefinition> interceptFroms)
        Configuration of interceptors that triggers from the beginning of routes.

      • getInterceptSendToEndpoints

        public List<org.apache.camel.model.InterceptSendToEndpointDefinition> getInterceptSendToEndpoints()
        Specified by:
        getInterceptSendToEndpoints in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setInterceptSendToEndpoints

        public void setInterceptSendToEndpoints​(List<org.apache.camel.model.InterceptSendToEndpointDefinition> interceptSendToEndpoints)
        Configuration of interceptors that triggers sending messages to endpoints.

      • getGlobalOptions

        public org.apache.camel.model.GlobalOptionsDefinition getGlobalOptions()
        Specified by:
        getGlobalOptions in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setGlobalOptions

        public void setGlobalOptions​(org.apache.camel.model.GlobalOptionsDefinition globalOptions)
        Configuration of CamelContext properties such as limit of debug logging and other general options.

      • getPackageScan

        public org.apache.camel.model.PackageScanDefinition getPackageScan()
        Specified by:
        getPackageScan in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setPackageScan

        public void setPackageScan​(org.apache.camel.model.PackageScanDefinition packageScan)
        Sets the package scanning information. Package scanning allows for the automatic discovery of certain camel classes at runtime for inclusion e.g. RouteBuilder implementations
        Specified by:
        setPackageScan in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>
        Parameters:
        packageScan - the package scan

      • getContextScan

        public org.apache.camel.model.ContextScanDefinition getContextScan()
        Specified by:
        getContextScan in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setContextScan

        public void setContextScan​(org.apache.camel.model.ContextScanDefinition contextScan)
        Sets the context scanning (eg Spring's ApplicationContext) information. Context scanning allows for the automatic discovery of Camel routes runtime for inclusion e.g. RouteBuilder implementations
        Specified by:
        setContextScan in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>
        Parameters:
        contextScan - the context scan

      • getCamelPropertyPlaceholder

        public org.apache.camel.core.xml.CamelPropertyPlaceholderDefinition getCamelPropertyPlaceholder()
        Specified by:
        getCamelPropertyPlaceholder in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setCamelPropertyPlaceholder

        public void setCamelPropertyPlaceholder​(org.apache.camel.core.xml.CamelPropertyPlaceholderDefinition camelPropertyPlaceholder)
        Configuration of property placeholder

      • getCamelStreamCachingStrategy

        public org.apache.camel.core.xml.CamelStreamCachingStrategyDefinition getCamelStreamCachingStrategy()
        Specified by:
        getCamelStreamCachingStrategy in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setCamelStreamCachingStrategy

        public void setCamelStreamCachingStrategy​(org.apache.camel.core.xml.CamelStreamCachingStrategyDefinition camelStreamCachingStrategy)
        Configuration of stream caching.

      • getCamelRouteController

        public org.apache.camel.core.xml.CamelRouteControllerDefinition getCamelRouteController()
        Specified by:
        getCamelRouteController in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setCamelRouteController

        public void setCamelRouteController​(org.apache.camel.core.xml.CamelRouteControllerDefinition camelRouteController)
        Configuration of route controller.

      • setCamelJMXAgent

        public void setCamelJMXAgent​(org.apache.camel.core.xml.CamelJMXAgentDefinition agent)
        Configuration of JMX Agent.

      • setTrace

        public void setTrace​(String trace)
        Sets whether tracing is enabled or not. To use tracing then this must be enabled on startup to be installed in the CamelContext.

      • setBacklogTrace

        public void setBacklogTrace​(String backlogTrace)
        Sets whether backlog tracing is enabled or not. To use backlog tracing then this must be enabled on startup to be installed in the CamelContext.

      • setDebug

        public void setDebug​(String debug)
        Sets whether debugging is enabled or not. To use debugging then this must be enabled on startup to be installed in the CamelContext.

      • setTracePattern

        public void setTracePattern​(String tracePattern)
        Tracing pattern to match which node EIPs to trace. For example to match all To EIP nodes, use to*. The pattern matches by node and route id's Multiple patterns can be separated by comma.

      • setMessageHistory

        public void setMessageHistory​(String messageHistory)
        Sets whether message history is enabled or not.

      • setLogMask

        public void setLogMask​(String logMask)
        Sets whether security mask for Logging is enabled or not.

      • setLogExhaustedMessageBody

        public void setLogExhaustedMessageBody​(String logExhaustedMessageBody)
        Sets whether to log exhausted message body with message history.

      • setStreamCache

        public void setStreamCache​(String streamCache)
        Sets whether stream caching is enabled or not.

      • setDelayer

        public void setDelayer​(String delayer)
        Sets a delay value in millis that a message is delayed at every step it takes in the route path, slowing the process down to better observe what is occurring

      • setAutoStartup

        public void setAutoStartup​(String autoStartup)
        Sets whether the object should automatically start when Camel starts.

        Important: Currently only routes can be disabled, as CamelContexts are always started.
        Note: When setting auto startup false on CamelContext then that takes precedence and no routes is started. You would need to start CamelContext explicit using the CamelContextLifecycle.start() method, to start the context, and then you would need to start the routes manually using RouteController.startRoute(String).

      • setShutdownEager

        public void setShutdownEager​(String shutdownEager)
        Whether to shutdown CamelContext eager when Spring is shutting down. This ensure a cleaner shutdown of Camel, as dependent bean's are not shutdown at this moment. The bean's will then be shutdown after camelContext.

      • setMDCLoggingKeysPattern

        public void setMDCLoggingKeysPattern​(String mdcLoggingKeysPattern)
        Sets the pattern used for determine which custom MDC keys to propagate during message routing when the routing engine continues routing asynchronously for the given message. Setting this pattern to * will propagate all custom keys. Or setting the pattern to foo*,bar* will propagate any keys starting with either foo or bar. Notice that a set of standard Camel MDC keys are always propagated which starts with camel. as key name. The match rules are applied in this order (case insensitive): 1. exact match, returns true 2. wildcard match (pattern ends with a * and the name starts with the pattern), returns true 3. regular expression match, returns true 4. otherwise returns false

      • setUseDataType

        public void setUseDataType​(String 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
        • when using rest-dsl with binding turned on
        Otherwise data type is default off.

      • setUseBreadcrumb

        public void setUseBreadcrumb​(String useBreadcrumb)
        Set whether breadcrumb is enabled.

      • setAllowUseOriginalMessage

        public void setAllowUseOriginalMessage​(String allowUseOriginalMessage)
        Sets whether to allow access to the original message from Camel's error handler, or from UnitOfWork.getOriginalInMessage().

        Turning this off can optimize performance, as defensive copy of the original message is not needed.

      • setCaseInsensitiveHeaders

        public void setCaseInsensitiveHeaders​(String caseInsensitiveHeaders)
        Whether to use case sensitive or insensitive headers. Important: When using case sensitive (this is set to false). Then the map is case sensitive which means headers such as content-type and Content-Type are two different keys which can be a problem for some protocols such as HTTP based, which rely on case insensitive headers. However case sensitive implementations can yield faster performance. Therefore use case sensitive implementation with care. Default is true.

      • setInflightRepositoryBrowseEnabled

        public void setInflightRepositoryBrowseEnabled​(String inflightRepositoryBrowseEnabled)
        Sets whether the inflight repository should allow browsing each inflight exchange. This is by default disabled as there is a very slight performance overhead when enabled.

      • setManagementNamePattern

        public void setManagementNamePattern​(String managementNamePattern)
        The naming pattern for creating the CamelContext management name.

      • setThreadNamePattern

        public void setThreadNamePattern​(String threadNamePattern)
        Sets the thread name pattern used for creating the full thread name.

        The default pattern is: Camel (#camelId#) thread ##counter# - #name#

        Where #camelId# is the name of the CamelContext
        and #counter# is a unique incrementing counter.
        and #name# is the regular thread name.
        You can also use #longName# is the long thread name which can includes endpoint parameters etc.

      • setLoadTypeConverters

        public void setLoadTypeConverters​(String 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.

      • setTypeConverterStatisticsEnabled

        public void setTypeConverterStatisticsEnabled​(String 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 {@link org.apache.camel.spi.TypeConverterRegistry#getStatistics()#setTypeConverterStatisticsEnabled(Boolean)} method, or from JMX on the ManagedTypeConverterRegistryMBean mbean.

      • getTypeConverterExists

        public org.apache.camel.TypeConverterExists getTypeConverterExists()
        Specified by:
        getTypeConverterExists in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setTypeConverterExists

        public void setTypeConverterExists​(org.apache.camel.TypeConverterExists typeConverterExists)
        What should happen when attempting to add a duplicate type converter.

        The default behavior is to override the existing.

      • setTypeConverterExistsLoggingLevel

        public void setTypeConverterExistsLoggingLevel​(org.apache.camel.LoggingLevel typeConverterExistsLoggingLevel)
        The logging level to use when logging that a type converter already exists when attempting to add a duplicate type converter.

        The default logging level is WARN

      • getCamelJMXAgent

        public org.apache.camel.core.xml.CamelJMXAgentDefinition getCamelJMXAgent()
        Specified by:
        getCamelJMXAgent in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • getBuilderRefs

        public List<org.apache.camel.model.RouteBuilderDefinition> getBuilderRefs()
        Specified by:
        getBuilderRefs in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setBuilderRefs

        public void setBuilderRefs​(List<org.apache.camel.model.RouteBuilderDefinition> builderRefs)
        Refers to Java RouteBuilder instances to include as routes in this CamelContext.

      • getRouteRefs

        public List<org.apache.camel.model.RouteContextRefDefinition> getRouteRefs()
        Specified by:
        getRouteRefs in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setRouteRefs

        public void setRouteRefs​(List<org.apache.camel.model.RouteContextRefDefinition> routeRefs)
        Refers to XML routes to include as routes in this CamelContext.

      • getRestRefs

        public List<org.apache.camel.model.RestContextRefDefinition> getRestRefs()
        Specified by:
        getRestRefs in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setRestRefs

        public void setRestRefs​(List<org.apache.camel.model.RestContextRefDefinition> restRefs)
        Refers to XML rest-dsl to include as REST services in this CamelContext.

      • setErrorHandlerRef

        public void setErrorHandlerRef​(String errorHandlerRef)
        Sets the name of the error handler object used to default the error handling strategy

      • setDataFormats

        public void setDataFormats​(org.apache.camel.model.dataformat.DataFormatsDefinition dataFormats)
        Configuration of data formats.

      • getDataFormats

        public org.apache.camel.model.dataformat.DataFormatsDefinition getDataFormats()
        Specified by:
        getDataFormats in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setTransformers

        public void setTransformers​(org.apache.camel.model.transformer.TransformersDefinition transformers)
        Configuration of transformers.

      • getTransformers

        public org.apache.camel.model.transformer.TransformersDefinition getTransformers()
        Specified by:
        getTransformers in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setValidators

        public void setValidators​(org.apache.camel.model.validator.ValidatorsDefinition validators)
        Configuration of validators.

      • getValidators

        public org.apache.camel.model.validator.ValidatorsDefinition getValidators()
        Specified by:
        getValidators in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • getBeansFactory

        public List<org.apache.camel.core.xml.AbstractCamelFactoryBean<?>> getBeansFactory()
        Specified by:
        getBeansFactory in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setBeansFactory

        public void setBeansFactory​(List<org.apache.camel.core.xml.AbstractCamelFactoryBean<?>> beansFactory)
        Miscellaneous configurations

      • getBeans

        public List<?> getBeans()
        Specified by:
        getBeans in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setBeans

        public void setBeans​(List<?> beans)
        Miscellaneous configurations

      • getDefaultServiceCallConfiguration

        public org.apache.camel.model.cloud.ServiceCallConfigurationDefinition getDefaultServiceCallConfiguration()
        Specified by:
        getDefaultServiceCallConfiguration in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setDefaultServiceCallConfiguration

        public void setDefaultServiceCallConfiguration​(org.apache.camel.model.cloud.ServiceCallConfigurationDefinition defaultServiceCallConfiguration)
        ServiceCall EIP default configuration

      • getServiceCallConfigurations

        public List<org.apache.camel.model.cloud.ServiceCallConfigurationDefinition> getServiceCallConfigurations()
        Specified by:
        getServiceCallConfigurations in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setServiceCallConfigurations

        public void setServiceCallConfigurations​(List<org.apache.camel.model.cloud.ServiceCallConfigurationDefinition> serviceCallConfigurations)
        ServiceCall EIP configurations

      • getHystrixConfigurations

        public List<org.apache.camel.model.HystrixConfigurationDefinition> getHystrixConfigurations()
        Specified by:
        getHystrixConfigurations in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • getDefaultHystrixConfiguration

        public org.apache.camel.model.HystrixConfigurationDefinition getDefaultHystrixConfiguration()
        Specified by:
        getDefaultHystrixConfiguration in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setDefaultHystrixConfiguration

        public void setDefaultHystrixConfiguration​(org.apache.camel.model.HystrixConfigurationDefinition defaultHystrixConfiguration)
        Hystrix EIP default configuration

      • setHystrixConfigurations

        public void setHystrixConfigurations​(List<org.apache.camel.model.HystrixConfigurationDefinition> hystrixConfigurations)
        Hystrix Circuit Breaker EIP configurations

      • getDefaultResilience4jConfiguration

        public org.apache.camel.model.Resilience4jConfigurationDefinition getDefaultResilience4jConfiguration()
        Specified by:
        getDefaultResilience4jConfiguration in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setDefaultResilience4jConfiguration

        public void setDefaultResilience4jConfiguration​(org.apache.camel.model.Resilience4jConfigurationDefinition defaultResilience4jConfiguration)
        Resilience4j EIP default configuration

      • getResilience4jConfigurations

        public List<org.apache.camel.model.Resilience4jConfigurationDefinition> getResilience4jConfigurations()
        Specified by:
        getResilience4jConfigurations in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setResilience4jConfigurations

        public void setResilience4jConfigurations​(List<org.apache.camel.model.Resilience4jConfigurationDefinition> resilience4jConfigurations)
        Resilience4j Circuit Breaker EIP configurations

      • getDefaultFaultToleranceConfiguration

        public org.apache.camel.model.FaultToleranceConfigurationDefinition getDefaultFaultToleranceConfiguration()
        Specified by:
        getDefaultFaultToleranceConfiguration in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setDefaultFaultToleranceConfiguration

        public void setDefaultFaultToleranceConfiguration​(org.apache.camel.model.FaultToleranceConfigurationDefinition defaultFaultToleranceConfiguration)
        MicroProfile Fault Tolerance EIP default configuration

      • getFaultToleranceConfigurations

        public List<org.apache.camel.model.FaultToleranceConfigurationDefinition> getFaultToleranceConfigurations()
        Specified by:
        getFaultToleranceConfigurations in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setFaultToleranceConfigurations

        public void setFaultToleranceConfigurations​(List<org.apache.camel.model.FaultToleranceConfigurationDefinition> faultToleranceConfigurations)
        MicroProfile Circuit Breaker EIP configurations

      • setOnExceptions

        public void setOnExceptions​(List<org.apache.camel.model.OnExceptionDefinition> onExceptions)
        Configuration of error handlers that triggers on exceptions thrown.

      • getOnExceptions

        public List<org.apache.camel.model.OnExceptionDefinition> getOnExceptions()
        Specified by:
        getOnExceptions in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • getOnCompletions

        public List<org.apache.camel.model.OnCompletionDefinition> getOnCompletions()
        Specified by:
        getOnCompletions in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setOnCompletions

        public void setOnCompletions​(List<org.apache.camel.model.OnCompletionDefinition> onCompletions)
        Configuration of sub routes to run at the completion of routing.

      • getShutdownRoute

        public org.apache.camel.ShutdownRoute getShutdownRoute()
        Specified by:
        getShutdownRoute in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setShutdownRoute

        public void setShutdownRoute​(org.apache.camel.ShutdownRoute shutdownRoute)
        Sets the ShutdownRoute option for routes.

      • getShutdownRunningTask

        public org.apache.camel.ShutdownRunningTask getShutdownRunningTask()
        Specified by:
        getShutdownRunningTask in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setShutdownRunningTask

        public void setShutdownRunningTask​(org.apache.camel.ShutdownRunningTask shutdownRunningTask)
        Sets the ShutdownRunningTask option to use when shutting down a route.

      • getThreadPoolProfiles

        public List<org.apache.camel.model.ThreadPoolProfileDefinition> getThreadPoolProfiles()
        Specified by:
        getThreadPoolProfiles in class org.apache.camel.core.xml.AbstractCamelContextFactoryBean<SpringCamelContext>

      • setThreadPoolProfiles

        public void setThreadPoolProfiles​(List<org.apache.camel.model.ThreadPoolProfileDefinition> threadPoolProfiles)
        Configuration of thread pool profiles.

      • setDependsOn

        public void setDependsOn​(String dependsOn)
        List of other bean id's this CamelContext depends up. Multiple bean id's can be separated by comma.