Interface RoutesBuilderLoader

All Superinterfaces:

AutoCloseable, CamelContextAware, HasCamelContext, Service, StaticService

All Known Subinterfaces:

ExtendedRoutesBuilderLoader

public interface RoutesBuilderLoader
extends StaticService, CamelContextAware

SPI that loads RoutesBuilder instances from a Resource identified by file extension.

Implementations are keyed by the extension they support (e.g. java, xml, yaml, kts) and are discovered at path FACTORY_PATH. At startup, CamelContext iterates over the configured route resource locations, selects the appropriate loader via isSupportedExtension(String), and calls loadRoutesBuilder(Resource) to obtain one or more RoutesBuilders that are then added to the context. Before routes are loaded, preParseRoute(Resource) may be called to extract camel.main.* bootstrap configuration from the DSL source without fully loading the routes; this allows the context to apply route-shaping settings (e.g. component overrides) before the full load.

Since:

3.8

See Also:

• Resource

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FACTORY_PATH	Service factory base path for language specific loaders.

Method Summary

Modifier and Type	Method	Description
String	getSupportedExtension()	The supported file extension.
default boolean	isSupportedExtension(String extension)	Whether the file extension is supported
RoutesBuilder	loadRoutesBuilder(Resource resource)	Loads RoutesBuilder from Resource.
default void	preParseRoute(Resource resource)	Pre-parses the RoutesBuilder from Resource.

Methods inherited from interface CamelContextAware

setCamelContext

Methods inherited from interface HasCamelContext

getCamelContext

Methods inherited from interface Service

build, close, init, start, stop

Field Details

FACTORY_PATH

static final String FACTORY_PATH

Service factory base path for language specific loaders.

See Also:

• Constant Field Values

Method Details

getSupportedExtension

String getSupportedExtension()

The supported file extension.

Implementations should support a single extension only.

isSupportedExtension

default boolean isSupportedExtension(String extension)

Whether the file extension is supported

loadRoutesBuilder

RoutesBuilder loadRoutesBuilder(Resource resource)
                         throws Exception

Loads RoutesBuilder from Resource.

Parameters:

resource - the resource to be loaded.

Returns:

a RoutesBuilder

Throws:

Exception

preParseRoute

default void preParseRoute(Resource resource)
                    throws Exception

Pre-parses the RoutesBuilder from Resource. This is used during bootstrap, to eager detect configurations from route DSL resources which makes it possible to specify configurations that affect the bootstrap, such as by camel-jbang and camel-yaml-dsl.

Parameters:

resource - the resource to be pre parsed.

Throws:

Exception