Uses of Class
org.apache.camel.model.RouteDefinition

Packages that use RouteDefinition

Package	Description
org.apache.camel.builder	The Camel Domain Specific Language for creating Routes, Predicates, Expressions and Error Handlers.
org.apache.camel.model	The JAXB POJOs for the XML Configuration of the routing rules.
org.apache.camel.model.rest	The JAXB POJOs for the REST DSL

Uses of RouteDefinition in org.apache.camel.builder

Methods in org.apache.camel.builder that return RouteDefinition

Modifier and Type	Method	Description
static RouteDefinition	AdviceWith.adviceWith(Object routeId, org.apache.camel.CamelContext camelContext, RouteBuilder builder)	Advices this route with the route builder.
static RouteDefinition	AdviceWith.adviceWith(org.apache.camel.CamelContext camelContext, Object routeId, boolean logXml, org.apache.camel.util.function.ThrowingConsumer<AdviceWithRouteBuilder,Exception> builder)	Advices this route with the route builder using a lambda expression.
static RouteDefinition	AdviceWith.adviceWith(org.apache.camel.CamelContext camelContext, Object routeId, org.apache.camel.util.function.ThrowingConsumer<AdviceWithRouteBuilder,Exception> builder)	Advices this route with the route builder using a lambda expression.
static RouteDefinition	AdviceWith.adviceWith(RouteDefinition definition, org.apache.camel.CamelContext camelContext, RouteBuilder builder)	Advices this route with the route builder.
static RouteDefinition	AdviceWithRouteBuilder.adviceWith(org.apache.camel.CamelContext camelContext, Object routeId, boolean logXml, org.apache.camel.util.function.ThrowingConsumer<AdviceWithRouteBuilder,Exception> builder)	Deprecated. use AdviceWith.adviceWith(CamelContext, Object, boolean, ThrowingConsumer)
static RouteDefinition	AdviceWithRouteBuilder.adviceWith(org.apache.camel.CamelContext camelContext, Object routeId, org.apache.camel.util.function.ThrowingConsumer<AdviceWithRouteBuilder,Exception> builder)	Deprecated. use AdviceWith.adviceWith(CamelContext, Object, ThrowingConsumer)
RouteDefinition	RouteBuilder.from(String uri)	Creates a new route from the given URI input
RouteDefinition	RouteBuilder.from(EndpointConsumerBuilder endpointDefinition)
RouteDefinition	RouteBuilder.from(org.apache.camel.Endpoint endpoint)	Creates a new route from the given endpoint
RouteDefinition	RouteBuilder.fromF(String uri, Object... args)	Creates a new route from the given URI input
RouteDefinition	AdviceWithRouteBuilder.getOriginalRoute()	Gets the original route to be adviced.

Methods in org.apache.camel.builder with parameters of type RouteDefinition

Modifier and Type	Method	Description
static RouteDefinition	AdviceWith.adviceWith(RouteDefinition definition, org.apache.camel.CamelContext camelContext, RouteBuilder builder)	Advices this route with the route builder.
static AdviceWithTask	AdviceWithTasks.afterById(RouteDefinition route, String id, ProcessorDefinition<?> after, boolean selectFirst, boolean selectLast, int selectFrom, int selectTo, int maxDeep)
static AdviceWithTask	AdviceWithTasks.afterByToString(RouteDefinition route, String toString, ProcessorDefinition<?> after, boolean selectFirst, boolean selectLast, int selectFrom, int selectTo, int maxDeep)
static AdviceWithTask	AdviceWithTasks.afterByToUri(RouteDefinition route, String toUri, ProcessorDefinition<?> after, boolean selectFirst, boolean selectLast, int selectFrom, int selectTo, int maxDeep)
static AdviceWithTask	AdviceWithTasks.afterByType(RouteDefinition route, Class<?> type, ProcessorDefinition<?> after, boolean selectFirst, boolean selectLast, int selectFrom, int selectTo, int maxDeep)
static AdviceWithTask	AdviceWithTasks.beforeById(RouteDefinition route, String id, ProcessorDefinition<?> before, boolean selectFirst, boolean selectLast, int selectFrom, int selectTo, int maxDeep)
static AdviceWithTask	AdviceWithTasks.beforeByToString(RouteDefinition route, String toString, ProcessorDefinition<?> before, boolean selectFirst, boolean selectLast, int selectFrom, int selectTo, int maxDeep)
static AdviceWithTask	AdviceWithTasks.beforeByToUri(RouteDefinition route, String toUri, ProcessorDefinition<?> before, boolean selectFirst, boolean selectLast, int selectFrom, int selectTo, int maxDeep)
static AdviceWithTask	AdviceWithTasks.beforeByType(RouteDefinition route, Class<?> type, ProcessorDefinition<?> before, boolean selectFirst, boolean selectLast, int selectFrom, int selectTo, int maxDeep)
protected void	RouteBuilder.configureRoute(RouteDefinition route)
static AdviceWithTask	AdviceWithTasks.removeById(RouteDefinition route, String id, boolean selectFirst, boolean selectLast, int selectFrom, int selectTo, int maxDeep)
static AdviceWithTask	AdviceWithTasks.removeByToString(RouteDefinition route, String toString, boolean selectFirst, boolean selectLast, int selectFrom, int selectTo, int maxDeep)
static AdviceWithTask	AdviceWithTasks.removeByToUri(RouteDefinition route, String toUri, boolean selectFirst, boolean selectLast, int selectFrom, int selectTo, int maxDeep)
static AdviceWithTask	AdviceWithTasks.removeByType(RouteDefinition route, Class<?> type, boolean selectFirst, boolean selectLast, int selectFrom, int selectTo, int maxDeep)
static AdviceWithTask	AdviceWithTasks.replaceById(RouteDefinition route, String id, ProcessorDefinition<?> replace, boolean selectFirst, boolean selectLast, int selectFrom, int selectTo, int maxDeep)
static AdviceWithTask	AdviceWithTasks.replaceByToString(RouteDefinition route, String toString, ProcessorDefinition<?> replace, boolean selectFirst, boolean selectLast, int selectFrom, int selectTo, int maxDeep)
static AdviceWithTask	AdviceWithTasks.replaceByToUri(RouteDefinition route, String toUri, ProcessorDefinition<?> replace, boolean selectFirst, boolean selectLast, int selectFrom, int selectTo, int maxDeep)
static AdviceWithTask	AdviceWithTasks.replaceByType(RouteDefinition route, Class<?> type, ProcessorDefinition<?> replace, boolean selectFirst, boolean selectLast, int selectFrom, int selectTo, int maxDeep)
static AdviceWithTask	AdviceWithTasks.replaceFrom(RouteDefinition route, org.apache.camel.Endpoint endpoint)
static AdviceWithTask	AdviceWithTasks.replaceFromWith(RouteDefinition route, String uri)
void	AdviceWithRouteBuilder.setOriginalRoute(RouteDefinition originalRoute)	Sets the original route to be adviced.

Uses of RouteDefinition in org.apache.camel.model

Methods in org.apache.camel.model that return RouteDefinition

Modifier and Type	Method	Description
RouteDefinition	ModelCamelContext.adviceWith(RouteDefinition definition, AdviceWithRouteBuilder builder)	Deprecated. use AdviceWith.adviceWith(RouteDefinition, CamelContext, RouteBuilder)
RouteDefinition	RouteTemplateDefinition.Converter.apply(RouteTemplateDefinition in, Map<String,Object> parameters)	Convert a RouteTemplateDefinition to a RouteDefinition.
RouteDefinition	RouteTemplateDefinition.asRouteDefinition()	Creates a copy of this template as a RouteDefinition which can be used to add as a new route.
RouteDefinition	RouteDefinition.autoStartup(boolean autoStartup)	Sets the auto startup property on this route.
RouteDefinition	RouteDefinition.autoStartup(String autoStartup)	Sets the auto startup property on this route.
protected RouteDefinition	RoutesDefinition.createRoute()
RouteDefinition	RouteDefinition.delayer(long delay)	Enable delayer for this route.
RouteDefinition	RouteDefinition.errorHandler(String ref)	Installs the given error handler builder.
RouteDefinition	RouteDefinition.errorHandler(org.apache.camel.ErrorHandlerFactory errorHandlerBuilder)	Installs the given error handler builder.
RouteDefinition	RouteDefinition.from(String uri)	Creates an input to the route
RouteDefinition	RouteDefinition.from(EndpointConsumerBuilder endpoint)	Creates an input to the route
RouteDefinition	RouteDefinition.from(org.apache.camel.Endpoint endpoint)	Creates an input to the route
RouteDefinition	RoutesDefinition.from(String uri)	Creates a new route from the given URI input
RouteDefinition	RoutesDefinition.from(EndpointConsumerBuilder endpoint)
RouteDefinition	RoutesDefinition.from(org.apache.camel.Endpoint endpoint)	Creates a new route from the given endpoint
RouteDefinition	RouteTemplateDefinition.from(String uri)	Creates an input to the route
RouteDefinition	RouteTemplateDefinition.from(EndpointConsumerBuilder endpoint)	Creates an input to the route
RouteDefinition	RouteTemplateDefinition.from(org.apache.camel.Endpoint endpoint)	Creates an input to the route
static RouteDefinition	RouteDefinition.fromEndpoint(org.apache.camel.Endpoint endpoint)
static RouteDefinition	RouteDefinition.fromUri(String uri)
static RouteDefinition	ProcessorDefinitionHelper.getRoute(org.apache.camel.NamedNode node)	Gets the route definition the given node belongs to.
RouteDefinition	RouteTemplateDefinition.getRoute()
RouteDefinition	Model.getRouteDefinition(String id)	Gets the route definition with the given id
RouteDefinition	RouteDefinition.group(String name)	Set the group name for this route
RouteDefinition	RouteDefinition.inputType(Class clazz)	Declare the expected data type of the input message by Java class.
RouteDefinition	RouteDefinition.inputType(String urn)	Declare the expected data type of the input message.
RouteDefinition	RouteDefinition.inputTypeWithValidate(Class clazz)	Declare the expected data type of the input message by Java class with content validation enabled.
RouteDefinition	RouteDefinition.inputTypeWithValidate(String urn)	Declare the expected data type of the input message with content validation enabled.
RouteDefinition	RouteDefinition.logMask()	Enable security mask for Logging on this route.
RouteDefinition	RouteDefinition.logMask(String logMask)	Sets whether security mask for logging is enabled on this route.
RouteDefinition	RouteDefinition.messageHistory()	Enable message history for this route.
RouteDefinition	RouteDefinition.messageHistory(String messageHistory)	Enable message history for this route.
RouteDefinition	RouteDefinition.noAutoStartup()	Disables this route from being auto started when Camel starts.
RouteDefinition	RouteDefinition.noDelayer()	Disable delayer for this route.
RouteDefinition	RouteDefinition.noMessageHistory()	Disable message history for this route.
RouteDefinition	RouteDefinition.noStreamCaching()	Disable stream caching for this route.
RouteDefinition	RouteDefinition.noTracing()	Disable tracing for this route.
RouteDefinition	RouteDefinition.outputType(Class clazz)	Declare the expected data type of the output message by Java class.
RouteDefinition	RouteDefinition.outputType(String urn)	Declare the expected data type of the output message.
RouteDefinition	RouteDefinition.outputTypeWithValidate(Class clazz)	Declare the expected data type of the ouput message by Java class with content validation enabled.
RouteDefinition	RouteDefinition.outputTypeWithValidate(String urn)	Declare the expected data type of the output message with content validation enabled.
RouteDefinition	RouteDefinition.precondition(String precondition)	Sets the predicate of the precondition in simple language to evaluate in order to determine if this route should be included or not.
RouteDefinition	RoutesDefinition.route()	Creates a new route Prefer to use the from methods when creating a new route.
RouteDefinition	RoutesDefinition.route(RouteDefinition route)	Creates a new route using the given route.
RouteDefinition	RouteTemplateDefinition.route()	To define the route in the template
RouteDefinition	RouteDefinition.routeConfigurationId(String routeConfigurationId)	The route configuration id or pattern this route should use for configuration.
RouteDefinition	RouteDefinition.routeDescription(String description)	Set the route description for this route
RouteDefinition	RouteDefinition.routeGroup(String group)	Set the route group for this route
RouteDefinition	RouteDefinition.routeId(String id)	Set the route id for this route
RouteDefinition	RouteDefinition.routePolicy(Supplier<org.apache.camel.spi.RoutePolicy> policy)	Configures route policy for this route
RouteDefinition	RouteDefinition.routePolicy(org.apache.camel.spi.RoutePolicy... policies)	Configures route policies for this route
RouteDefinition	RouteDefinition.routePolicyRef(String routePolicyRef)	Configures a route policy for this route
RouteDefinition	RouteDefinition.routeProperty(String key, String value)	Adds a custom property on the route.
RouteDefinition	RouteDefinition.shutdownRoute(String shutdownRoute)	Configures a shutdown route option.
RouteDefinition	RouteDefinition.shutdownRoute(org.apache.camel.ShutdownRoute shutdownRoute)	Configures a shutdown route option.
RouteDefinition	RouteDefinition.shutdownRunningTask(String shutdownRunningTask)	Configures a shutdown running task option.
RouteDefinition	RouteDefinition.shutdownRunningTask(org.apache.camel.ShutdownRunningTask shutdownRunningTask)	Configures a shutdown running task option.
RouteDefinition	RouteDefinition.startupOrder(int order)	Configures the startup order for this route
RouteDefinition	RouteDefinition.streamCaching()	Enable stream caching for this route.
RouteDefinition	RouteDefinition.streamCaching(String streamCache)	Enable stream caching for this route.
RouteDefinition	RouteDefinition.tracing()	Enable tracing for this route.
RouteDefinition	RouteDefinition.tracing(String tracing)	Enable tracing for this route.

Methods in org.apache.camel.model that return types with arguments of type RouteDefinition

Modifier and Type	Method	Description
static Function<RouteDefinition,Boolean>	RouteFilters.filterByPattern(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).
List<RouteDefinition>	Model.getRouteDefinitions()	Returns a list of the current route definitions
Function<RouteDefinition,Boolean>	Model.getRouteFilter()	Gets the current route filter
List<RouteDefinition>	RouteContainer.getRoutes()	Returns the routes
List<RouteDefinition>	RoutesDefinition.getRoutes()
List<RouteDefinition>	RouteContextRefDefinition.lookupRoutes(org.apache.camel.CamelContext camelContext)
static List<RouteDefinition>	RouteContextRefDefinitionHelper.lookupRoutes(org.apache.camel.CamelContext camelContext, String ref)	Lookup the routes from the RouteContextRefDefinition.

Methods in org.apache.camel.model with parameters of type RouteDefinition

Modifier and Type	Method	Description
void	Model.addRouteDefinition(RouteDefinition routeDefinition)	Add a route definition to the context
RouteDefinition	ModelCamelContext.adviceWith(RouteDefinition definition, AdviceWithRouteBuilder builder)	Deprecated. use AdviceWith.adviceWith(RouteDefinition, CamelContext, RouteBuilder)
Boolean	RouteFilters.apply(RouteDefinition route)
static Set<String>	RouteDefinitionHelper.gatherAllEndpointUris(org.apache.camel.CamelContext camelContext, RouteDefinition route, boolean includeInput, boolean includeOutputs, boolean includeDynamic)	Gather all the endpoint uri's the route is using from the EIPs that has a static or dynamic endpoint defined.
static Set<String>	RouteDefinitionHelper.gatherAllStaticEndpointUris(org.apache.camel.CamelContext camelContext, RouteDefinition route, boolean includeInputs, boolean includeOutputs)	Gather all the endpoint uri's the route is using from the EIPs that has a static endpoint defined.
void	ModelLifecycleStrategy.onAddRouteDefinition(RouteDefinition routeDefinition)	Notification when a route definition is being added to CamelContext
void	ModelLifecycleStrategySupport.onAddRouteDefinition(RouteDefinition routeDefinition)
void	ModelLifecycleStrategy.onRemoveRouteDefinition(RouteDefinition routeDefinition)	Notification when a route definition is being removed from CamelContext
void	ModelLifecycleStrategySupport.onRemoveRouteDefinition(RouteDefinition routeDefinition)
static void	RouteDefinitionHelper.prepareRoute(org.apache.camel.CamelContext context, RouteDefinition route)	Prepares the route.
static void	RouteDefinitionHelper.prepareRoute(org.apache.camel.CamelContext context, RouteDefinition route, ErrorHandlerDefinition errorHandler, List<OnExceptionDefinition> onExceptions, List<InterceptDefinition> intercepts, List<InterceptFromDefinition> interceptFromDefinitions, List<InterceptSendToEndpointDefinition> interceptSendToEndpointDefinitions, List<OnCompletionDefinition> onCompletions)	Prepares the route which supports context scoped features such as onException, interceptors and onCompletions
void	RoutesDefinition.prepareRoute(RouteDefinition route)
static void	RouteDefinitionHelper.prepareRouteForInit(RouteDefinition route, List<ProcessorDefinition<?>> abstracts, List<ProcessorDefinition<?>> lower)
void	Model.removeRouteDefinition(RouteDefinition routeDefinition)	Removes a route definition from the context - stopping any previously running routes if any of them are actively running
RouteDefinition	RoutesDefinition.route(RouteDefinition route)	Creates a new route using the given route.
static void	RouteDefinitionHelper.sanityCheckRoute(RouteDefinition route)	Sanity check the route, that it has input(s) and outputs.
void	RouteTemplateDefinition.setRoute(RouteDefinition route)
static String	RouteDefinitionHelper.validateUniqueIds(RouteDefinition target, List<RouteDefinition> routes)	Validates that the target route has no duplicate id's from any of the existing routes.

Method parameters in org.apache.camel.model with type arguments of type RouteDefinition

Modifier and Type	Method	Description
void	Model.addRouteDefinitions(Collection<RouteDefinition> routeDefinitions)	Adds a collection of route definitions to the context
static void	RouteDefinitionHelper.forceAssignIds(org.apache.camel.CamelContext context, List<RouteDefinition> routes)	Force assigning ids to the routes
void	Model.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
void	Model.setRouteFilter(Function<RouteDefinition,Boolean> filter)	Sets a custom route filter to use for filtering unwanted routes when routes are added.
void	RouteContainer.setRoutes(List<RouteDefinition> routes)	Sets the routes to use
void	RoutesDefinition.setRoutes(List<RouteDefinition> routes)
void	ModelCamelContext.startRouteDefinitions(List<RouteDefinition> routeDefinitions)	Start the given set of routes.
static String	RouteDefinitionHelper.validateUniqueIds(RouteDefinition target, List<RouteDefinition> routes)	Validates that the target route has no duplicate id's from any of the existing routes.

Uses of RouteDefinition in org.apache.camel.model.rest

Methods in org.apache.camel.model.rest that return RouteDefinition

Modifier and Type	Method	Description
static RouteDefinition	RestDefinition.asRouteApiDefinition(org.apache.camel.CamelContext camelContext, org.apache.camel.spi.RestConfiguration configuration)	Transforms the rest api configuration into a RouteDefinition which Camel routing engine uses to service the rest api docs.

Methods in org.apache.camel.model.rest that return types with arguments of type RouteDefinition

Modifier and Type	Method	Description
List<RouteDefinition>	RestDefinition.asRouteDefinition(org.apache.camel.CamelContext camelContext)	Transforms this REST definition into a list of RouteDefinition which Camel routing engine can add and run.