org.apache.camel.model

Class RouteTemplateDefinition

java.lang.Object

org.apache.camel.model.OptionalIdentifiedDefinition

org.apache.camel.model.RouteTemplateDefinition

All Implemented Interfaces:

org.apache.camel.NamedNode, org.apache.camel.spi.HasId, org.apache.camel.spi.IdAware

@Metadata(label="configuration")
public class RouteTemplateDefinition
extends OptionalIdentifiedDefinition

Defines a route template (parameterized routes)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RouteTemplateDefinition.Converter

Constructor Summary

Constructors

Constructor and Description
RouteTemplateDefinition()

Method Summary

Modifier and Type	Method and Description
RouteDefinition	asRouteDefinition() Creates a copy of this template as a RouteDefinition which can be used to add as a new route.
RouteTemplateDefinition	description(String text) Sets the description of this node
RouteDefinition	from(org.apache.camel.Endpoint endpoint) Creates an input to the route
RouteDefinition	from(EndpointConsumerBuilder endpoint) Creates an input to the route
RouteDefinition	from(String uri) Creates an input to the route
String	getLabel()
RouteDefinition	getRoute()
String	getShortName()
List<RouteTemplateParameterDefinition>	getTemplateParameters()
RouteDefinition	route() To define the route in the template
void	setRoute(RouteDefinition route)
void	setTemplateParameters(List<RouteTemplateParameterDefinition> templateParameters)
RouteTemplateDefinition	templateParameter(String name) Adds a parameter the route template uses.
RouteTemplateDefinition	templateParameter(String name, String defaultValue) Adds a parameter the route template uses.
RouteTemplateDefinition	templateParameter(String name, String defaultValue, String description) Adds a parameter the route template uses.
RouteTemplateDefinition	templateParameters(Map<String,String> parameters) Adds the parameters the route template uses.

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

description, getCustomId, getDescription, getDescriptionText, getId, getParent, hasCustomIdAssigned, id, idOrCreate, setCustomId, setDescription, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

RouteTemplateDefinition

public RouteTemplateDefinition()

Method Detail

getTemplateParameters

public List<RouteTemplateParameterDefinition> getTemplateParameters()

setTemplateParameters

public void setTemplateParameters(List<RouteTemplateParameterDefinition> templateParameters)

getRoute

public RouteDefinition getRoute()

setRoute

public void setRoute(RouteDefinition route)

from

public RouteDefinition from(@AsEndpointUri
                            String uri)

Creates an input to the route

Parameters:

uri - the from uri

Returns:

the builder

from

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

Creates an input to the route

Parameters:

endpoint - the from endpoint

Returns:

the builder

from

public RouteDefinition from(EndpointConsumerBuilder endpoint)

Creates an input to the route

Parameters:

endpoint - the from endpoint

Returns:

the builder

route

public RouteDefinition route()

To define the route in the template

description

public RouteTemplateDefinition description(String text)

Description copied from class: OptionalIdentifiedDefinition

Sets the description of this node

Overrides:

description in class OptionalIdentifiedDefinition

Parameters:

text - sets the text description, use null to not set a text

Returns:

the builder

templateParameter

public RouteTemplateDefinition templateParameter(String name)

Adds a parameter the route template uses.

Parameters:

name - the name of the parameter

templateParameter

public RouteTemplateDefinition templateParameter(String name,
                                                 String defaultValue)

Adds a parameter the route template uses.

Parameters:

name - the name of the parameter

defaultValue - default value of the parameter

templateParameter

public RouteTemplateDefinition templateParameter(String name,
                                                 String defaultValue,
                                                 String description)

Adds a parameter the route template uses.

Parameters:

name - the name of the parameter

defaultValue - default value of the parameter

templateParameters

public RouteTemplateDefinition templateParameters(Map<String,String> parameters)

Adds the parameters the route template uses.

Parameters:

parameters - the parameters (only name and default values)

getShortName

public String getShortName()

getLabel

public String getLabel()

asRouteDefinition

public RouteDefinition asRouteDefinition()

Creates a copy of this template as a RouteDefinition which can be used to add as a new route.