Interface RoutesBuilder

public interface RoutesBuilder
Low-level SPI interface for objects that can contribute Routes to a CamelContext.

Implementations translate a route definition (from any DSL or model) into live Route instances and register them with the context. The actual routes become active after the context starts.

This interface is not intended to be used directly by Camel application developers. Application code should extend org.apache.camel.builder.RouteBuilder (Java DSL) or use the YAML / XML DSLs instead, all of which implement this interface under the hood.

See Also:

  • Method Details

    • addRoutesToCamelContext

      void addRoutesToCamelContext(CamelContext context) throws Exception
      Adds the routes from this Route Builder to the CamelContext.
      Parameters:
      context - the Camel context
      Throws:
      Exception - is thrown if initialization of routes failed

    • addTemplatedRoutesToCamelContext

      void addTemplatedRoutesToCamelContext(CamelContext context) throws Exception
      Adds the templated routes from this Route Builder to the CamelContext.
      Parameters:
      context - the Camel context
      Throws:
      Exception - is thrown if initialization of routes failed

    • updateRoutesToCamelContext

      Set<String> updateRoutesToCamelContext(CamelContext context) throws Exception
      Adds or updates the routes from this Route Builder to the CamelContext.
      Parameters:
      context - the Camel context
      Returns:
      route ids for the routes that was updated
      Throws:
      Exception - is thrown if initialization of routes failed