org.apache.camel.main

Class BaseMainSupport

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.main.BaseMainSupport

Direct Known Subclasses:

MainSupport

public abstract class BaseMainSupport
extends org.apache.camel.support.service.BaseService

Base class for main implementations to allow bootstrapping Camel in standalone mode.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.camel.CamelContext	camelContext
protected org.apache.camel.ProducerTemplate	camelTemplate
static String	DEFAULT_PROPERTY_PLACEHOLDER_LOCATION
protected String	defaultPropertyPlaceholderLocation
static String	INITIAL_PROPERTIES_LOCATION
protected Properties	initialProperties
protected List<MainListener>	listeners
protected MainConfigurationProperties	mainConfigurationProperties
static String	OVERRIDE_PROPERTIES_LOCATION
protected Properties	overrideProperties
static String	PROPERTY_PLACEHOLDER_LOCATION
protected String	propertyPlaceholderLocations
protected RoutesCollector	routesCollector
protected Properties	wildcardProperties

Fields inherited from class org.apache.camel.support.service.BaseService

BUILDED, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTINGDOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor and Description
BaseMainSupport()

Method Summary

Modifier and Type	Method and Description
void	addInitialProperty(String key, String value) Adds a initial property for the properties component, which will be used before any locations are resolved.
void	addMainListener(MainListener listener) Adds a MainListener to receive callbacks when the main is started or stopping
void	addOverrideProperty(String key, String value) Adds an override property that take precedence and will use first, if a property exist.
void	addProperty(String key, String value) Adds a property (initial) for the properties component, which will be used before any locations are resolved.
protected void	autoConfigurationFailFast(org.apache.camel.CamelContext camelContext, Map<String,String> autoConfiguredProperties)
protected void	autoConfigurationFromProperties(org.apache.camel.CamelContext camelContext, Map<String,String> autoConfiguredProperties)
protected void	autoConfigurationMainConfiguration(org.apache.camel.CamelContext camelContext, MainConfigurationProperties config, Map<String,String> autoConfiguredProperties)
protected void	autoConfigurationPropertiesComponent(org.apache.camel.CamelContext camelContext, Map<String,String> autoConfiguredProperties)
protected void	autoconfigure(org.apache.camel.CamelContext camelContext)
protected void	autowireConfigurationFromRegistry(org.apache.camel.CamelContext camelContext, boolean bindNullOnly, boolean deepNesting)
protected void	autowireWildcardProperties(org.apache.camel.CamelContext camelContext)
protected static void	computeProperties(String keyPrefix, String key, Properties prop, Map<org.apache.camel.main.BaseMainSupport.PropertyOptionKey,Map<String,Object>> properties, Function<String,Iterable<Object>> supplier)
MainConfigurationProperties	configure() To configure options on Camel Main.
protected void	configureLifecycle(org.apache.camel.CamelContext camelContext)
protected void	configurePropertiesService(org.apache.camel.CamelContext camelContext)
protected void	configureRoutes(org.apache.camel.CamelContext camelContext)
protected abstract org.apache.camel.CamelContext	createCamelContext()
protected void	doAutowireWildcardProperties(String name, org.apache.camel.Component component)
protected void	doConfigureCamelContextFromMainConfiguration(org.apache.camel.CamelContext camelContext, MainConfigurationProperties config, Map<String,String> autoConfiguredProperties) Configures CamelContext from the MainConfigurationProperties properties.
protected abstract org.apache.camel.ProducerTemplate	findOrCreateCamelTemplate()
org.apache.camel.CamelContext	getCamelContext()
org.apache.camel.ProducerTemplate	getCamelTemplate()
String	getDefaultPropertyPlaceholderLocation()
Properties	getInitialProperties()
Properties	getOverrideProperties()
String	getPropertyPlaceholderLocations()
List<org.apache.camel.model.RouteDefinition>	getRouteDefinitions()
RoutesCollector	getRoutesCollector()
protected void	initCamelContext()
boolean	isAutoConfigurationEnabled() Deprecated.
protected static boolean	isServiceEnabled(String prefix, String name, Properties properties)
protected void	loadConfigurations(org.apache.camel.CamelContext camelContext)
protected void	loadRouteBuilders(org.apache.camel.CamelContext camelContext)
protected static String	optionKey(String key)
protected void	postProcessCamelContext(org.apache.camel.CamelContext camelContext)
void	removeMainListener(MainListener listener) Removes the MainListener
void	setAutoConfigurationEnabled(boolean autoConfigurationEnabled) Deprecated. use configure()
void	setDefaultPropertyPlaceholderLocation(String defaultPropertyPlaceholderLocation) Set the default location for application properties if no locations have been set.
void	setInitialProperties(Properties initialProperties) Sets initial properties for the properties component, which will be used before any locations are resolved.
void	setOverrideProperties(Properties overrideProperties) Sets a special list of override properties that take precedence and will use first, if a property exist.
protected static boolean	setPropertiesOnTarget(org.apache.camel.CamelContext context, Object target, Map<String,Object> properties, String optionPrefix, boolean failIfNotSet, boolean ignoreCase, Map<String,String> autoConfiguredProperties)
void	setPropertyPlaceholderLocations(String location) A list of locations to add for loading properties.
void	setRoutesCollector(RoutesCollector routesCollector) To use a custom RoutesCollector.
protected static void	validateOptionAndValue(String key, String option, String value)

Methods inherited from class org.apache.camel.support.service.BaseService

build, doBuild, doFail, doInit, doLifecycleChange, doResume, doShutdown, doStart, doStop, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROPERTY_PLACEHOLDER_LOCATION

public static final String DEFAULT_PROPERTY_PLACEHOLDER_LOCATION

See Also:

Constant Field Values

INITIAL_PROPERTIES_LOCATION

public static final String INITIAL_PROPERTIES_LOCATION

See Also:

Constant Field Values

OVERRIDE_PROPERTIES_LOCATION

public static final String OVERRIDE_PROPERTIES_LOCATION

See Also:

Constant Field Values

PROPERTY_PLACEHOLDER_LOCATION

public static final String PROPERTY_PLACEHOLDER_LOCATION

See Also:

Constant Field Values

camelContext

protected volatile org.apache.camel.CamelContext camelContext

camelTemplate

protected volatile org.apache.camel.ProducerTemplate camelTemplate

listeners

protected final List<MainListener> listeners

mainConfigurationProperties

protected final MainConfigurationProperties mainConfigurationProperties

wildcardProperties

protected final Properties wildcardProperties

routesCollector

protected RoutesCollector routesCollector

propertyPlaceholderLocations

protected String propertyPlaceholderLocations

defaultPropertyPlaceholderLocation

protected String defaultPropertyPlaceholderLocation

initialProperties

protected Properties initialProperties

overrideProperties

protected Properties overrideProperties

Constructor Detail

BaseMainSupport

public BaseMainSupport()

Method Detail

optionKey

protected static String optionKey(String key)

setPropertiesOnTarget

protected static boolean setPropertiesOnTarget(org.apache.camel.CamelContext context,
                                               Object target,
                                               Map<String,Object> properties,
                                               String optionPrefix,
                                               boolean failIfNotSet,
                                               boolean ignoreCase,
                                               Map<String,String> autoConfiguredProperties)
                                        throws Exception

Throws:

Exception

configure

public MainConfigurationProperties configure()

To configure options on Camel Main.

getRoutesCollector

public RoutesCollector getRoutesCollector()

setRoutesCollector

public void setRoutesCollector(RoutesCollector routesCollector)

To use a custom RoutesCollector.

getPropertyPlaceholderLocations

public String getPropertyPlaceholderLocations()

setPropertyPlaceholderLocations

public void setPropertyPlaceholderLocations(String location)

A list of locations to add for loading properties. You can use comma to separate multiple locations.

getDefaultPropertyPlaceholderLocation

public String getDefaultPropertyPlaceholderLocation()

setDefaultPropertyPlaceholderLocation

public void setDefaultPropertyPlaceholderLocation(String defaultPropertyPlaceholderLocation)

Set the default location for application properties if no locations have been set. If the value is set to "false" or empty, the default location is not taken into account.

Default value is "classpath:application.properties;optional=true".

isAutoConfigurationEnabled

@Deprecated
public boolean isAutoConfigurationEnabled()

Deprecated.

setAutoConfigurationEnabled

@Deprecated
public void setAutoConfigurationEnabled(boolean autoConfigurationEnabled)

Deprecated. use configure()

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.

getInitialProperties

public Properties getInitialProperties()

setInitialProperties

public void setInitialProperties(Properties initialProperties)

Sets initial properties for the properties component, which will be used before any locations are resolved.

addProperty

public void addProperty(String key,
                        String value)

Adds a property (initial) for the properties component, which will be used before any locations are resolved.

Parameters:

key - the property key

value - the property value

See Also:

addInitialProperty(String, String), addOverrideProperty(String, String)

addInitialProperty

public void addInitialProperty(String key,
                               String value)

Adds a initial property for the properties component, which will be used before any locations are resolved.

Parameters:

key - the property key

value - the property value

getOverrideProperties

public Properties getOverrideProperties()

setOverrideProperties

public void setOverrideProperties(Properties overrideProperties)

Sets a special list of override properties that take precedence and will use first, if a property exist.

addOverrideProperty

public void addOverrideProperty(String key,
                                String value)

Adds an override property that take precedence and will use first, if a property exist.

Parameters:

key - the property key

value - the property value

getCamelContext

public org.apache.camel.CamelContext getCamelContext()

addMainListener

public void addMainListener(MainListener listener)

Adds a MainListener to receive callbacks when the main is started or stopping

Parameters:

listener - the listener

removeMainListener

public void removeMainListener(MainListener listener)

Removes the MainListener

Parameters:

listener - the listener

getRouteDefinitions

public List<org.apache.camel.model.RouteDefinition> getRouteDefinitions()

getCamelTemplate

public org.apache.camel.ProducerTemplate getCamelTemplate()
                                                   throws Exception

Throws:

Exception

findOrCreateCamelTemplate

protected abstract org.apache.camel.ProducerTemplate findOrCreateCamelTemplate()

createCamelContext

protected abstract org.apache.camel.CamelContext createCamelContext()

initCamelContext

protected void initCamelContext()
                         throws Exception

Throws:

Exception

loadRouteBuilders

protected void loadRouteBuilders(org.apache.camel.CamelContext camelContext)
                          throws Exception

Throws:

Exception

loadConfigurations

protected void loadConfigurations(org.apache.camel.CamelContext camelContext)
                           throws Exception

Throws:

Exception

configurePropertiesService

protected void configurePropertiesService(org.apache.camel.CamelContext camelContext)
                                   throws Exception

Throws:

Exception

configureLifecycle

protected void configureLifecycle(org.apache.camel.CamelContext camelContext)
                           throws Exception

Throws:

Exception

autoconfigure

protected void autoconfigure(org.apache.camel.CamelContext camelContext)
                      throws Exception

Throws:

Exception

configureRoutes

protected void configureRoutes(org.apache.camel.CamelContext camelContext)
                        throws Exception

Throws:

Exception

postProcessCamelContext

protected void postProcessCamelContext(org.apache.camel.CamelContext camelContext)
                                throws Exception

Throws:

Exception

autoConfigurationFailFast

protected void autoConfigurationFailFast(org.apache.camel.CamelContext camelContext,
                                         Map<String,String> autoConfiguredProperties)
                                  throws Exception

Throws:

Exception

doConfigureCamelContextFromMainConfiguration

protected void doConfigureCamelContextFromMainConfiguration(org.apache.camel.CamelContext camelContext,
                                                            MainConfigurationProperties config,
                                                            Map<String,String> autoConfiguredProperties)
                                                     throws Exception

Configures CamelContext from the MainConfigurationProperties properties.

Throws:

Exception

autoConfigurationPropertiesComponent

protected void autoConfigurationPropertiesComponent(org.apache.camel.CamelContext camelContext,
                                                    Map<String,String> autoConfiguredProperties)
                                             throws Exception

Throws:

Exception

autoConfigurationMainConfiguration

protected void autoConfigurationMainConfiguration(org.apache.camel.CamelContext camelContext,
                                                  MainConfigurationProperties config,
                                                  Map<String,String> autoConfiguredProperties)
                                           throws Exception

Throws:

Exception

autoConfigurationFromProperties

protected void autoConfigurationFromProperties(org.apache.camel.CamelContext camelContext,
                                               Map<String,String> autoConfiguredProperties)
                                        throws Exception

Throws:

Exception

autowireConfigurationFromRegistry

protected void autowireConfigurationFromRegistry(org.apache.camel.CamelContext camelContext,
                                                 boolean bindNullOnly,
                                                 boolean deepNesting)
                                          throws Exception

Throws:

Exception

autowireWildcardProperties

protected void autowireWildcardProperties(org.apache.camel.CamelContext camelContext)

doAutowireWildcardProperties

protected void doAutowireWildcardProperties(String name,
                                            org.apache.camel.Component component)

validateOptionAndValue

protected static void validateOptionAndValue(String key,
                                             String option,
                                             String value)

computeProperties

protected static void computeProperties(String keyPrefix,
                                        String key,
                                        Properties prop,
                                        Map<org.apache.camel.main.BaseMainSupport.PropertyOptionKey,Map<String,Object>> properties,
                                        Function<String,Iterable<Object>> supplier)

isServiceEnabled

protected static boolean isServiceEnabled(String prefix,
                                          String name,
                                          Properties properties)