Package org.apache.camel.spi

Interface RoutesLoader

All Superinterfaces:

CamelContextAware

public interface RoutesLoader
extends CamelContextAware

SPI for loading RoutesBuilder from a list of Resource.

Field Summary

Fields

Modifier and Type	Field	Description
static String	FACTORY	Service factory key.

Method Summary

Modifier and Type	Method	Description
Collection<RoutesBuilder>	findRoutesBuilders(Collection<Resource> resources)	Find RoutesBuilder from the give list of Resource.
Collection<RoutesBuilder>	findRoutesBuilders(Collection<Resource> resources, boolean optional)	Find RoutesBuilder from the give list of Resource.
default Collection<RoutesBuilder>	findRoutesBuilders(Resource... resources)	Find RoutesBuilder from the give list of Resource.
RoutesBuilderLoader	getRoutesLoader(String extension)	Looks up a RoutesBuilderLoader in the registry or fallback to a factory finder mechanism if none found.
default void	initRoutesBuilderLoader(RoutesBuilderLoader loader)	Initializes the discovered RoutesBuilderLoader before its started and used for the first time.
default void	loadRoutes(Collection<Resource> resources)	Loads RoutesBuilder from the give list of Resource into the current CamelContext.
default void	loadRoutes(Resource... resources)	Loads RoutesBuilder from the give list of Resource into the current CamelContext.
default void	preParseRoute(Resource resource, boolean optional)	Pre-parses the RoutesBuilder from Resource.
Set<String>	updateRoutes(Collection<Resource> resources)	Loads or updates existing RoutesBuilder from the give list of Resource into the current CamelContext.
default Set<String>	updateRoutes(Resource... resources)	Loads or updates existing RoutesBuilder from the give list of Resource into the current CamelContext.

Methods inherited from interface org.apache.camel.CamelContextAware

getCamelContext, setCamelContext

Field Detail

FACTORY

static final String FACTORY

Service factory key.

See Also:

Constant Field Values

Method Detail

getRoutesLoader

RoutesBuilderLoader getRoutesLoader(String extension)
                             throws Exception

Looks up a RoutesBuilderLoader in the registry or fallback to a factory finder mechanism if none found.

Parameters:

extension - the file extension for which a loader should be found.

Returns:

a RoutesBuilderLoader

Throws:

IllegalArgumentException - if no RoutesBuilderLoader can be found for the given file extension

Exception

loadRoutes

default void loadRoutes(Collection<Resource> resources)
                 throws Exception

Loads RoutesBuilder from the give list of Resource into the current CamelContext.

Parameters:

resources - the resources to be loaded.

Throws:

Exception

loadRoutes

default void loadRoutes(Resource... resources)
                 throws Exception

Loads RoutesBuilder from the give list of Resource into the current CamelContext.

Parameters:

resources - the resources to be loaded.

Throws:

Exception

updateRoutes

default Set<String> updateRoutes(Resource... resources)
                          throws Exception

Loads or updates existing RoutesBuilder from the give list of Resource into the current CamelContext. If a route is loaded with a route id for an existing route, then the existing route is stopped and remove, so it can be updated.

Parameters:

resources - the resources to be loaded or updated.

Returns:

route ids for the routes that was loaded or updated.

Throws:

Exception

updateRoutes

Set<String> updateRoutes(Collection<Resource> resources)
                  throws Exception

Loads or updates existing RoutesBuilder from the give list of Resource into the current CamelContext. If a route is loaded with a route id for an existing route, then the existing route is stopped and remove, so it can be updated.

Parameters:

resources - the resources to be loaded or updated.

Returns:

route ids for the routes that was loaded or updated.

Throws:

Exception

findRoutesBuilders

default Collection<RoutesBuilder> findRoutesBuilders(Resource... resources)
                                              throws Exception

Find RoutesBuilder from the give list of Resource.

Parameters:

resources - the resource to be loaded.

Returns:

a collection of RoutesBuilder

Throws:

Exception

findRoutesBuilders

Collection<RoutesBuilder> findRoutesBuilders(Collection<Resource> resources)
                                      throws Exception

Find RoutesBuilder from the give list of Resource.

Parameters:

resources - the resource to be loaded.

Returns:

a collection RoutesBuilder

Throws:

Exception

findRoutesBuilders

Collection<RoutesBuilder> findRoutesBuilders(Collection<Resource> resources,
                                             boolean optional)
                                      throws Exception

Find RoutesBuilder from the give list of Resource.

Parameters:

resources - the resource to be loaded.

optional - whether parsing the resource is optional, such as there is no supported parser for the given resource extension

Returns:

a collection RoutesBuilder

Throws:

Exception

preParseRoute

default void preParseRoute(Resource resource,
                           boolean optional)
                    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.

optional - whether parsing the resource is optional, such as there is no supported parser for the given resource extension

Throws:

Exception

initRoutesBuilderLoader

default void initRoutesBuilderLoader(RoutesBuilderLoader loader)

Initializes the discovered RoutesBuilderLoader before its started and used for the first time.