Package org.apache.camel.model

Class RoutesDefinition

java.lang.Object

org.apache.camel.model.OptionalIdentifiedDefinition<RoutesDefinition>

org.apache.camel.model.RoutesDefinition

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.LineNumberAware, RouteContainer, org.apache.camel.NamedNode, org.apache.camel.spi.HasId, org.apache.camel.spi.IdAware, org.apache.camel.spi.ResourceAware

@Metadata(label="configuration")
public class RoutesDefinition
extends OptionalIdentifiedDefinition<RoutesDefinition>
implements RouteContainer, org.apache.camel.CamelContextAware, org.apache.camel.spi.ResourceAware

A series of Camel routes

Constructor Summary

Constructors

Constructor	Description
RoutesDefinition()

Method Summary

Modifier and Type	Method	Description
protected RouteDefinition	createRoute()
RouteDefinition	from(String uri)	Creates a new route from the given URI input
RouteDefinition	from(EndpointConsumerBuilder endpoint)
RouteDefinition	from(org.apache.camel.Endpoint endpoint)	Creates a new route from the given endpoint
org.apache.camel.CamelContext	getCamelContext()
org.apache.camel.ErrorHandlerFactory	getErrorHandlerFactory()
List<InterceptFromDefinition>	getInterceptFroms()
List<InterceptDefinition>	getIntercepts()
List<InterceptSendToEndpointDefinition>	getInterceptSendTos()
String	getLabel()
List<OnCompletionDefinition>	getOnCompletions()
List<OnExceptionDefinition>	getOnExceptions()
org.apache.camel.spi.Resource	getResource()
List<RouteDefinition>	getRoutes()	Returns the routes
String	getShortName()
InterceptDefinition	intercept()	Creates and adds an interceptor that is triggered on every step in the route processing.
InterceptFromDefinition	interceptFrom()	Creates and adds an interceptor that is triggered when an exchange is received as input to any routes (eg from all the from)
InterceptFromDefinition	interceptFrom(String uri)	Creates and adds an interceptor that is triggered when an exchange is received as input to the route defined with the given endpoint (eg from the from)
InterceptSendToEndpointDefinition	interceptSendToEndpoint(String uri)	Creates and adds an interceptor that is triggered when an exchange is send to the given endpoint
OnCompletionDefinition	onCompletion()	Adds an on completion
OnExceptionDefinition	onException(Class<? extends Throwable> exception)	Adds an on exception
void	prepareRoute(RouteDefinition route)
RouteDefinition	route()	Creates a new route Prefer to use the from methods when creating a new route.
RouteDefinition	route(RouteDefinition route)	Creates a new route using the given route.
void	setCamelContext(org.apache.camel.CamelContext camelContext)
void	setErrorHandlerFactory(org.apache.camel.ErrorHandlerFactory errorHandlerFactory)
void	setInterceptFroms(List<InterceptFromDefinition> interceptFroms)
void	setIntercepts(List<InterceptDefinition> intercepts)
void	setInterceptSendTos(List<InterceptSendToEndpointDefinition> interceptSendTos)
void	setOnCompletions(List<OnCompletionDefinition> onCompletions)
void	setOnExceptions(List<OnExceptionDefinition> onExceptions)
void	setResource(org.apache.camel.spi.Resource resource)
void	setRoutes(List<RouteDefinition> routes)	Sets the routes to use
String	toString()

Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition

description, description, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, getParent, hasCustomIdAssigned, id, idOrCreate, setCustomId, setDescription, setGeneratedId, setId, setLineNumber, setLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

RoutesDefinition

public RoutesDefinition()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getShortName

public String getShortName()

Specified by:

getShortName in interface org.apache.camel.NamedNode

getLabel

public String getLabel()

Specified by:

getLabel in interface org.apache.camel.NamedNode

getRoutes

public List<RouteDefinition> getRoutes()

Description copied from interface: RouteContainer

Returns the routes

Specified by:

getRoutes in interface RouteContainer

Returns:

the routes

setRoutes

public void setRoutes(List<RouteDefinition> routes)

Description copied from interface: RouteContainer

Sets the routes to use

Specified by:

setRoutes in interface RouteContainer

Parameters:

routes - the routes

getInterceptFroms

public List<InterceptFromDefinition> getInterceptFroms()

setInterceptFroms

public void setInterceptFroms(List<InterceptFromDefinition> interceptFroms)

getInterceptSendTos

public List<InterceptSendToEndpointDefinition> getInterceptSendTos()

setInterceptSendTos

public void setInterceptSendTos(List<InterceptSendToEndpointDefinition> interceptSendTos)

getIntercepts

public List<InterceptDefinition> getIntercepts()

setIntercepts

public void setIntercepts(List<InterceptDefinition> intercepts)

getOnExceptions

public List<OnExceptionDefinition> getOnExceptions()

setOnExceptions

public void setOnExceptions(List<OnExceptionDefinition> onExceptions)

getOnCompletions

public List<OnCompletionDefinition> getOnCompletions()

setOnCompletions

public void setOnCompletions(List<OnCompletionDefinition> onCompletions)

getCamelContext

public org.apache.camel.CamelContext getCamelContext()

Specified by:

getCamelContext in interface org.apache.camel.CamelContextAware

Overrides:

getCamelContext in class OptionalIdentifiedDefinition<RoutesDefinition>

setCamelContext

public void setCamelContext(org.apache.camel.CamelContext camelContext)

Specified by:

setCamelContext in interface org.apache.camel.CamelContextAware

Overrides:

setCamelContext in class OptionalIdentifiedDefinition<RoutesDefinition>

getErrorHandlerFactory

public org.apache.camel.ErrorHandlerFactory getErrorHandlerFactory()

setErrorHandlerFactory

public void setErrorHandlerFactory(org.apache.camel.ErrorHandlerFactory errorHandlerFactory)

getResource

public org.apache.camel.spi.Resource getResource()

Specified by:

getResource in interface org.apache.camel.spi.ResourceAware

setResource

public void setResource(org.apache.camel.spi.Resource resource)

Specified by:

setResource in interface org.apache.camel.spi.ResourceAware

route

public RouteDefinition route()

Creates a new route Prefer to use the from methods when creating a new route.

Returns:

the builder

from

public RouteDefinition from(@AsEndpointUri
                            String uri)

Creates a new route from the given URI input

Parameters:

uri - the from uri

Returns:

the builder

from

public RouteDefinition from(org.apache.camel.Endpoint endpoint)

Creates a new route from the given endpoint

Parameters:

endpoint - the from endpoint

Returns:

the builder

from

public RouteDefinition from(EndpointConsumerBuilder endpoint)

route

public RouteDefinition route(RouteDefinition route)

Creates a new route using the given route.

Important: This API is NOT intended for Camel end users, but used internally by Camel itself.

Parameters:

route - the route

Returns:

the builder

prepareRoute

public void prepareRoute(RouteDefinition route)

intercept

public InterceptDefinition intercept()

Creates and adds an interceptor that is triggered on every step in the route processing.

Returns:

the interceptor builder to configure

interceptFrom

public InterceptFromDefinition interceptFrom()

Creates and adds an interceptor that is triggered when an exchange is received as input to any routes (eg from all the from)

Returns:

the interceptor builder to configure

interceptFrom

public InterceptFromDefinition interceptFrom(@AsEndpointUri
                                             String uri)

Creates and adds an interceptor that is triggered when an exchange is received as input to the route defined with the given endpoint (eg from the from)

Parameters:

uri - uri of the endpoint

Returns:

the interceptor builder to configure

interceptSendToEndpoint

public InterceptSendToEndpointDefinition interceptSendToEndpoint(@AsEndpointUri
                                                                 String uri)

Creates and adds an interceptor that is triggered when an exchange is send to the given endpoint

Parameters:

uri - uri of the endpoint

Returns:

the builder

onException

public OnExceptionDefinition onException(Class<? extends Throwable> exception)

Adds an on exception

Parameters:

exception - the exception

Returns:

the builder

onCompletion

public OnCompletionDefinition onCompletion()

Adds an on completion

Returns:

the builder

createRoute

protected RouteDefinition createRoute()