Package org.apache.camel.main

Class MainCommandLineSupport

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.main.BaseMainSupport

org.apache.camel.main.MainSupport

org.apache.camel.main.MainCommandLineSupport

Direct Known Subclasses:

Main

public abstract class MainCommandLineSupport
extends MainSupport

Support for command line arguments to Camel main.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MainCommandLineSupport.Option
class	MainCommandLineSupport.ParameterOption

Field Summary

Fields

Modifier and Type	Field	Description
protected Properties	argumentProperties
protected final List<MainCommandLineSupport.Option>	options

Fields inherited from class org.apache.camel.main.MainSupport

camelTemplate, DEFAULT_EXIT_CODE, exitCode, LOG, shutdownStrategy, UNINITIALIZED_EXIT_CODE

Fields inherited from class org.apache.camel.main.BaseMainSupport

camelContext, defaultPropertyPlaceholderLocation, helper, initialProperties, listeners, mainConfigurationProperties, overrideProperties, propertyPlaceholderLocations, routesCollector, standalone, wildcardProperties

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

BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor	Description
MainCommandLineSupport()
MainCommandLineSupport(Class<? extends org.apache.camel.CamelConfiguration>... configurationClasses)

Method Summary

Modifier and Type	Method	Description
void	addArgumentProperty(String key, String value)	Adds a property (command line) for the properties component.
protected void	addInitialOptions()
void	addOption(MainCommandLineSupport.Option option)
protected void	configurePropertiesService(org.apache.camel.CamelContext camelContext)
Properties	getArgumentProperties()
protected void	initOptions()
void	parseArguments(String[] arguments)	Parses the command line arguments.
int	run(String[] args)	Parses the command line arguments then runs the program.
void	setArgumentProperties(Map<String,Object> initialProperties)	Sets command line argument as properties for the properties component.
void	setArgumentProperties(Properties argumentProperties)	Sets command line argument as properties for the properties component.
void	showOptions()	Displays the command line options.
void	showOptionsHeader()	Displays the header message for the command line options.

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

afterStart, afterStop, autoconfigure, beforeStart, beforeStop, completed, configureLifecycle, createCamelContext, doInit, doStart, doStop, enableTrace, enableTraceStandby, findOrCreateCamelTemplate, getAppName, getCamelTemplate, getCompleteTask, getExitCode, getShutdownStrategy, initCamelContext, internalBeforeStart, isTrace, registerMainBootstrap, run, setAppName, setShutdownStrategy, waitUntilCompleted

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

addInitialProperty, addMainListener, addOverrideProperty, addProperty, autoConfigurationFailFast, autoConfigurationFromProperties, autoConfigurationFromReloadedProperties, autoConfigurationMainConfiguration, autoConfigurationPropertiesComponent, autoConfigurationSingleOption, autoConfigurationStartupConditions, autowireWildcardProperties, configure, configureMainListener, configurePackageScan, configureRoutes, configureRoutesLoader, configureStartupRecorder, createLifecycleStrategy, detectCamelDebugJar, doAutoConfigurationFromProperties, doAutowireWildcardProperties, doConfigureCamelContextFromMainConfiguration, doConfigureVaultFromMainConfiguration, doInitFileConfigurations, getCamelContext, getDefaultPropertyPlaceholderLocation, getInitialProperties, getMainListeners, getOverrideProperties, getPropertyPlaceholderLocations, getRoutesCollector, loadConfigurations, loadCustomBeans, modelineRoutes, postProcessCamelContext, postProcessCamelRegistry, preProcessCamelRegistry, removeMainListener, setDefaultPropertyPlaceholderLocation, setInitialProperties, setInitialProperties, setOverrideProperties, setOverrideProperties, setPropertyPlaceholderLocations, setRoutesCollector

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

build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doSuspend, fail, getInternalLock, 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 Details

options

protected final List<MainCommandLineSupport.Option> options

argumentProperties

protected Properties argumentProperties

Constructor Details

MainCommandLineSupport

@SafeVarargs
public MainCommandLineSupport(Class<? extends org.apache.camel.CamelConfiguration>... configurationClasses)

MainCommandLineSupport

public MainCommandLineSupport()

Method Details

getArgumentProperties

public Properties getArgumentProperties()

setArgumentProperties

public void setArgumentProperties(Properties argumentProperties)

Sets command line argument as properties for the properties component.

setArgumentProperties

public void setArgumentProperties(Map<String,Object> initialProperties)

Sets command line argument as properties for the properties component.

addArgumentProperty

public void addArgumentProperty(String key,
 String value)

Adds a property (command line) for the properties component.

Parameters:

key - the property key

value - the property value

initOptions

protected void initOptions()

addInitialOptions

protected void addInitialOptions()

showOptions

public void showOptions()

Displays the command line options.

parseArguments

public void parseArguments(String[] arguments)

Parses the command line arguments.

addOption

public void addOption(MainCommandLineSupport.Option option)

run

public int run(String[] args)
        throws Exception

Parses the command line arguments then runs the program. The run method will keep blocking until the program is stopped.

Returns:

the exit code, usually 0 for normal termination.

Throws:

Exception

configurePropertiesService

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

Overrides:

configurePropertiesService in class BaseMainSupport

Throws:

Exception

showOptionsHeader

public void showOptionsHeader()

Displays the header message for the command line options.