Route Icon

Overview

The Route icon (Figure 1) appears in Outline view. It represents an individual route in a routing context file. In projects consisting of multiple routes, the route icons appear in Outline view in the order they appear within the camelContext element of the routing context file.

Figure 1. Route pattern

Route pattern

Usage

In Outline view, select a route's icon to display the route on the canvas and open its Properties editor. This is the easiest way to switch between routes when developing a multiroute project.

Properties

Table 99 describes the properties you can specify for a route using the Properties editor.

Table 99. Route Properties

NameDescription
Auto Startup

Specifies whether to start the route automatically when Camel starts up. The default is true.

Shutdown Route

Specifies when to stop the route. Options are:

  • Default—stop immediately

  • Defer—wait until Camel shuts down

Startup OrderSpecifies the order in which to start this route in relation to other routes in the routing context when Camel starts up. Valid values are integers corresponding to the number of routes in the routing context.
TraceSpecifies whether to trace the path of an exchange through a particular route. The default is false.
Stream CacheSpecifies whether to cache streams that otherwise could not be accessed multiple times. This is necessary for implementing redelivery during error handling, which requires reading the stream multiple times. The default is false.
Error Handler RefSpecifies a reference to a bean that defines and applies an error handler.
Route Policy RefSpecifies a reference to a bean that defines and applies a policy that controls routes at runtime. The bean can implement any logic that you want Apache Camel to invoke at route start or at route end.
DelayerSpecifies a delay, in milliseconds, that slows down message processing. This is useful during debugging, making it easier to inspect the logs while tracking messages. The default is 0.
Handle FaultSpecifies whether to convert fault messages into exceptions. Intended for applications deployed into a JBI container, so the Camel error handler can react to faults. The default is false.
Shutdown Running Task

Specifies how the routing context shuts down. Options are:

  • CompleteCurrentTaskOnly—[Default] shutdown immediately after the current task has finished

  • CompleteAllTasks—shutdown after all pending tasks have finished

GroupSpecifies the name of a group of which the route is a member. This property is informational only. It is not used by Apache Camel.
IdSpecifies a unique id for the route. This id appears in the generated XML (Source view) and with the Route icon in Outline view. It also appears in log entries. If left blank, Fuse IDE assigns the route a default Id.
DescriptionSpecifies a textual description for the route. This description is included in the generated XML file, but it is informational only. It is not used by Apache Camel.

Related topics

Adding routes to the routing context