org.apache.camel.main

Class MainSupport

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.main.BaseMainSupport

org.apache.camel.main.MainSupport

Direct Known Subclasses:

MainCommandLineSupport

public abstract class MainSupport
extends BaseMainSupport

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

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.camel.ProducerTemplate	camelTemplate
protected static int	DEFAULT_EXIT_CODE
protected AtomicInteger	exitCode
protected static org.slf4j.Logger	LOG
protected MainShutdownStrategy	shutdownStrategy
protected static int	UNINITIALIZED_EXIT_CODE

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

camelContext, DEFAULT_PROPERTY_PLACEHOLDER_LOCATION, defaultPropertyPlaceholderLocation, INITIAL_PROPERTIES_LOCATION, initialProperties, listeners, mainConfigurationProperties, OVERRIDE_PROPERTIES_LOCATION, overrideProperties, PROPERTY_PLACEHOLDER_LOCATION, 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

Modifier	Constructor and Description
protected	MainSupport()
protected	MainSupport(Class<?>... configurationClasses)

Method Summary

Modifier and Type	Method and Description
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	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.
protected void	configureLifecycle(org.apache.camel.CamelContext camelContext)
protected abstract org.apache.camel.CamelContext	createCamelContext()
protected void	doStart()
protected void	doStop()
void	enableTrace()
void	enableTraceStandby()
protected abstract org.apache.camel.ProducerTemplate	findOrCreateCamelTemplate()
org.apache.camel.ProducerTemplate	getCamelTemplate()
Runnable	getCompleteTask() Gets the complete task which allows to trigger this on demand.
int	getDuration() Deprecated.
int	getDurationHitExitCode() Deprecated.
int	getDurationIdle() Deprecated.
int	getDurationMaxMessages() Deprecated.
int	getExitCode()
MainShutdownStrategy	getShutdownStrategy()
protected void	initCamelContext()
boolean	isTrace()
void	run() Runs this process with the given arguments, and will wait until completed, or the JVM terminates.
void	setDuration(int duration) Deprecated. use BaseMainSupport.configure()
void	setDurationHitExitCode(int durationHitExitCode) Deprecated. use BaseMainSupport.configure()
void	setDurationIdle(int durationIdle) Deprecated. use BaseMainSupport.configure()
void	setDurationMaxMessages(int durationMaxMessages) Deprecated. use BaseMainSupport.configure()
void	setShutdownStrategy(MainShutdownStrategy shutdownStrategy) Set the MainShutdownStrategy used to properly shut-down the main instance.
protected void	waitUntilCompleted()

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

addInitialProperty, addMainListener, addOverrideProperty, addProperty, autoConfigurationFailFast, autoConfigurationFromProperties, autoConfigurationMainConfiguration, autoConfigurationPropertiesComponent, autoconfigure, autowireWildcardProperties, configure, configurePropertiesService, configureRoutes, configureStartupRecorder, doAutowireWildcardProperties, doConfigureCamelContextFromMainConfiguration, getCamelContext, getDefaultPropertyPlaceholderLocation, getInitialProperties, getOverrideProperties, getPropertyPlaceholderLocations, getRoutesCollector, isAutoConfigurationEnabled, loadConfigurations, postProcessCamelContext, removeMainListener, setAutoConfigurationEnabled, setDefaultPropertyPlaceholderLocation, setInitialProperties, setInitialProperties, setOverrideProperties, setOverrideProperties, setPropertyPlaceholderLocations, setRoutesCollector

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

build, doBuild, doFail, doInit, doLifecycleChange, doResume, doShutdown, 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

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

exitCode

protected final AtomicInteger exitCode

shutdownStrategy

protected MainShutdownStrategy shutdownStrategy

camelTemplate

protected volatile org.apache.camel.ProducerTemplate camelTemplate

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

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.

getCompleteTask

public Runnable getCompleteTask()

Gets the complete task which allows to trigger this on demand.

getDuration

@Deprecated
public int getDuration()

Deprecated.

setDuration

@Deprecated
public void setDuration(int duration)

Deprecated. use BaseMainSupport.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 BaseMainSupport.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 BaseMainSupport.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 BaseMainSupport.configure()

Sets the exit code for the application if duration was hit

getDurationHitExitCode

@Deprecated
public int getDurationHitExitCode()

Deprecated.

getExitCode

public int getExitCode()

isTrace

public boolean isTrace()

enableTrace

public void enableTrace()

enableTraceStandby

public void enableTraceStandby()

getShutdownStrategy

public MainShutdownStrategy getShutdownStrategy()

setShutdownStrategy

public void setShutdownStrategy(MainShutdownStrategy shutdownStrategy)

Set the MainShutdownStrategy used to properly shut-down the main instance. By default a DefaultMainShutdownStrategy will be used.

Parameters:

shutdownStrategy - the shutdown strategy

doStop

protected void doStop()
               throws Exception

Overrides:

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

Throws:

Exception

doStart

protected void doStart()
                throws Exception

Overrides:

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

Throws:

Exception

configureLifecycle

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

Overrides:

configureLifecycle in class BaseMainSupport

Throws:

Exception

waitUntilCompleted

protected void waitUntilCompleted()

findOrCreateCamelTemplate

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

createCamelContext

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

getCamelTemplate

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

Throws:

Exception

initCamelContext

protected void initCamelContext()
                         throws Exception

Throws:

Exception