org.apache.camel.impl.engine

Class DefaultRoute

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.impl.engine.DefaultRoute

All Implemented Interfaces:

AutoCloseable, org.apache.camel.Route, org.apache.camel.RuntimeConfiguration, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

public class DefaultRoute
extends org.apache.camel.support.service.ServiceSupport
implements org.apache.camel.Route

Default implementation of Route.

Use the API from CamelContext to control the lifecycle of a route, such as starting and stopping using the RouteController.startRoute(String) and RouteController.stopRoute(String) methods.

Field Summary

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

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

Fields inherited from interface org.apache.camel.Route

CUSTOM_ID_PROPERTY, DESCRIPTION_PROPERTY, GROUP_PROPERTY, ID_PROPERTY, PARENT_PROPERTY, REST_PROPERTY, TEMPLATE_PROPERTY

Constructor Summary

Constructors

Constructor and Description
DefaultRoute(org.apache.camel.CamelContext camelContext, org.apache.camel.NamedNode route, String routeId, String routeDescription, org.apache.camel.Endpoint endpoint)

Method Summary

Modifier and Type	Method and Description
void	addErrorHandler(org.apache.camel.ErrorHandlerFactory factory, org.apache.camel.NamedNode onException)
void	addErrorHandlerFactoryReference(org.apache.camel.ErrorHandlerFactory source, org.apache.camel.ErrorHandlerFactory target)
void	addService(org.apache.camel.Service service)
protected void	addServices(List<org.apache.camel.Service> services) Factory method to lazily create the complete list of services required for this route such as adding the processor or consumer
void	clearModelReferences()
org.apache.camel.Processor	createErrorHandler(org.apache.camel.Processor processor)
protected void	doShutdown()
protected void	doStart()
protected void	doStop()
List<org.apache.camel.Processor>	filter(String pattern)
org.apache.camel.CamelContext	getCamelContext()
org.apache.camel.Consumer	getConsumer()
Long	getDelayer()
String	getDescription()
org.apache.camel.Endpoint	getEndpoint()
org.apache.camel.ErrorHandlerFactory	getErrorHandlerFactory()
Set<org.apache.camel.NamedNode>	getErrorHandlers(org.apache.camel.ErrorHandlerFactory factory)
List<org.apache.camel.Processor>	getEventDrivenProcessors()
String	getGroup()
String	getId()
List<org.apache.camel.spi.InterceptStrategy>	getInterceptStrategies()
org.apache.camel.spi.RouteError	getLastError()
org.apache.camel.spi.ManagementInterceptStrategy	getManagementInterceptStrategy()
org.apache.camel.Processor	getOnCompletion(String onCompletionId)
Collection<org.apache.camel.Processor>	getOnCompletions()
org.apache.camel.Processor	getOnException(String onExceptionId)
Collection<org.apache.camel.Processor>	getOnExceptions()
org.apache.camel.Processor	getProcessor()
Map<String,Object>	getProperties()
org.apache.camel.NamedNode	getRoute()
org.apache.camel.spi.RouteController	getRouteController()
String	getRouteDescription()
String	getRouteId()
List<org.apache.camel.spi.RoutePolicy>	getRoutePolicyList()
List<org.apache.camel.Service>	getServices()
org.apache.camel.ShutdownRoute	getShutdownRoute()
org.apache.camel.ShutdownRunningTask	getShutdownRunningTask()
Integer	getStartupOrder()
String	getTracingPattern()
String	getUptime()
long	getUptimeMillis()
Boolean	isAllowUseOriginalMessage()
Boolean	isAutoStartup()
Boolean	isBacklogTracing()
Boolean	isCaseInsensitiveHeaders()
Boolean	isDebugging()
Boolean	isLogExhaustedMessageBody()
Boolean	isLogMask()
Boolean	isMessageHistory()
Boolean	isStreamCaching()
Boolean	isTracing()
org.apache.camel.Navigate<org.apache.camel.Processor>	navigate()
void	onStartingServices(List<org.apache.camel.Service> services)
void	setAllowUseOriginalMessage(Boolean allowUseOriginalMessage)
void	setAutoStartup(Boolean autoStartup)
void	setBacklogTracing(Boolean backlogTrace)
void	setCaseInsensitiveHeaders(Boolean caseInsensitiveHeaders)
void	setDebugging(Boolean debugging)
void	setDelayer(Long delay)
void	setErrorHandlerFactory(org.apache.camel.ErrorHandlerFactory errorHandlerFactory)
void	setLastError(org.apache.camel.spi.RouteError routeError)
void	setLogExhaustedMessageBody(Boolean logExhaustedMessageBody)
void	setLogMask(Boolean logMask)
void	setManagementInterceptStrategy(org.apache.camel.spi.ManagementInterceptStrategy interceptStrategy)
void	setMessageHistory(Boolean messageHistory)
void	setOnCompletion(String onCompletionId, org.apache.camel.Processor processor)
void	setOnException(String onExceptionId, org.apache.camel.Processor processor)
void	setProcessor(org.apache.camel.Processor processor)
void	setRouteController(org.apache.camel.spi.RouteController routeController)
void	setShutdownRoute(org.apache.camel.ShutdownRoute shutdownRoute)
void	setShutdownRunningTask(org.apache.camel.ShutdownRunningTask shutdownRunningTask)
void	setStartupOrder(Integer startupOrder)
void	setStreamCaching(Boolean cache)
void	setTracing(Boolean tracing)
void	setTracingPattern(String tracePattern)
void	start() Do not invoke this method directly, use RouteController.startRoute(String) to start a route.
void	stop() Do not invoke this method directly, use RouteController.stopRoute(String) to stop a route.
boolean	supportsSuspension()
String	toString()
void	warmUp()

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

build, doBuild, doFail, doInit, doLifecycleChange, doResume, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, suspend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.StatefulService

getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

Methods inherited from interface org.apache.camel.Service

build, close, init

Constructor Detail

DefaultRoute

public DefaultRoute(org.apache.camel.CamelContext camelContext,
                    org.apache.camel.NamedNode route,
                    String routeId,
                    String routeDescription,
                    org.apache.camel.Endpoint endpoint)

Method Detail

createErrorHandler

public org.apache.camel.Processor createErrorHandler(org.apache.camel.Processor processor)
                                              throws Exception

Specified by:

createErrorHandler in interface org.apache.camel.Route

Throws:

Exception

getId

public String getId()

Specified by:

getId in interface org.apache.camel.Route

getGroup

public String getGroup()

Specified by:

getGroup in interface org.apache.camel.Route

getUptime

public String getUptime()

Specified by:

getUptime in interface org.apache.camel.Route

getUptimeMillis

public long getUptimeMillis()

Specified by:

getUptimeMillis in interface org.apache.camel.Route

getEndpoint

public org.apache.camel.Endpoint getEndpoint()

Specified by:

getEndpoint in interface org.apache.camel.Route

getCamelContext

public org.apache.camel.CamelContext getCamelContext()

Specified by:

getCamelContext in interface org.apache.camel.Route

getProperties

public Map<String,Object> getProperties()

Specified by:

getProperties in interface org.apache.camel.Route

getDescription

public String getDescription()

Specified by:

getDescription in interface org.apache.camel.Route

onStartingServices

public void onStartingServices(List<org.apache.camel.Service> services)
                        throws Exception

Specified by:

onStartingServices in interface org.apache.camel.Route

Throws:

Exception

getServices

public List<org.apache.camel.Service> getServices()

Specified by:

getServices in interface org.apache.camel.Route

addService

public void addService(org.apache.camel.Service service)

Specified by:

addService in interface org.apache.camel.Route

warmUp

public void warmUp()

Specified by:

warmUp in interface org.apache.camel.Route

start

public void start()

Do not invoke this method directly, use RouteController.startRoute(String) to start a route.

Specified by:

start in interface org.apache.camel.Service

Overrides:

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

stop

public void stop()

Do not invoke this method directly, use RouteController.stopRoute(String) to stop a route.

Specified by:

stop in interface org.apache.camel.Service

Overrides:

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

doStart

protected void doStart()
                throws Exception

Overrides:

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

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

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

Throws:

Exception

doShutdown

protected void doShutdown()
                   throws Exception

Overrides:

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

Throws:

Exception

getLastError

public org.apache.camel.spi.RouteError getLastError()

Specified by:

getLastError in interface org.apache.camel.Route

setLastError

public void setLastError(org.apache.camel.spi.RouteError routeError)

Specified by:

setLastError in interface org.apache.camel.Route

getStartupOrder

public Integer getStartupOrder()

Specified by:

getStartupOrder in interface org.apache.camel.Route

setStartupOrder

public void setStartupOrder(Integer startupOrder)

Specified by:

setStartupOrder in interface org.apache.camel.Route

getRouteController

public org.apache.camel.spi.RouteController getRouteController()

Specified by:

getRouteController in interface org.apache.camel.Route

setRouteController

public void setRouteController(org.apache.camel.spi.RouteController routeController)

Specified by:

setRouteController in interface org.apache.camel.Route

isAutoStartup

public Boolean isAutoStartup()

Specified by:

isAutoStartup in interface org.apache.camel.Route

Specified by:

isAutoStartup in interface org.apache.camel.RuntimeConfiguration

setAutoStartup

public void setAutoStartup(Boolean autoStartup)

Specified by:

setAutoStartup in interface org.apache.camel.Route

Specified by:

setAutoStartup in interface org.apache.camel.RuntimeConfiguration

getRoute

public org.apache.camel.NamedNode getRoute()

Specified by:

getRoute in interface org.apache.camel.Route

getRouteId

public String getRouteId()

Specified by:

getRouteId in interface org.apache.camel.Route

getRouteDescription

public String getRouteDescription()

Specified by:

getRouteDescription in interface org.apache.camel.Route

getEventDrivenProcessors

public List<org.apache.camel.Processor> getEventDrivenProcessors()

Specified by:

getEventDrivenProcessors in interface org.apache.camel.Route

getInterceptStrategies

public List<org.apache.camel.spi.InterceptStrategy> getInterceptStrategies()

Specified by:

getInterceptStrategies in interface org.apache.camel.Route

setManagementInterceptStrategy

public void setManagementInterceptStrategy(org.apache.camel.spi.ManagementInterceptStrategy interceptStrategy)

Specified by:

setManagementInterceptStrategy in interface org.apache.camel.Route

getManagementInterceptStrategy

public org.apache.camel.spi.ManagementInterceptStrategy getManagementInterceptStrategy()

Specified by:

getManagementInterceptStrategy in interface org.apache.camel.Route

setTracing

public void setTracing(Boolean tracing)

Specified by:

setTracing in interface org.apache.camel.RuntimeConfiguration

isTracing

public Boolean isTracing()

Specified by:

isTracing in interface org.apache.camel.RuntimeConfiguration

getTracingPattern

public String getTracingPattern()

Specified by:

getTracingPattern in interface org.apache.camel.RuntimeConfiguration

setTracingPattern

public void setTracingPattern(String tracePattern)

Specified by:

setTracingPattern in interface org.apache.camel.RuntimeConfiguration

setBacklogTracing

public void setBacklogTracing(Boolean backlogTrace)

Specified by:

setBacklogTracing in interface org.apache.camel.RuntimeConfiguration

isBacklogTracing

public Boolean isBacklogTracing()

Specified by:

isBacklogTracing in interface org.apache.camel.RuntimeConfiguration

setDebugging

public void setDebugging(Boolean debugging)

Specified by:

setDebugging in interface org.apache.camel.RuntimeConfiguration

isDebugging

public Boolean isDebugging()

Specified by:

isDebugging in interface org.apache.camel.RuntimeConfiguration

setMessageHistory

public void setMessageHistory(Boolean messageHistory)

Specified by:

setMessageHistory in interface org.apache.camel.RuntimeConfiguration

isMessageHistory

public Boolean isMessageHistory()

Specified by:

isMessageHistory in interface org.apache.camel.RuntimeConfiguration

setLogMask

public void setLogMask(Boolean logMask)

Specified by:

setLogMask in interface org.apache.camel.RuntimeConfiguration

isLogMask

public Boolean isLogMask()

Specified by:

isLogMask in interface org.apache.camel.RuntimeConfiguration

setLogExhaustedMessageBody

public void setLogExhaustedMessageBody(Boolean logExhaustedMessageBody)

Specified by:

setLogExhaustedMessageBody in interface org.apache.camel.RuntimeConfiguration

isLogExhaustedMessageBody

public Boolean isLogExhaustedMessageBody()

Specified by:

isLogExhaustedMessageBody in interface org.apache.camel.RuntimeConfiguration

setStreamCaching

public void setStreamCaching(Boolean cache)

Specified by:

setStreamCaching in interface org.apache.camel.RuntimeConfiguration

isStreamCaching

public Boolean isStreamCaching()

Specified by:

isStreamCaching in interface org.apache.camel.RuntimeConfiguration

setDelayer

public void setDelayer(Long delay)

Specified by:

setDelayer in interface org.apache.camel.RuntimeConfiguration

getDelayer

public Long getDelayer()

Specified by:

getDelayer in interface org.apache.camel.RuntimeConfiguration

setErrorHandlerFactory

public void setErrorHandlerFactory(org.apache.camel.ErrorHandlerFactory errorHandlerFactory)

Specified by:

setErrorHandlerFactory in interface org.apache.camel.Route

getErrorHandlerFactory

public org.apache.camel.ErrorHandlerFactory getErrorHandlerFactory()

Specified by:

getErrorHandlerFactory in interface org.apache.camel.Route

setShutdownRoute

public void setShutdownRoute(org.apache.camel.ShutdownRoute shutdownRoute)

Specified by:

setShutdownRoute in interface org.apache.camel.RuntimeConfiguration

setAllowUseOriginalMessage

public void setAllowUseOriginalMessage(Boolean allowUseOriginalMessage)

Specified by:

setAllowUseOriginalMessage in interface org.apache.camel.RuntimeConfiguration

isAllowUseOriginalMessage

public Boolean isAllowUseOriginalMessage()

Specified by:

isAllowUseOriginalMessage in interface org.apache.camel.RuntimeConfiguration

isCaseInsensitiveHeaders

public Boolean isCaseInsensitiveHeaders()

Specified by:

isCaseInsensitiveHeaders in interface org.apache.camel.RuntimeConfiguration

setCaseInsensitiveHeaders

public void setCaseInsensitiveHeaders(Boolean caseInsensitiveHeaders)

Specified by:

setCaseInsensitiveHeaders in interface org.apache.camel.RuntimeConfiguration

getShutdownRoute

public org.apache.camel.ShutdownRoute getShutdownRoute()

Specified by:

getShutdownRoute in interface org.apache.camel.RuntimeConfiguration

setShutdownRunningTask

public void setShutdownRunningTask(org.apache.camel.ShutdownRunningTask shutdownRunningTask)

Specified by:

setShutdownRunningTask in interface org.apache.camel.RuntimeConfiguration

getShutdownRunningTask

public org.apache.camel.ShutdownRunningTask getShutdownRunningTask()

Specified by:

getShutdownRunningTask in interface org.apache.camel.RuntimeConfiguration

getRoutePolicyList

public List<org.apache.camel.spi.RoutePolicy> getRoutePolicyList()

Specified by:

getRoutePolicyList in interface org.apache.camel.Route

getOnCompletions

public Collection<org.apache.camel.Processor> getOnCompletions()

Specified by:

getOnCompletions in interface org.apache.camel.Route

getOnCompletion

public org.apache.camel.Processor getOnCompletion(String onCompletionId)

Specified by:

getOnCompletion in interface org.apache.camel.Route

setOnCompletion

public void setOnCompletion(String onCompletionId,
                            org.apache.camel.Processor processor)

Specified by:

setOnCompletion in interface org.apache.camel.Route

getOnExceptions

public Collection<org.apache.camel.Processor> getOnExceptions()

Specified by:

getOnExceptions in interface org.apache.camel.Route

getOnException

public org.apache.camel.Processor getOnException(String onExceptionId)

Specified by:

getOnException in interface org.apache.camel.Route

setOnException

public void setOnException(String onExceptionId,
                           org.apache.camel.Processor processor)

Specified by:

setOnException in interface org.apache.camel.Route

getErrorHandlers

public Set<org.apache.camel.NamedNode> getErrorHandlers(org.apache.camel.ErrorHandlerFactory factory)

Specified by:

getErrorHandlers in interface org.apache.camel.Route

addErrorHandler

public void addErrorHandler(org.apache.camel.ErrorHandlerFactory factory,
                            org.apache.camel.NamedNode onException)

Specified by:

addErrorHandler in interface org.apache.camel.Route

addErrorHandlerFactoryReference

public void addErrorHandlerFactoryReference(org.apache.camel.ErrorHandlerFactory source,
                                            org.apache.camel.ErrorHandlerFactory target)

Specified by:

addErrorHandlerFactoryReference in interface org.apache.camel.Route

toString

public String toString()

Overrides:

toString in class Object

getProcessor

public org.apache.camel.Processor getProcessor()

Specified by:

getProcessor in interface org.apache.camel.Route

setProcessor

public void setProcessor(org.apache.camel.Processor processor)

addServices

protected void addServices(List<org.apache.camel.Service> services)
                    throws Exception

Factory method to lazily create the complete list of services required for this route such as adding the processor or consumer

Throws:

Exception

navigate

public org.apache.camel.Navigate<org.apache.camel.Processor> navigate()

Specified by:

navigate in interface org.apache.camel.Route

filter

public List<org.apache.camel.Processor> filter(String pattern)

Specified by:

filter in interface org.apache.camel.Route

getConsumer

public org.apache.camel.Consumer getConsumer()

Specified by:

getConsumer in interface org.apache.camel.Route

supportsSuspension

public boolean supportsSuspension()

Specified by:

supportsSuspension in interface org.apache.camel.Route

clearModelReferences

public void clearModelReferences()