org.apache.camel.impl

Class DefaultModel

java.lang.Object

org.apache.camel.impl.DefaultModel

All Implemented Interfaces:

Model

public class DefaultModel
extends Object
implements Model

Constructor Summary

Constructors

Constructor and Description
DefaultModel(org.apache.camel.CamelContext camelContext)

Method Summary

Modifier and Type	Method and Description
void	addHystrixConfiguration(String id, HystrixConfigurationDefinition configuration) Adds the Hystrix configuration
void	addRestDefinitions(Collection<RestDefinition> restDefinitions, boolean addToRoutes) Adds a collection of rest definitions to the context
void	addRestDefinitions(InputStream is, boolean addToRoutes) Adds a collection of rest definitions to the context
void	addRouteDefinition(RouteDefinition routeDefinition) Add a route definition to the context Important: Each route in the same CamelContext must have an unique route id.
void	addRouteDefinitions(Collection<RouteDefinition> routeDefinitions) Adds a collection of route definitions to the context Important: Each route in the same CamelContext must have an unique route id.
void	addRouteDefinitions(InputStream is) Adds a collection of route definitions to the context Important: Each route in the same CamelContext must have an unique route id.
void	addServiceCallConfiguration(String serviceName, ServiceCallConfigurationDefinition configuration) Adds the service call configuration
org.apache.camel.CamelContext	getCamelContext()
Map<String,DataFormatDefinition>	getDataFormats() Gets the data formats that can be referenced in the routes.
HystrixConfigurationDefinition	getHystrixConfiguration(String id) Gets the Hystrix configuration by the given name.
ProcessorDefinition	getProcessorDefinition(String id) Gets the processor definition from any of the routes which with the given id
<T extends ProcessorDefinition> T	getProcessorDefinition(String id, Class<T> type) Gets the processor definition from any of the routes which with the given id
List<RestDefinition>	getRestDefinitions() Returns a list of the current REST definitions
RouteDefinition	getRouteDefinition(String id) Gets the route definition with the given id
List<RouteDefinition>	getRouteDefinitions() Returns a list of the current route definitions
Function<RouteDefinition,Boolean>	getRouteFilter() Gets the current route filter
ServiceCallConfigurationDefinition	getServiceCallConfiguration(String serviceName) Gets the service call configuration by the given name.
List<TransformerDefinition>	getTransformers() Gets the transformers that can be referenced in the routes.
List<ValidatorDefinition>	getValidators() Gets the validators that can be referenced in the routes.
protected static <T> T	lookup(org.apache.camel.CamelContext context, String ref, Class<T> type)
protected void	prepare(RouteDefinition routeDefinition)
void	removeRouteDefinition(RouteDefinition routeDefinition) Removes a route definition from the context - stopping any previously running routes if any of them are actively running
void	removeRouteDefinitions(Collection<RouteDefinition> routeDefinitions) Removes a collection of route definitions from the context - stopping any previously running routes if any of them are actively running
DataFormatDefinition	resolveDataFormatDefinition(String name) Resolve a data format definition given its name
void	setDataFormats(Map<String,DataFormatDefinition> dataFormats) Sets the data formats that can be referenced in the routes.
void	setHystrixConfiguration(HystrixConfigurationDefinition configuration) Sets the default Hystrix configuration
void	setHystrixConfigurations(List<HystrixConfigurationDefinition> configurations) Sets the Hystrix configurations
void	setRouteFilter(Function<RouteDefinition,Boolean> routeFilter) Sets a custom route filter to use for filtering unwanted routes when routes are added.
void	setRouteFilterPattern(String include, String exclude) Used for filtering routes routes matching the given pattern, which follows the following rules: - Match by route id - Match by route input endpoint uri The matching is using exact match, by wildcard and regular expression as documented by PatternHelper.matchPattern(String, String).
void	setServiceCallConfiguration(ServiceCallConfigurationDefinition configuration) Sets the default service call configuration
void	setServiceCallConfigurations(List<ServiceCallConfigurationDefinition> configurations) Sets the service call configurations
void	setTransformers(List<TransformerDefinition> transformers) Sets the transformers that can be referenced in the routes.
void	setValidators(List<ValidatorDefinition> validators) Sets the validators that can be referenced in the routes.
protected boolean	shouldStartRoutes() Should we start newly added routes?
protected void	start(RouteDefinition routeDefinition)
void	startRoute(RouteDefinition routeDefinition)
void	startRouteDefinitions() Start all routes from this model.
protected void	startRouteDefinitions(Collection<RouteDefinition> list)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultModel

public DefaultModel(org.apache.camel.CamelContext camelContext)

Method Detail

getCamelContext

public org.apache.camel.CamelContext getCamelContext()

addRouteDefinitions

public void addRouteDefinitions(InputStream is)
                         throws Exception

Description copied from interface: Model

Adds a collection of route definitions to the context

Important: Each route in the same CamelContext must have an unique route id. If you use the API from CamelContext or Model to add routes, then any new routes which has a route id that matches an old route, then the old route is replaced by the new route.

Specified by:

addRouteDefinitions in interface Model

Parameters:

is - input stream with the route(s) definition to add

Throws:

Exception - if the route definitions could not be added for whatever reason

addRouteDefinitions

public void addRouteDefinitions(Collection<RouteDefinition> routeDefinitions)
                         throws Exception

Description copied from interface: Model

Adds a collection of route definitions to the context

Important: Each route in the same CamelContext must have an unique route id. If you use the API from CamelContext or Model to add routes, then any new routes which has a route id that matches an old route, then the old route is replaced by the new route.

Specified by:

addRouteDefinitions in interface Model

Parameters:

routeDefinitions - the route(s) definition to add

Throws:

Exception - if the route definitions could not be added for whatever reason

addRouteDefinition

public void addRouteDefinition(RouteDefinition routeDefinition)
                        throws Exception

Description copied from interface: Model

Add a route definition to the context

Important: Each route in the same CamelContext must have an unique route id. If you use the API from CamelContext or Model to add routes, then any new routes which has a route id that matches an old route, then the old route is replaced by the new route.

Specified by:

addRouteDefinition in interface Model

Parameters:

routeDefinition - the route definition to add

Throws:

Exception - if the route definition could not be added for whatever reason

removeRouteDefinitions

public void removeRouteDefinitions(Collection<RouteDefinition> routeDefinitions)
                            throws Exception

Description copied from interface: Model

Removes a collection of route definitions from the context - stopping any previously running routes if any of them are actively running

Specified by:

removeRouteDefinitions in interface Model

Parameters:

routeDefinitions - route(s) definitions to remove

Throws:

Exception - if the route definitions could not be removed for whatever reason

removeRouteDefinition

public void removeRouteDefinition(RouteDefinition routeDefinition)
                           throws Exception

Description copied from interface: Model

Removes a route definition from the context - stopping any previously running routes if any of them are actively running

Specified by:

removeRouteDefinition in interface Model

Parameters:

routeDefinition - route definition to remove

Throws:

Exception - if the route definition could not be removed for whatever reason

getRouteDefinitions

public List<RouteDefinition> getRouteDefinitions()

Description copied from interface: Model

Returns a list of the current route definitions

Specified by:

getRouteDefinitions in interface Model

Returns:

list of the current route definitions

getRouteDefinition

public RouteDefinition getRouteDefinition(String id)

Description copied from interface: Model

Gets the route definition with the given id

Specified by:

getRouteDefinition in interface Model

Parameters:

id - id of the route

Returns:

the route definition or null if not found

getRestDefinitions

public List<RestDefinition> getRestDefinitions()

Description copied from interface: Model

Returns a list of the current REST definitions

Specified by:

getRestDefinitions in interface Model

Returns:

list of the current REST definitions

addRestDefinitions

public void addRestDefinitions(InputStream is,
                               boolean addToRoutes)
                        throws Exception

Description copied from interface: Model

Adds a collection of rest definitions to the context

Specified by:

addRestDefinitions in interface Model

Parameters:

is - input stream with the rest(s) definition to add

addToRoutes - whether the rests should also automatically be added as routes

Throws:

Exception - if the rest definitions could not be created for whatever reason

addRestDefinitions

public void addRestDefinitions(Collection<RestDefinition> restDefinitions,
                               boolean addToRoutes)
                        throws Exception

Description copied from interface: Model

Adds a collection of rest definitions to the context

Specified by:

addRestDefinitions in interface Model

Parameters:

restDefinitions - the rest(s) definition to add

addToRoutes - whether the rests should also automatically be added as routes

Throws:

Exception - if the rest definitions could not be created for whatever reason

getServiceCallConfiguration

public ServiceCallConfigurationDefinition getServiceCallConfiguration(String serviceName)

Description copied from interface: Model

Gets the service call configuration by the given name. If no name is given the default configuration is returned, see setServiceCallConfiguration

Specified by:

getServiceCallConfiguration in interface Model

Parameters:

serviceName - name of service, or null to return the default configuration

Returns:

the configuration, or null if no configuration has been registered

setServiceCallConfiguration

public void setServiceCallConfiguration(ServiceCallConfigurationDefinition configuration)

Description copied from interface: Model

Sets the default service call configuration

Specified by:

setServiceCallConfiguration in interface Model

Parameters:

configuration - the configuration

setServiceCallConfigurations

public void setServiceCallConfigurations(List<ServiceCallConfigurationDefinition> configurations)

Description copied from interface: Model

Sets the service call configurations

Specified by:

setServiceCallConfigurations in interface Model

Parameters:

configurations - the configuration list

addServiceCallConfiguration

public void addServiceCallConfiguration(String serviceName,
                                        ServiceCallConfigurationDefinition configuration)

Description copied from interface: Model

Adds the service call configuration

Specified by:

addServiceCallConfiguration in interface Model

Parameters:

serviceName - name of the service

configuration - the configuration

getHystrixConfiguration

public HystrixConfigurationDefinition getHystrixConfiguration(String id)

Description copied from interface: Model

Gets the Hystrix configuration by the given name. If no name is given the default configuration is returned, see setHystrixConfiguration

Specified by:

getHystrixConfiguration in interface Model

Parameters:

id - id of the configuration, or null to return the default configuration

Returns:

the configuration, or null if no configuration has been registered

setHystrixConfiguration

public void setHystrixConfiguration(HystrixConfigurationDefinition configuration)

Description copied from interface: Model

Sets the default Hystrix configuration

Specified by:

setHystrixConfiguration in interface Model

Parameters:

configuration - the configuration

setHystrixConfigurations

public void setHystrixConfigurations(List<HystrixConfigurationDefinition> configurations)

Description copied from interface: Model

Sets the Hystrix configurations

Specified by:

setHystrixConfigurations in interface Model

Parameters:

configurations - the configuration list

addHystrixConfiguration

public void addHystrixConfiguration(String id,
                                    HystrixConfigurationDefinition configuration)

Description copied from interface: Model

Adds the Hystrix configuration

Specified by:

addHystrixConfiguration in interface Model

Parameters:

id - name of the configuration

configuration - the configuration

resolveDataFormatDefinition

public DataFormatDefinition resolveDataFormatDefinition(String name)

Description copied from interface: Model

Resolve a data format definition given its name

Specified by:

resolveDataFormatDefinition in interface Model

Parameters:

name - the data format definition name or a reference to it in the Registry

Returns:

the resolved data format definition, or null if not found

getProcessorDefinition

public ProcessorDefinition getProcessorDefinition(String id)

Description copied from interface: Model

Gets the processor definition from any of the routes which with the given id

Specified by:

getProcessorDefinition in interface Model

Parameters:

id - id of the processor definition

Returns:

the processor definition or null if not found

getProcessorDefinition

public <T extends ProcessorDefinition> T getProcessorDefinition(String id,
                                                                Class<T> type)

Description copied from interface: Model

Gets the processor definition from any of the routes which with the given id

Specified by:

getProcessorDefinition in interface Model

Parameters:

id - id of the processor definition

type - the processor definition type

Returns:

the processor definition or null if not found

setDataFormats

public void setDataFormats(Map<String,DataFormatDefinition> dataFormats)

Description copied from interface: Model

Sets the data formats that can be referenced in the routes.

Specified by:

setDataFormats in interface Model

Parameters:

dataFormats - the data formats

getDataFormats

public Map<String,DataFormatDefinition> getDataFormats()

Description copied from interface: Model

Gets the data formats that can be referenced in the routes.

Specified by:

getDataFormats in interface Model

Returns:

the data formats available

setTransformers

public void setTransformers(List<TransformerDefinition> transformers)

Description copied from interface: Model

Sets the transformers that can be referenced in the routes.

Specified by:

setTransformers in interface Model

Parameters:

transformers - the transformers

getTransformers

public List<TransformerDefinition> getTransformers()

Description copied from interface: Model

Gets the transformers that can be referenced in the routes.

Specified by:

getTransformers in interface Model

Returns:

the transformers available

setValidators

public void setValidators(List<ValidatorDefinition> validators)

Description copied from interface: Model

Sets the validators that can be referenced in the routes.

Specified by:

setValidators in interface Model

Parameters:

validators - the validators

getValidators

public List<ValidatorDefinition> getValidators()

Description copied from interface: Model

Gets the validators that can be referenced in the routes.

Specified by:

getValidators in interface Model

Returns:

the validators available

startRouteDefinitions

public void startRouteDefinitions()
                           throws Exception

Description copied from interface: Model

Start all routes from this model.

Specified by:

startRouteDefinitions in interface Model

Throws:

Exception

setRouteFilterPattern

public void setRouteFilterPattern(String include,
                                  String exclude)

Description copied from interface: Model

Used for filtering routes routes matching the given pattern, which follows the following rules: - Match by route id - Match by route input endpoint uri The matching is using exact match, by wildcard and regular expression as documented by PatternHelper.matchPattern(String, String). For example to only include routes which starts with foo in their route id's, use: include=foo* And to exclude routes which starts from JMS endpoints, use: exclude=jms:* Exclude takes precedence over include.

Specified by:

setRouteFilterPattern in interface Model

Parameters:

include - the include pattern

exclude - the exclude pattern

getRouteFilter

public Function<RouteDefinition,Boolean> getRouteFilter()

Description copied from interface: Model

Gets the current route filter

Specified by:

getRouteFilter in interface Model

Returns:

the filter, or null if no custom filter has been configured.

setRouteFilter

public void setRouteFilter(Function<RouteDefinition,Boolean> routeFilter)

Description copied from interface: Model

Sets a custom route filter to use for filtering unwanted routes when routes are added.

Specified by:

setRouteFilter in interface Model

Parameters:

routeFilter - the filter

startRouteDefinitions

protected void startRouteDefinitions(Collection<RouteDefinition> list)
                              throws Exception

Throws:

Exception

startRoute

public void startRoute(RouteDefinition routeDefinition)
                throws Exception

Throws:

Exception

prepare

protected void prepare(RouteDefinition routeDefinition)
                throws Exception

Throws:

Exception

start

protected void start(RouteDefinition routeDefinition)
              throws Exception

Throws:

Exception

shouldStartRoutes

protected boolean shouldStartRoutes()

Should we start newly added routes?

lookup

protected static <T> T lookup(org.apache.camel.CamelContext context,
                              String ref,
                              Class<T> type)