org.apache.camel.main

Class MainConfigurationProperties

java.lang.Object

org.apache.camel.main.DefaultConfigurationProperties<MainConfigurationProperties>

org.apache.camel.main.MainConfigurationProperties

public class MainConfigurationProperties
extends DefaultConfigurationProperties<MainConfigurationProperties>

Global configuration for Camel Main to setup context name, stream caching and other global configurations.

Constructor Summary

Constructors

Constructor and Description
MainConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
int	getDurationHitExitCode()
String	getPackageScanRouteBuilders()
HystrixConfigurationProperties	hystrix() To configure Circuit Breaker EIP with Hystrix
boolean	isAutoConfigurationEnabled()
boolean	isAutoConfigurationEnvironmentVariablesEnabled()
boolean	isAutoConfigurationFailFast()
boolean	isAutoConfigurationLogSummary()
boolean	isAutowireComponentProperties()
boolean	isAutowireComponentPropertiesAllowPrivateSetter()
boolean	isAutowireComponentPropertiesDeep()
boolean	isAutowireComponentPropertiesNonNullOnly()
boolean	isHangupInterceptorEnabled()
Resilience4jConfigurationProperties	resilience4j() To configure Circuit Breaker EIP with Resilience4j
RestConfigurationProperties	rest() To configure Rest DSL
void	setAutoConfigurationEnabled(boolean autoConfigurationEnabled) Whether auto configuration of components, dataformats, languages is enabled or not.
void	setAutoConfigurationEnvironmentVariablesEnabled(boolean autoConfigurationEnvironmentVariablesEnabled) Whether auto configuration should include OS environment variables as well.
void	setAutoConfigurationFailFast(boolean autoConfigurationFailFast) Whether auto configuration should fail fast when configuring one ore more properties fails for whatever reason such as a invalid property name, etc.
void	setAutoConfigurationLogSummary(boolean autoConfigurationLogSummary) Whether auto configuration should log a summary with the configured properties.
void	setAutowireComponentProperties(boolean autowireComponentProperties) Whether autowiring components with properties that are of same type, which has been added to the Camel registry, as a singleton instance.
void	setAutowireComponentPropertiesAllowPrivateSetter(boolean autowireComponentPropertiesAllowPrivateSetter) Whether autowiring components allows to use private setter method when setting the value.
void	setAutowireComponentPropertiesDeep(boolean autowireComponentPropertiesDeep) Whether autowiring components (with deep nesting by attempting to walk as deep down the object graph by creating new empty objects on the way if needed) with properties that are of same type, which has been added to the Camel registry, as a singleton instance.
void	setAutowireComponentPropertiesNonNullOnly(boolean autowireComponentPropertiesNonNullOnly) Whether to only autowire if the property has no default value or has not been configured explicit.
void	setDurationHitExitCode(int durationHitExitCode) Sets the exit code for the application if duration was hit
void	setHangupInterceptorEnabled(boolean hangupInterceptorEnabled) Whether to use graceful hangup when Camel is stopping or when the JVM terminates.
void	setPackageScanRouteBuilders(String packageScanRouteBuilders) Sets package names for scanning for RouteBuilder classes as candidates to be included.
MainConfigurationProperties	withAutoConfigurationEnabled(boolean autoConfigurationEnabled) Whether auto configuration of components/dataformats/languages is enabled or not.
MainConfigurationProperties	withAutoConfigurationEnvironmentVariablesEnabled(boolean autoConfigurationEnvironmentVariablesEnabled) Whether auto configuration should include OS environment variables as well.
MainConfigurationProperties	withAutoConfigurationFailFast(boolean autoConfigurationFailFast) Whether auto configuration should fail fast when configuring one ore more properties fails for whatever reason such as a invalid property name, etc.
MainConfigurationProperties	withAutoConfigurationLogSummary(boolean autoConfigurationLogSummary) Whether auto configuration should log a summary with the configured properties.
MainConfigurationProperties	withAutowireComponentProperties(boolean autowireComponentProperties) Whether autowiring components with properties that are of same type, which has been added to the Camel registry, as a singleton instance.
MainConfigurationProperties	withAutowireComponentPropertiesAllowPrivateSetter(boolean autowireComponentPropertiesAllowPrivateSetter) Whether autowiring components (with deep nesting by attempting to walk as deep down the object graph by creating new empty objects on the way if needed) with properties that are of same type, which has been added to the Camel registry, as a singleton instance.
MainConfigurationProperties	withAutowireComponentPropertiesDeep(boolean autowireComponentPropertiesDeep) Whether autowiring components (with deep nesting by attempting to walk as deep down the object graph by creating new empty objects on the way if needed) with properties that are of same type, which has been added to the Camel registry, as a singleton instance.
MainConfigurationProperties	withAutowireComponentPropertiesNonNullOnly(boolean autowireComponentPropertiesNonNullOnly) Whether to only autowire if the property has no default value or has not been configured explicit.
MainConfigurationProperties	withDurationHitExitCode(int durationHitExitCode) Sets the exit code for the application if duration was hit
MainConfigurationProperties	withHangupInterceptorEnabled(boolean hangupInterceptorEnabled) Whether to use graceful hangup when Camel is stopping or when the JVM terminates.
MainConfigurationProperties	withPackageScanRouteBuilders(String packageScanRouteBuilders) Sets package names for scanning for RouteBuilder classes as candidates to be included.

Methods inherited from class org.apache.camel.main.DefaultConfigurationProperties

getBeanIntrospectionLoggingLevel, getConsumerTemplateCacheSize, getDurationMaxIdleSeconds, getDurationMaxMessages, getDurationMaxSeconds, getFileConfigurations, getJavaRoutesExcludePattern, getJavaRoutesIncludePattern, getJmxManagementNamePattern, getJmxManagementStatisticsLevel, getLogDebugMaxChars, getMdcLoggingKeysPattern, getName, getProducerTemplateCacheSize, getRouteFilterExcludePattern, getRouteFilterIncludePattern, getShutdownTimeout, getStreamCachingBufferSize, getStreamCachingSpoolCipher, getStreamCachingSpoolDirectory, getStreamCachingSpoolThreshold, getStreamCachingSpoolUsedHeapMemoryLimit, getStreamCachingSpoolUsedHeapMemoryThreshold, getThreadNamePattern, getTracingPattern, getXmlRests, getXmlRoutes, isAllowUseOriginalMessage, isAutoStartup, isBacklogTracing, isBeanIntrospectionExtendedStatistics, isCaseInsensitiveHeaders, isEndpointBasicPropertyBinding, isEndpointBridgeErrorHandler, isEndpointLazyStartProducer, isEndpointRuntimeStatisticsEnabled, isInflightRepositoryBrowseEnabled, isJmxEnabled, isLightweight, isLoadTypeConverters, isLogExhaustedMessageBody, isLogMask, isMessageHistory, isRoutesCollectorEnabled, isShutdownLogInflightExchangesOnTimeout, isShutdownNowOnTimeout, isShutdownRoutesInReverseOrder, isShutdownSuppressLoggingOnTimeout, isStreamCachingAnySpoolRules, isStreamCachingEnabled, isStreamCachingRemoveSpoolDirectoryWhenStopping, isStreamCachingStatisticsEnabled, isTracing, isUseBreadcrumb, isUseDataType, isUseMdcLogging, setAllowUseOriginalMessage, setAutoStartup, setBacklogTracing, setBeanIntrospectionExtendedStatistics, setBeanIntrospectionLoggingLevel, setCaseInsensitiveHeaders, setConsumerTemplateCacheSize, setDurationMaxIdleSeconds, setDurationMaxMessages, setDurationMaxSeconds, setEndpointBasicPropertyBinding, setEndpointBridgeErrorHandler, setEndpointLazyStartProducer, setEndpointRuntimeStatisticsEnabled, setFileConfigurations, setInflightRepositoryBrowseEnabled, setJavaRoutesExcludePattern, setJavaRoutesIncludePattern, setJmxEnabled, setJmxManagementNamePattern, setJmxManagementStatisticsLevel, setLightweight, setLoadTypeConverters, setLogDebugMaxChars, setLogExhaustedMessageBody, setLogMask, setMdcLoggingKeysPattern, setMessageHistory, setName, setProducerTemplateCacheSize, setRouteFilterExcludePattern, setRouteFilterIncludePattern, setRoutesCollectorEnabled, setShutdownLogInflightExchangesOnTimeout, setShutdownNowOnTimeout, setShutdownRoutesInReverseOrder, setShutdownSuppressLoggingOnTimeout, setShutdownTimeout, setStreamCachingAnySpoolRules, setStreamCachingBufferSize, setStreamCachingEnabled, setStreamCachingRemoveSpoolDirectoryWhenStopping, setStreamCachingSpoolCipher, setStreamCachingSpoolDirectory, setStreamCachingSpoolThreshold, setStreamCachingSpoolUsedHeapMemoryLimit, setStreamCachingSpoolUsedHeapMemoryThreshold, setStreamCachingStatisticsEnabled, setThreadNamePattern, setTracing, setTracingPattern, setUseBreadcrumb, setUseDataType, setUseMdcLogging, setXmlRests, setXmlRoutes, withAllowUseOriginalMessage, withAutoStartup, withBacklogTracing, withBeanIntrospectionExtendedStatistics, withBeanIntrospectionLoggingLevel, withCaseInsensitiveHeaders, withConsumerTemplateCacheSize, withDurationMaxIdleSeconds, withDurationMaxMessages, withDurationMaxSeconds, withEndpointBasicPropertyBinding, withEndpointBridgeErrorHandler, withEndpointLazyStartProducer, withEndpointRuntimeStatisticsEnabled, withFileConfigurations, withInflightRepositoryBrowseEnabled, withJavaRoutesExcludePattern, withJavaRoutesIncludePattern, withJmxEnabled, withJmxManagementNamePattern, withJmxManagementStatisticsLevel, withLightweight, withLoadTypeConverters, withLogDebugMaxChars, withLogExhaustedMessageBody, withLogMask, withMdcLoggingKeysPattern, withMessageHistory, withName, withProducerTemplateCacheSize, withRouteFilterExcludePattern, withRouteFilterIncludePattern, withRoutesCollectorEnabled, withShutdownLogInflightExchangesOnTimeout, withShutdownNowOnTimeout, withShutdownRoutesInReverseOrder, withShutdownSuppressLoggingOnTimeout, withShutdownTimeout, withStreamCachingAnySpoolRules, withStreamCachingBufferSize, withStreamCachingEnabled, withStreamCachingRemoveSpoolDirectoryWhenStopping, withStreamCachingSpoolCipher, withStreamCachingSpoolDirectory, withStreamCachingSpoolThreshold, withStreamCachingSpoolUsedHeapMemoryLimit, withStreamCachingSpoolUsedHeapMemoryThreshold, withStreamCachingStatisticsEnabled, withThreadNamePattern, withTracing, withTracingPattern, withUseBreadcrumb, withUseDataType, withUseMdcLogging, withXmlRests, withXmlRoutes

Methods inherited from class java.lang.Object

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

Constructor Detail

MainConfigurationProperties

public MainConfigurationProperties()

Method Detail

hystrix

public HystrixConfigurationProperties hystrix()

To configure Circuit Breaker EIP with Hystrix

resilience4j

public Resilience4jConfigurationProperties resilience4j()

To configure Circuit Breaker EIP with Resilience4j

rest

public RestConfigurationProperties rest()

To configure Rest DSL

isAutoConfigurationEnabled

public boolean isAutoConfigurationEnabled()

setAutoConfigurationEnabled

public void setAutoConfigurationEnabled(boolean autoConfigurationEnabled)

Whether auto configuration of components, dataformats, languages is enabled or not. When enabled the configuration parameters are loaded from the properties component and optionally from the classpath file META-INF/services/org/apache/camel/autowire.properties. You can prefix the parameters in the properties file with: - camel.component.name.option1=value1 - camel.component.name.option2=value2 - camel.dataformat.name.option1=value1 - camel.dataformat.name.option2=value2 - camel.language.name.option1=value1 - camel.language.name.option2=value2 Where name is the name of the component, dataformat or language such as seda,direct,jaxb.

The auto configuration also works for any options on components that is a complex type (not standard Java type) and there has been an explicit single bean instance registered to the Camel registry via the Registry.bind(String, Object) method or by using the BindToRegistry annotation style.

This option is default enabled.

isAutoConfigurationEnvironmentVariablesEnabled

public boolean isAutoConfigurationEnvironmentVariablesEnabled()

setAutoConfigurationEnvironmentVariablesEnabled

public void setAutoConfigurationEnvironmentVariablesEnabled(boolean autoConfigurationEnvironmentVariablesEnabled)

Whether auto configuration should include OS environment variables as well. When enabled this allows to overrule any configuration using an OS environment variable. For example to set a shutdown timeout of 5 seconds: CAMEL_MAIN_SHUTDOWNTIMEOUT=5.

This option is default enabled.

isAutoConfigurationFailFast

public boolean isAutoConfigurationFailFast()

setAutoConfigurationFailFast

public void setAutoConfigurationFailFast(boolean autoConfigurationFailFast)

Whether auto configuration should fail fast when configuring one ore more properties fails for whatever reason such as a invalid property name, etc.

This option is default enabled.

isAutoConfigurationLogSummary

public boolean isAutoConfigurationLogSummary()

setAutoConfigurationLogSummary

public void setAutoConfigurationLogSummary(boolean autoConfigurationLogSummary)

Whether auto configuration should log a summary with the configured properties.

This option is default enabled.

isAutowireComponentProperties

public boolean isAutowireComponentProperties()

setAutowireComponentProperties

public void setAutowireComponentProperties(boolean autowireComponentProperties)

Whether autowiring components with properties that are of same type, which has been added to the Camel registry, as a singleton instance. This is used for convention over configuration to inject DataSource, AmazonLogin instances to the components.

This option is default enabled.

isAutowireComponentPropertiesDeep

public boolean isAutowireComponentPropertiesDeep()

setAutowireComponentPropertiesDeep

public void setAutowireComponentPropertiesDeep(boolean autowireComponentPropertiesDeep)

Whether autowiring components (with deep nesting by attempting to walk as deep down the object graph by creating new empty objects on the way if needed) with properties that are of same type, which has been added to the Camel registry, as a singleton instance. This is used for convention over configuration to inject DataSource, AmazonLogin instances to the components.

This option is default disabled.

isAutowireComponentPropertiesNonNullOnly

public boolean isAutowireComponentPropertiesNonNullOnly()

setAutowireComponentPropertiesNonNullOnly

public void setAutowireComponentPropertiesNonNullOnly(boolean autowireComponentPropertiesNonNullOnly)

Whether to only autowire if the property has no default value or has not been configured explicit.

This option is default disabled.

isAutowireComponentPropertiesAllowPrivateSetter

public boolean isAutowireComponentPropertiesAllowPrivateSetter()

setAutowireComponentPropertiesAllowPrivateSetter

public void setAutowireComponentPropertiesAllowPrivateSetter(boolean autowireComponentPropertiesAllowPrivateSetter)

Whether autowiring components allows to use private setter method when setting the value. This may be needed in some rare situations when some configuration classes may configure via constructors over setters. But constructor configuration is more cumbersome to use via .properties files etc.

isHangupInterceptorEnabled

public boolean isHangupInterceptorEnabled()

setHangupInterceptorEnabled

public void setHangupInterceptorEnabled(boolean hangupInterceptorEnabled)

Whether to use graceful hangup when Camel is stopping or when the JVM terminates.

getPackageScanRouteBuilders

public String getPackageScanRouteBuilders()

setPackageScanRouteBuilders

public void setPackageScanRouteBuilders(String packageScanRouteBuilders)

Sets package names for scanning for RouteBuilder classes as candidates to be included. If you are using Spring Boot then its instead recommended to use Spring Boots component scanning and annotate your route builder classes with `@Component`. In other words only use this for Camel Main in standalone mode.

getDurationHitExitCode

public int getDurationHitExitCode()

setDurationHitExitCode

public void setDurationHitExitCode(int durationHitExitCode)

Sets the exit code for the application if duration was hit

withAutoConfigurationEnabled

public MainConfigurationProperties withAutoConfigurationEnabled(boolean autoConfigurationEnabled)

Whether auto configuration of components/dataformats/languages is enabled or not. When enabled the configuration parameters are loaded from the properties component and configured as defaults (similar to spring-boot auto-configuration). You can prefix the parameters in the properties file with: - camel.component.name.option1=value1 - camel.component.name.option2=value2 - camel.dataformat.name.option1=value1 - camel.dataformat.name.option2=value2 - camel.language.name.option1=value1 - camel.language.name.option2=value2 Where name is the name of the component, dataformat or language such as seda,direct,jaxb.

The auto configuration also works for any options on components that is a complex type (not standard Java type) and there has been an explicit single bean instance registered to the Camel registry via the Registry.bind(String, Object) method or by using the BindToRegistry annotation style.

This option is default enabled.

withAutoConfigurationEnvironmentVariablesEnabled

public MainConfigurationProperties withAutoConfigurationEnvironmentVariablesEnabled(boolean autoConfigurationEnvironmentVariablesEnabled)

Whether auto configuration should include OS environment variables as well. When enabled this allows to overrule any configuration using an OS environment variable. For example to set a shutdown timeout of 5 seconds: CAMEL_MAIN_SHUTDOWNTIMEOUT=5.

This option is default enabled.

withAutoConfigurationFailFast

public MainConfigurationProperties withAutoConfigurationFailFast(boolean autoConfigurationFailFast)

Whether auto configuration should fail fast when configuring one ore more properties fails for whatever reason such as a invalid property name, etc.

This option is default enabled.

withAutoConfigurationLogSummary

public MainConfigurationProperties withAutoConfigurationLogSummary(boolean autoConfigurationLogSummary)

Whether auto configuration should log a summary with the configured properties.

This option is default enabled.

withAutowireComponentProperties

public MainConfigurationProperties withAutowireComponentProperties(boolean autowireComponentProperties)

Whether autowiring components with properties that are of same type, which has been added to the Camel registry, as a singleton instance. This is used for convention over configuration to inject DataSource, AmazonLogin instances to the components.

This option is default enabled.

withAutowireComponentPropertiesDeep

public MainConfigurationProperties withAutowireComponentPropertiesDeep(boolean autowireComponentPropertiesDeep)

Whether autowiring components (with deep nesting by attempting to walk as deep down the object graph by creating new empty objects on the way if needed) with properties that are of same type, which has been added to the Camel registry, as a singleton instance. This is used for convention over configuration to inject DataSource, AmazonLogin instances to the components.

This option is default disabled.

withAutowireComponentPropertiesNonNullOnly

public MainConfigurationProperties withAutowireComponentPropertiesNonNullOnly(boolean autowireComponentPropertiesNonNullOnly)

Whether to only autowire if the property has no default value or has not been configured explicit.

This option is default disabled.

withAutowireComponentPropertiesAllowPrivateSetter

public MainConfigurationProperties withAutowireComponentPropertiesAllowPrivateSetter(boolean autowireComponentPropertiesAllowPrivateSetter)

Whether autowiring components (with deep nesting by attempting to walk as deep down the object graph by creating new empty objects on the way if needed) with properties that are of same type, which has been added to the Camel registry, as a singleton instance. This is used for convention over configuration to inject DataSource, AmazonLogin instances to the components.

This option is default enabled.

withHangupInterceptorEnabled

public MainConfigurationProperties withHangupInterceptorEnabled(boolean hangupInterceptorEnabled)

Whether to use graceful hangup when Camel is stopping or when the JVM terminates.

withDurationHitExitCode

public MainConfigurationProperties withDurationHitExitCode(int durationHitExitCode)

Sets the exit code for the application if duration was hit

withPackageScanRouteBuilders

public MainConfigurationProperties withPackageScanRouteBuilders(String packageScanRouteBuilders)

Sets package names for scanning for RouteBuilder classes as candidates to be included. If you are using Spring Boot then its instead recommended to use Spring Boots component scanning and annotate your route builder classes with `@Component`. In other words only use this for Camel Main in standalone mode.