MainSupport (Camel :: Core 2.22.2 API)

java.lang.Object
- org.apache.camel.support.ServiceSupport
- - org.apache.camel.main.MainSupport

All Implemented Interfaces:

Service, ShutdownableService, StatefulService, SuspendableService

Direct Known Subclasses:

Main, MainSupport
```
public abstract class MainSupport
extends ServiceSupport
```
Base class for main implementations to allow starting up a JVM with Camel embedded.

Version:

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class MainSupport.Option

class MainSupport.ParameterOption

Nested Classes
Modifier and Type	Class and Description
`class`	`MainSupport.Option`
`class`	`MainSupport.ParameterOption`

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<CamelContext>`	`camelContexts`
`protected ProducerTemplate`	`camelTemplate`
`protected AtomicBoolean`	`completed`
`protected static int`	`DEFAULT_EXIT_CODE`
`protected long`	`duration`
`protected int`	`durationHitExitCode`
`protected long`	`durationIdle`
`protected int`	`durationMaxMessages`
`protected AtomicInteger`	`exitCode`
`protected String`	`fileWatchDirectory`
`protected boolean`	`fileWatchDirectoryRecursively`
`protected boolean`	`hangupInterceptorEnabled`
`protected CountDownLatch`	`latch`
`protected List<MainListener>`	`listeners`
`protected static org.slf4j.Logger`	`LOG`
`protected List<MainSupport.Option>`	`options`
`protected ReloadStrategy`	`reloadStrategy`
`protected String`	`routeBuilderClasses`
`protected List<RouteBuilder>`	`routeBuilders`
`protected TimeUnit`	`timeUnit`
`protected boolean`	`trace`
`protected static int`	`UNINITIALIZED_EXIT_CODE`

Fields inherited from class org.apache.camel.support.ServiceSupport
shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors
Modifier Constructor and Description

protected MainSupport()

Constructors
Modifier	Constructor and Description
`protected`	`MainSupport()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addMainListener(MainListener listener)` Adds a `MainListener` to receive callbacks when the main is started or stopping
`void`	`addOption(MainSupport.Option option)`
`void`	`addRouteBuilder(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`	`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.
`void`	`disableHangupSupport()` Disable the hangup support.
`protected void`	`doStart()` Implementations override this method to support customized start/stop.
`protected void`	`doStop()` Implementations override this method to support customized start/stop.
`void`	`enableHangupSupport()` Deprecated. is enabled by default now, so no longer need to call this method.
`void`	`enableTrace()`
`protected abstract ProducerTemplate`	`findOrCreateCamelTemplate()`
`protected abstract Map<String,CamelContext>`	`getCamelContextMap()`
`List<CamelContext>`	`getCamelContexts()`
`ProducerTemplate`	`getCamelTemplate()`
`long`	`getDuration()`
`int`	`getDurationHitExitCode()`
`long`	`getDurationIdle()`
`int`	`getDurationMaxMessages()`
`int`	`getExitCode()`
`String`	`getFileWatchDirectory()`
`ModelJAXBContextFactory`	`getModelJAXBContextFactory()`
`ReloadStrategy`	`getReloadStrategy()`
`String`	`getRouteBuilderClasses()`
`List<RouteBuilder>`	`getRouteBuilders()`
`List<RouteDefinition>`	`getRouteDefinitions()`
`TimeUnit`	`getTimeUnit()`
`boolean`	`isFileWatchDirectoryRecursively()`
`boolean`	`isTrace()`
`protected void`	`loadRouteBuilders(CamelContext camelContext)`
`void`	`parseArguments(String[] arguments)` Parses the command line arguments.
`protected void`	`postProcessCamelContext(CamelContext camelContext)`
`protected void`	`postProcessContext()`
`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`	`setDuration(long duration)` Sets the duration (in seconds) to run the application until it should be terminated.
`void`	`setDurationHitExitCode(int durationHitExitCode)` Sets the exit code for the application if duration was hit
`void`	`setDurationIdle(long durationIdle)` 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.
`void`	`setDurationMaxMessages(int durationMaxMessages)` Sets the duration to run the application to process at most max messages until it should be terminated.
`void`	`setFileWatchDirectory(String fileWatchDirectory)` Sets the directory name to watch XML file changes to trigger live reload of Camel routes.
`void`	`setFileWatchDirectoryRecursively(boolean fileWatchDirectoryRecursively)` Sets the flag to watch directory of XML file changes recursively to trigger live reload of Camel routes.
`void`	`setReloadStrategy(ReloadStrategy reloadStrategy)` Sets a custom `ReloadStrategy` to be used.
`void`	`setRouteBuilderClasses(String builders)`
`void`	`setRouteBuilders(List<RouteBuilder> routeBuilders)`
`void`	`setTimeUnit(TimeUnit timeUnit)` Sets the time unit duration (seconds by default).
`void`	`showOptions()` Displays the command line options.
`void`	`showOptionsHeader()` Displays the header message for the command line options.
`protected void`	`waitUntilCompleted()`

Methods inherited from class org.apache.camel.support.ServiceSupport
doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, 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
```
  - duration
```
protected long duration
```
  - durationIdle
```
protected long durationIdle
```
  - durationMaxMessages
```
protected int durationMaxMessages
```
  - timeUnit
```
protected TimeUnit timeUnit
```
  - trace
```
protected boolean trace
```
  - routeBuilders
```
protected List<RouteBuilder> routeBuilders
```
  - routeBuilderClasses
```
protected String routeBuilderClasses
```
  - fileWatchDirectory
```
protected String fileWatchDirectory
```
  - fileWatchDirectoryRecursively
```
protected boolean fileWatchDirectoryRecursively
```
  - camelContexts
```
protected final List<CamelContext> camelContexts
```
  - camelTemplate
```
protected ProducerTemplate camelTemplate
```
  - hangupInterceptorEnabled
```
protected boolean hangupInterceptorEnabled
```
  - durationHitExitCode
```
protected int durationHitExitCode
```
  - reloadStrategy
```
protected ReloadStrategy reloadStrategy
```
- Constructor Detail
  - 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
```
@Deprecated
public void enableHangupSupport()
```
    Deprecated. is enabled by default now, so no longer need to call this method.
    
    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)
```
  - getDuration
```
public long getDuration()
```
  - setDuration
```
public void setDuration(long duration)
```
    Sets the duration (in seconds) to run the application until it should be terminated. Defaults to -1. Any value <= 0 will run forever.
  - getDurationIdle
```
public long getDurationIdle()
```
  - setDurationIdle
```
public void setDurationIdle(long durationIdle)
```
    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
```
public int getDurationMaxMessages()
```
  - setDurationMaxMessages
```
public void setDurationMaxMessages(int durationMaxMessages)
```
    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.
  - getTimeUnit
```
public TimeUnit getTimeUnit()
```
  - setTimeUnit
```
public void setTimeUnit(TimeUnit timeUnit)
```
    Sets the time unit duration (seconds by default).
  - setDurationHitExitCode
```
public void setDurationHitExitCode(int durationHitExitCode)
```
    Sets the exit code for the application if duration was hit
  - getDurationHitExitCode
```
public int getDurationHitExitCode()
```
  - getExitCode
```
public int getExitCode()
```
  - setRouteBuilderClasses
```
public void setRouteBuilderClasses(String builders)
```
  - getFileWatchDirectory
```
public String getFileWatchDirectory()
```
  - setFileWatchDirectory
```
public void setFileWatchDirectory(String fileWatchDirectory)
```
    Sets the directory name to watch XML file changes to trigger live reload of Camel routes.
    Notice you cannot set this value and a custom ReloadStrategy as well.
  - isFileWatchDirectoryRecursively
```
public boolean isFileWatchDirectoryRecursively()
```
  - setFileWatchDirectoryRecursively
```
public void setFileWatchDirectoryRecursively(boolean fileWatchDirectoryRecursively)
```
    Sets the flag to watch directory of XML file changes recursively to trigger live reload of Camel routes.
    Notice you cannot set this value and a custom ReloadStrategy as well.
  - getRouteBuilderClasses
```
public String getRouteBuilderClasses()
```
  - getReloadStrategy
```
public ReloadStrategy getReloadStrategy()
```
  - setReloadStrategy
```
public void setReloadStrategy(ReloadStrategy reloadStrategy)
```
    Sets a custom ReloadStrategy to be used.
    Notice you cannot set this value and the fileWatchDirectory as well.
  - isTrace
```
public boolean isTrace()
```
  - enableTrace
```
public void enableTrace()
```
  - doStop
```
protected void doStop()
               throws Exception
```
    Description copied from class: ServiceSupport
    
    Implementations override this method to support customized start/stop.
    Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.
    
    Specified by:
    
    doStop in class ServiceSupport
    
    Throws:
    
    Exception
    
    See Also:
    
    ServiceSupport.doStart()
  - doStart
```
protected void doStart()
                throws Exception
```
    Description copied from class: ServiceSupport
    
    Implementations override this method to support customized start/stop.
    Important: See ServiceSupport.doStop() for more details.
    
    Specified by:
    
    doStart in class ServiceSupport
    
    Throws:
    
    Exception
    
    See Also:
    
    ServiceSupport.doStop()
  - 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.
  - getCamelContexts
```
public List<CamelContext> getCamelContexts()
```
  - getRouteBuilders
```
public List<RouteBuilder> getRouteBuilders()
```
  - setRouteBuilders
```
public void setRouteBuilders(List<RouteBuilder> routeBuilders)
```
  - getRouteDefinitions
```
public List<RouteDefinition> getRouteDefinitions()
```
  - getCamelTemplate
```
public ProducerTemplate getCamelTemplate()
                                  throws Exception
```
    Throws:
    
    Exception
  - findOrCreateCamelTemplate
```
protected abstract ProducerTemplate findOrCreateCamelTemplate()
```
  - getCamelContextMap
```
protected abstract Map<String,CamelContext> getCamelContextMap()
```
  - postProcessContext
```
protected void postProcessContext()
                           throws Exception
```
    Throws:
    
    Exception
  - getModelJAXBContextFactory
```
public ModelJAXBContextFactory getModelJAXBContextFactory()
```
  - loadRouteBuilders
```
protected void loadRouteBuilders(CamelContext camelContext)
                          throws Exception
```
    Throws:
    
    Exception
  - postProcessCamelContext
```
protected void postProcessCamelContext(CamelContext camelContext)
                                throws Exception
```
    Throws:
    
    Exception
  - addRouteBuilder
```
public void addRouteBuilder(RouteBuilder routeBuilder)
```

Class MainSupport

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

LOG

UNINITIALIZED_EXIT_CODE

DEFAULT_EXIT_CODE

listeners

options

latch

completed

exitCode

duration

durationIdle

durationMaxMessages

timeUnit

trace

routeBuilders

routeBuilderClasses

fileWatchDirectory

fileWatchDirectoryRecursively

camelContexts

camelTemplate

hangupInterceptorEnabled

durationHitExitCode

reloadStrategy

Constructor Detail

MainSupport

Method Detail

run

disableHangupSupport

enableHangupSupport

addMainListener

removeMainListener

beforeStart

afterStart

beforeStop

afterStop

completed

showOptions

parseArguments

addOption

getDuration

setDuration

getDurationIdle

setDurationIdle

getDurationMaxMessages

setDurationMaxMessages

getTimeUnit

setTimeUnit

setDurationHitExitCode

getDurationHitExitCode

getExitCode

setRouteBuilderClasses

getFileWatchDirectory

setFileWatchDirectory

isFileWatchDirectoryRecursively

setFileWatchDirectoryRecursively

getRouteBuilderClasses

getReloadStrategy

setReloadStrategy

isTrace

enableTrace

doStop

doStart

waitUntilCompleted

run

showOptionsHeader

getCamelContexts

getRouteBuilders

setRouteBuilders

getRouteDefinitions

getCamelTemplate

findOrCreateCamelTemplate

getCamelContextMap