org.apache.camel
Interface RuntimeConfiguration

All Known Subinterfaces:

CamelContext, ModelCamelContext, RouteContext

All Known Implementing Classes:

DefaultCamelContext, DefaultRouteContext

public interface RuntimeConfiguration

Various runtime configuration options used by CamelContext and RouteContext for cross cutting functions such as tracing, delayer, stream cache and the like.

Version:

Method Summary

Long	getDelayer() Gets the delay value
ShutdownRoute	getShutdownRoute() Gets the option to use when shutting down the route.
ShutdownRunningTask	getShutdownRunningTask() Gets the ShutdownRunningTask option in use when shutting down a route.
Boolean	isAllowUseOriginalMessage() Sets whether to allow access to the original message from Camel's error handler, or from UnitOfWork.getOriginalInMessage().
Boolean	isAutoStartup() Gets whether the object should automatically start when Camel starts.
Boolean	isHandleFault() Returns whether fault handling enabled
Boolean	isMessageHistory() Returns whether message history is enabled
Boolean	isStreamCaching() Returns whether stream cache is enabled
Boolean	isTracing() Returns whether tracing enabled
void	setAllowUseOriginalMessage(Boolean allowUseOriginalMessage) Sets whether to allow access to the original message from Camel's error handler, or from UnitOfWork.getOriginalInMessage().
void	setAutoStartup(Boolean autoStartup) Sets whether the object should automatically start when Camel starts.
void	setDelayer(Long delay) Sets a delay value in millis that a message is delayed at every step it takes in the route path, slowing the process down to better observe what is occurring Is disabled by default
void	setHandleFault(Boolean handleFault) Sets whether fault handling is enabled or not (default is disabled).
void	setMessageHistory(Boolean messageHistory) Sets whether message history is enabled or not (default is enabled).
void	setShutdownRoute(ShutdownRoute shutdownRoute) Sets the ShutdownRoute option for routes.
void	setShutdownRunningTask(ShutdownRunningTask shutdownRunningTask) Sets the ShutdownRunningTask option to use when shutting down a route.
void	setStreamCaching(Boolean cache) Sets whether stream caching is enabled or not (default is disabled).
void	setTracing(Boolean tracing) Sets whether tracing is enabled or not (default is disabled).

Method Detail

setStreamCaching

void setStreamCaching(Boolean cache)

Sets whether stream caching is enabled or not (default is disabled).

Parameters:

cache - whether stream caching is enabled or not

isStreamCaching

Boolean isStreamCaching()

Returns whether stream cache is enabled

Returns:

true if stream cache is enabled

setTracing

void setTracing(Boolean tracing)

Sets whether tracing is enabled or not (default is disabled).

Parameters:

tracing - whether to enable tracing.

isTracing

Boolean isTracing()

Returns whether tracing enabled

Returns:

true if tracing is enabled

setMessageHistory

void setMessageHistory(Boolean messageHistory)

Sets whether message history is enabled or not (default is enabled).

Parameters:

messageHistory - whether message history is enabled

isMessageHistory

Boolean isMessageHistory()

Returns whether message history is enabled

Returns:

true if message history is enabled

setHandleFault

void setHandleFault(Boolean handleFault)

Sets whether fault handling is enabled or not (default is disabled).

Parameters:

handleFault - whether to enable fault handling.

isHandleFault

Boolean isHandleFault()

Returns whether fault handling enabled

Returns:

true if fault handling is enabled

setDelayer

void setDelayer(Long delay)

Sets a delay value in millis that a message is delayed at every step it takes in the route path, slowing the process down to better observe what is occurring

Is disabled by default

Parameters:

delay - delay in millis

getDelayer

Long getDelayer()

Gets the delay value

Returns:

delay in millis, or null if disabled

setAutoStartup

void setAutoStartup(Boolean autoStartup)

Sets whether the object should automatically start when Camel starts.

Important: Currently only routes can be disabled, as CamelContexts are always started.
Note: When setting auto startup false on CamelContext then that takes precedence and no routes is started. You would need to start CamelContext explicit using the CamelContext.start() method, to start the context, and then you would need to start the routes manually using CamelContext.startRoute(String).

Default is true to always start up.

Parameters:

autoStartup - whether to start up automatically.

isAutoStartup

Boolean isAutoStartup()

Gets whether the object should automatically start when Camel starts.

Important: Currently only routes can be disabled, as CamelContexts are always started.
Default is true to always start up.

Returns:

true if object should automatically start

setShutdownRoute

void setShutdownRoute(ShutdownRoute shutdownRoute)

Sets the ShutdownRoute option for routes.

Parameters:

shutdownRoute - the option to use.

getShutdownRoute

ShutdownRoute getShutdownRoute()

Gets the option to use when shutting down the route.

Returns:

the option

setShutdownRunningTask

void setShutdownRunningTask(ShutdownRunningTask shutdownRunningTask)

Sets the ShutdownRunningTask option to use when shutting down a route.

Parameters:

shutdownRunningTask - the option to use.

getShutdownRunningTask

ShutdownRunningTask getShutdownRunningTask()

Gets the ShutdownRunningTask option in use when shutting down a route.

Returns:

the option

setAllowUseOriginalMessage

void setAllowUseOriginalMessage(Boolean allowUseOriginalMessage)

Sets whether to allow access to the original message from Camel's error handler, or from UnitOfWork.getOriginalInMessage().

Turning this off can optimize performance, as defensive copy of the original message is not needed.

Parameters:

allowUseOriginalMessage - the option to use.

isAllowUseOriginalMessage

Boolean isAllowUseOriginalMessage()

Sets whether to allow access to the original message from Camel's error handler, or from UnitOfWork.getOriginalInMessage().

Turning this off can optimize performance, as defensive copy of the original message is not needed.

Returns:

the option