org.apache.camel.main

Class MainSupport

java.lang.Object

org.apache.camel.support.service.ServiceSupport

org.apache.camel.main.MainSupport

All Implemented Interfaces:

org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

Direct Known Subclasses:

Main

public abstract class MainSupport
extends org.apache.camel.support.service.ServiceSupport

Base class for main implementations to allow starting up a JVM with Camel embedded.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MainSupport.Option
class	MainSupport.ParameterOption

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.camel.CamelContext	camelContext
protected org.apache.camel.ProducerTemplate	camelTemplate
protected AtomicBoolean	completed
protected String	configurationClasses
protected List<Object>	configurations
protected static int	DEFAULT_EXIT_CODE
protected AtomicInteger	exitCode
protected Properties	initialProperties
protected CountDownLatch	latch
protected List<MainListener>	listeners
protected static org.slf4j.Logger	LOG
protected MainConfigurationProperties	mainConfigurationProperties
protected List<MainSupport.Option>	options
protected Properties	overrideProperties
protected String	propertyPlaceholderLocations
protected String	routeBuilderClasses
protected List<org.apache.camel.builder.RouteBuilder>	routeBuilders
protected static int	UNINITIALIZED_EXIT_CODE

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

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MainSupport()
protected	MainSupport(Class... configurationClasses)

Method Summary

Modifier and Type	Method and Description
void	addConfiguration(Object configuration)
void	addConfigurationClass(Class... configuration)
void	addMainListener(MainListener listener) Adds a MainListener to receive callbacks when the main is started or stopping
void	addOption(MainSupport.Option option)
void	addRouteBuilder(Class... routeBuilder)
void	addRouteBuilder(org.apache.camel.builder.RouteBuilder routeBuilder)
protected void	afterStart() Callback to run custom logic after CamelContext has been started.
protected void	afterStop() Callback to run custom logic after CamelContext has been stopped.
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	autowireConfigurationFromRegistry(org.apache.camel.CamelContext camelContext, boolean deepNesting)
protected void	beforeStart() Callback to run custom logic before CamelContext is being started.
protected void	beforeStop() Callback to run custom logic before CamelContext is being stopped.
void	completed() Marks this process as being completed.
MainConfigurationProperties	configure() To configure options on Camel Main.
protected abstract org.apache.camel.CamelContext	createCamelContext()
void	disableHangupSupport() Disable the hangup support.
protected void	doConfigureCamelContextFromMainConfiguration(org.apache.camel.CamelContext camelContext, MainConfigurationProperties config, Map<String,String> autoConfiguredProperties) Configures CamelContext from the MainConfigurationProperties properties.
protected void	doStart()
protected void	doStop()
void	enableHangupSupport() Hangup support is enabled by default.
void	enableTrace()
protected abstract org.apache.camel.ProducerTemplate	findOrCreateCamelTemplate()
org.apache.camel.CamelContext	getCamelContext()
org.apache.camel.ProducerTemplate	getCamelTemplate()
String	getConfigurationClasses()
List<Object>	getConfigurations()
int	getDuration() Deprecated.
int	getDurationHitExitCode() Deprecated.
int	getDurationIdle() Deprecated.
int	getDurationMaxMessages() Deprecated.
int	getExitCode()
Properties	getInitialProperties()
Properties	getOverrideProperties()
String	getPropertyPlaceholderLocations()
String	getRouteBuilderClasses()
List<org.apache.camel.builder.RouteBuilder>	getRouteBuilders()
List<org.apache.camel.model.RouteDefinition>	getRouteDefinitions()
protected void	initCamelContext()
boolean	isAutoConfigurationEnabled() Deprecated.
boolean	isTrace()
protected void	loadConfigurations(org.apache.camel.CamelContext camelContext)
protected static Properties	loadEnvironmentVariablesAsProperties(String[] prefixes)
protected void	loadRouteBuilders(org.apache.camel.CamelContext camelContext)
void	parseArguments(String[] arguments) Parses the command line arguments.
protected void	postProcessCamelContext(org.apache.camel.CamelContext camelContext)
void	removeMainListener(MainListener listener) Removes the MainListener
void	run() Runs this process with the given arguments, and will wait until completed, or the JVM terminates.
void	run(String[] args) Parses the command line arguments then runs the program.
void	setAutoConfigurationEnabled(boolean autoConfigurationEnabled) Deprecated. use configure()
void	setConfigurationClasses(String configurations)
void	setConfigurations(List<Object> configurations)
void	setDuration(int duration) Deprecated. use configure()
void	setDurationHitExitCode(int durationHitExitCode) Deprecated. use configure()
void	setDurationIdle(int durationIdle) Deprecated. use configure()
void	setDurationMaxMessages(int durationMaxMessages) Deprecated. use configure()
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.
void	setPropertyPlaceholderLocations(String location) A list of locations to add for loading properties.
void	setRouteBuilderClasses(String builders)
void	setRouteBuilders(List<org.apache.camel.builder.RouteBuilder> routeBuilders)
void	showOptions() Displays the command line options.
void	showOptionsHeader() Displays the header message for the command line options.
protected void	validateOptionAndValue(String key, String option, String value)
protected void	waitUntilCompleted()

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

doInit, doResume, doShutdown, doSuspend, getStatus, init, 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

LOG

protected static final org.slf4j.Logger LOG

UNINITIALIZED_EXIT_CODE

protected static final int UNINITIALIZED_EXIT_CODE

See Also:

Constant Field Values

DEFAULT_EXIT_CODE

protected static final int DEFAULT_EXIT_CODE

See Also:

Constant Field Values

listeners

protected final List<MainListener> listeners

options

protected final List<MainSupport.Option> options

latch

protected final CountDownLatch latch

completed

protected final AtomicBoolean completed

exitCode

protected final AtomicInteger exitCode

camelContext

protected volatile org.apache.camel.CamelContext camelContext

camelTemplate

protected volatile org.apache.camel.ProducerTemplate camelTemplate

mainConfigurationProperties

protected final MainConfigurationProperties mainConfigurationProperties

routeBuilders

protected List<org.apache.camel.builder.RouteBuilder> routeBuilders

routeBuilderClasses

protected String routeBuilderClasses

configurations

protected List<Object> configurations

configurationClasses

protected String configurationClasses

propertyPlaceholderLocations

protected String propertyPlaceholderLocations

initialProperties

protected Properties initialProperties

overrideProperties

protected Properties overrideProperties

Constructor Detail

MainSupport

protected MainSupport(Class... configurationClasses)

MainSupport

protected MainSupport()

Method Detail

run

public void run()
         throws Exception

Runs this process with the given arguments, and will wait until completed, or the JVM terminates.

Throws:

Exception

disableHangupSupport

public void disableHangupSupport()

Disable the hangup support. No graceful stop by calling stop() on a Hangup signal.

enableHangupSupport

public void enableHangupSupport()

Hangup support is enabled by default.

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

beforeStart

protected void beforeStart()
                    throws Exception

Callback to run custom logic before CamelContext is being started.

It is recommended to use MainListener instead.

Throws:

Exception

afterStart

protected void afterStart()
                   throws Exception

Callback to run custom logic after CamelContext has been started.

It is recommended to use MainListener instead.

Throws:

Exception

beforeStop

protected void beforeStop()
                   throws Exception

Callback to run custom logic before CamelContext is being stopped.

It is recommended to use MainListener instead.

Throws:

Exception

afterStop

protected void afterStop()
                  throws Exception

Callback to run custom logic after CamelContext has been stopped.

It is recommended to use MainListener instead.

Throws:

Exception

completed

public void completed()

Marks this process as being completed.

showOptions

public void showOptions()

Displays the command line options.

parseArguments

public void parseArguments(String[] arguments)

Parses the command line arguments.

addOption

public void addOption(MainSupport.Option option)

configure

public MainConfigurationProperties configure()

To configure options on Camel Main.

getDuration

@Deprecated
public int getDuration()

Deprecated.

setDuration

@Deprecated
public void setDuration(int duration)

Deprecated. use configure()

Sets the duration (in seconds) to run the application until it should be terminated. Defaults to -1. Any value <= 0 will run forever.

getDurationIdle

@Deprecated
public int getDurationIdle()

Deprecated.

setDurationIdle

@Deprecated
public void setDurationIdle(int durationIdle)

Deprecated. use configure()

Sets the maximum idle duration (in seconds) when running the application, and if there has been no message processed after being idle for more than this duration then the application should be terminated. Defaults to -1. Any value <= 0 will run forever.

getDurationMaxMessages

@Deprecated
public int getDurationMaxMessages()

Deprecated.

setDurationMaxMessages

@Deprecated
public void setDurationMaxMessages(int durationMaxMessages)

Deprecated. use configure()

Sets the duration to run the application to process at most max messages until it should be terminated. Defaults to -1. Any value <= 0 will run forever.

setDurationHitExitCode

@Deprecated
public void setDurationHitExitCode(int durationHitExitCode)

Deprecated. use configure()

Sets the exit code for the application if duration was hit

getDurationHitExitCode

@Deprecated
public int getDurationHitExitCode()

Deprecated.

getExitCode

public int getExitCode()

getConfigurationClasses

public String getConfigurationClasses()

setConfigurationClasses

public void setConfigurationClasses(String configurations)

addConfigurationClass

public void addConfigurationClass(Class... configuration)

addConfiguration

public void addConfiguration(Object configuration)

getRouteBuilderClasses

public String getRouteBuilderClasses()

setRouteBuilderClasses

public void setRouteBuilderClasses(String builders)

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.

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.

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.

isTrace

public boolean isTrace()

enableTrace

public void enableTrace()

doStop

protected void doStop()
               throws Exception

Specified by:

doStop in class org.apache.camel.support.service.ServiceSupport

Throws:

Exception

doStart

protected void doStart()
                throws Exception

Specified by:

doStart in class org.apache.camel.support.service.ServiceSupport

Throws:

Exception

waitUntilCompleted

protected void waitUntilCompleted()

run

public void run(String[] args)
         throws Exception

Parses the command line arguments then runs the program.

Throws:

Exception

showOptionsHeader

public void showOptionsHeader()

Displays the header message for the command line options.

getCamelContext

public org.apache.camel.CamelContext getCamelContext()

getRouteBuilders

public List<org.apache.camel.builder.RouteBuilder> getRouteBuilders()

setRouteBuilders

public void setRouteBuilders(List<org.apache.camel.builder.RouteBuilder> routeBuilders)

getConfigurations

public List<Object> getConfigurations()

setConfigurations

public void setConfigurations(List<Object> configurations)

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

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 deepNesting)
                                          throws Exception

Throws:

Exception

loadEnvironmentVariablesAsProperties

protected static Properties loadEnvironmentVariablesAsProperties(String[] prefixes)

validateOptionAndValue

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

addRouteBuilder

public void addRouteBuilder(org.apache.camel.builder.RouteBuilder routeBuilder)

addRouteBuilder

public void addRouteBuilder(Class... routeBuilder)