Interface Route

All Superinterfaces:
RuntimeConfiguration
public interface Route extends RuntimeConfiguration
A Route defines the processing applied to an inbound Exchange arriving at a specific Endpoint within a CamelContext.

Each route has a unique id, an input Endpoint, and a chain of Processors that transform or route the exchange. Routes are built using a DSL (RoutesBuilder, RouteBuilder in Java DSL, YAML DSL, XML DSL) and are registered in the CamelContext at startup.

The lifecycle of a route (start, stop, suspend, resume) is managed through the RouteController. A route can also carry optional RoutePolicy objects that apply governance rules such as throttling or scheduling.

See Also:

  • Field Details

  • Method Details

    • getId

      String getId()
      Gets the route id
      Returns:
      the route id

    • getNodePrefixId

      @Nullable String getNodePrefixId()
      Gets the node prefix id

    • isCustomId

      boolean isCustomId()
      Whether the route id is custom assigned or auto assigned
      Returns:
      true if custom id, false if auto assigned id

    • isCreatedByRestDsl

      boolean isCreatedByRestDsl()
      Whether this route is a Rest DSL route.

    • isCreatedByRouteTemplate

      boolean isCreatedByRouteTemplate()
      Whether this route was created from a route template (or a Kamelet).

    • isCreatedByKamelet

      boolean isCreatedByKamelet()
      Whether this route was created from a Kamelet.

    • getGroup

      @Nullable String getGroup()
      Gets the route group
      Returns:
      the route group

    • getUptime

      String getUptime()
      Gets the uptime in a human-readable format
      Returns:
      the uptime in days/hours/minutes

    • getUptimeMillis

      long getUptimeMillis()
      Gets the uptime in milliseconds
      Returns:
      the uptime in milliseconds

    • getConsumer

      Consumer getConsumer()
      Gets the inbound Consumer
      Returns:
      the inbound consumer

    • getProcessor

      Processor getProcessor()
      Gets the Processor
      Returns:
      the processor

    • setProcessor

      void setProcessor(Processor processor)
      Sets the Processor

    • supportsSuspension

      boolean supportsSuspension()
      Whether or not the route supports suspension (suspend and resume)
      Returns:
      true if this route supports suspension

    • getProperties

      Map<String,Object> getProperties()
      This property map is used to associate information about the route.
      Returns:
      properties

    • getDescription

      @Nullable String getDescription()
      Gets the route description (if any has been configured).

      The description is configured using the DESCRIPTION_PROPERTY as key in the getProperties().

      Returns:
      the description, or null if no description has been configured.

    • getNote

      @Nullable String getNote()
      Gets the route note (if any has been configured).

      The note is configured using the NOTE_PROPERTY as key in the getProperties().

      Returns:
      the note, or null if no note has been configured.

    • getConfigurationId

      @Nullable String getConfigurationId()
      Gets the route configuration id(s) the route has been applied with. Multiple ids is separated by comma.

      The configuration ids is configured using the CONFIGURATION_ID_PROPERTY as key in the getProperties().

      Returns:
      the configuration, or null if no configuration has been configured.

    • getSourceResource

      @Nullable Resource getSourceResource()
      Gets the source resource that this route is located from
      Returns:
      the source, or null if this route is not loaded from a resource

    • getSourceLocation

      @Nullable String getSourceLocation()
      The source:line-number where the route input is located in the source code

    • getSourceLocationShort

      @Nullable String getSourceLocationShort()
      The source:line-number in short format that can be used for logging or summary purposes.

    • getCamelContext

      CamelContext getCamelContext()
      Gets the camel context
      Returns:
      the camel context

    • getEndpoint

      Endpoint getEndpoint()
      Gets the input endpoint for this route.
      Returns:
      the endpoint

    • initializeServices

      void initializeServices() throws Exception
      A strategy callback allowing special initialization when services are initializing.
      Throws:
      Exception - is thrown in case of error

    • getServices

      List<Service> getServices()
      Returns the services for this particular route
      Returns:
      the services

    • addService

      void addService(Service service)
      Adds a service to this route
      Parameters:
      service - the service

    • addService

      void addService(Service service, boolean forceStop)
      Adds a service to this route
      Parameters:
      service - the service
      forceStop - whether to force stopping the service when the route stops

    • filter

      List<Processor> filter(String pattern)
      Returns a list of all the Processors from this route that has id's matching the pattern
      Parameters:
      pattern - the pattern to match by ids
      Returns:
      a list of Processor, is never null.

    • warmUp

      void warmUp()
      Callback preparing the route to be started, by warming up the route.

    • getLastError

      @Nullable RouteError getLastError()
      Gets the last error that happened during changing the route lifecycle, i.e. such as when an exception was thrown during starting the route.

      This is only errors for route lifecycle changes, it is not exceptions thrown during routing exchanges by the Camel routing engine.

      Returns:
      the error or null if no error

    • setLastError

      void setLastError(@Nullable RouteError error)
      Sets the last error that happened during changing the route lifecycle, i.e. such as when an exception was thrown during starting the route.

      This is only errors for route lifecycle changes, it is not exceptions thrown during routing exchanges by the Camel routing engine.

      Parameters:
      error - the error

    • getStartupOrder

      @Nullable Integer getStartupOrder()
      Gets the route startup order

    • setStartupOrder

      void setStartupOrder(@Nullable Integer startupOrder)
      Sets the route startup order

    • getRouteController

      RouteController getRouteController()
      Gets the RouteController for this route.
      Returns:
      the route controller,

    • setRouteController

      void setRouteController(RouteController controller)
      Sets the RouteController for this route.
      Parameters:
      controller - the RouteController

    • setAutoStartup

      void setAutoStartup(Boolean autoStartup)
      Sets whether the route should automatically start when Camel starts.

      Default is true to always start up.

      Specified by:
      setAutoStartup in interface RuntimeConfiguration
      Parameters:
      autoStartup - whether to start up automatically.

    • isAutoStartup

      Boolean isAutoStartup()
      Gets whether the route should automatically start when Camel starts.

      Default is true to always start up.

      Specified by:
      isAutoStartup in interface RuntimeConfiguration
      Returns:
      true if route should automatically start

    • getRouteId

      String getRouteId()
      Gets the route id

    • getRouteDescription

      @Nullable String getRouteDescription()
      Gets the route description

    • getRouteNote

      @Nullable String getRouteNote()
      Gets the route note

    • getRoute

      @Nullable NamedNode getRoute()
      Get the route type. Important: is null after the route has been created.
      Returns:
      the route type during creation of the route, is null after the route has been created.

    • clearRouteModel

      void clearRouteModel()
      Clears the route model when its no longer needed.

    • getEventDrivenProcessors

      List<Processor> getEventDrivenProcessors()
      This method retrieves the event driven Processors on this route context.

    • getInterceptStrategies

      List<InterceptStrategy> getInterceptStrategies()
      This method retrieves the InterceptStrategy instances this route context.
      Returns:
      the strategy

    • setManagementInterceptStrategy

      void setManagementInterceptStrategy(ManagementInterceptStrategy interceptStrategy)
      Sets a special intercept strategy for management.

      Is by default used to correlate managed performance counters with processors when the runtime route is being constructed

      Parameters:
      interceptStrategy - the managed intercept strategy

    • getManagementInterceptStrategy

      @Nullable ManagementInterceptStrategy getManagementInterceptStrategy()
      Gets the special managed intercept strategy if any
      Returns:
      the managed intercept strategy, or null if not managed

    • getRoutePolicyList

      List<RoutePolicy> getRoutePolicyList()
      Gets the route policy List
      Returns:
      the route policy list if any

    • setErrorHandlerFactory

      void setErrorHandlerFactory(ErrorHandlerFactory errorHandlerFactory)
      Sets the error handler factory for this route.

    • getErrorHandlerFactory

      ErrorHandlerFactory getErrorHandlerFactory()
      Gets the error handler factory for this route.

    • getOnCompletions

      Collection<Processor> getOnCompletions()
      Gets the on completion processors.

    • setOnCompletion

      void setOnCompletion(String onCompletionId, Processor processor)
      Sets an on completion processor.

    • getOnExceptions

      Collection<Processor> getOnExceptions()
      Gets the on exception processors.

    • getOnException

      @Nullable Processor getOnException(String onExceptionId)
      Gets the on exception processor for the given id.

    • setOnException

      void setOnException(String onExceptionId, Processor processor)
      Sets an on exception processor.

    • addErrorHandler

      void addErrorHandler(ErrorHandlerFactory factory, NamedNode exception)
      Adds error handler for the given exception type
      Parameters:
      factory - the error handler factory
      exception - the exception to handle

    • getErrorHandlers

      Set<NamedNode> getErrorHandlers(ErrorHandlerFactory factory)
      Gets the error handlers
      Parameters:
      factory - the error handler factory

    • addErrorHandlerFactoryReference

      void addErrorHandlerFactoryReference(ErrorHandlerFactory source, ErrorHandlerFactory target)
      Link the error handlers from a factory to another
      Parameters:
      source - the source factory
      target - the target factory

    • setResumeStrategy

      void setResumeStrategy(ResumeStrategy resumeStrategy)
      Sets the resume strategy for the route

    • setConsumerListener

      void setConsumerListener(ConsumerListener<?,?> consumerListener)
      Sets the consumer listener for the route