Package org.apache.camel.model

Class FromDefinition

java.lang.Object

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

org.apache.camel.model.FromDefinition

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.LineNumberAware, EndpointRequiredDefinition, org.apache.camel.NamedNode, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HasId, org.apache.camel.spi.IdAware

@Metadata(label="eip,routing")
public class FromDefinition
extends OptionalIdentifiedDefinition<FromDefinition>
implements EndpointRequiredDefinition

Act as a message source as input to a route

Constructor Summary

Constructors

Constructor	Description
FromDefinition()
FromDefinition(String uri)
FromDefinition(EndpointConsumerBuilder endpointConsumerBuilder)
FromDefinition(org.apache.camel.Endpoint endpoint)

Method Summary

Modifier and Type	Method	Description
protected void	clear()
org.apache.camel.Endpoint	getEndpoint()	Gets tne endpoint if an Endpoint instance was set.
EndpointConsumerBuilder	getEndpointConsumerBuilder()
String	getEndpointUri()	Gets the uri of the endpoint used by this definition.
String	getLabel()
org.apache.camel.NamedNode	getParent()
String	getShortName()
String	getUri()
String	getVariableReceive()
void	setEndpoint(org.apache.camel.Endpoint endpoint)
void	setEndpointConsumerBuilder(EndpointConsumerBuilder endpointConsumerBuilder)
void	setParent(RouteDefinition parent)
void	setUri(String uri)	Sets the URI of the endpoint to use
void	setVariableReceive(String variableReceive)	To use a variable to store a copy of the received message body (only body, not headers).
String	toString()

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.NamedNode

acceptDebugger

Constructor Details

FromDefinition

public FromDefinition()

FromDefinition

public FromDefinition(String uri)

FromDefinition

public FromDefinition(org.apache.camel.Endpoint endpoint)

FromDefinition

public FromDefinition(EndpointConsumerBuilder endpointConsumerBuilder)

Method Details

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

getEndpointUri

public String getEndpointUri()

Description copied from interface: EndpointRequiredDefinition

Gets the uri of the endpoint used by this definition.

Specified by:

getEndpointUri in interface EndpointRequiredDefinition

getParent

public org.apache.camel.NamedNode getParent()

Specified by:

getParent in interface org.apache.camel.NamedNode

Overrides:

getParent in class OptionalIdentifiedDefinition<FromDefinition>

setParent

public void setParent(RouteDefinition parent)

getUri

public String getUri()

setUri

public void setUri(String uri)

Sets the URI of the endpoint to use

Parameters:

uri - the endpoint URI to use

getVariableReceive

public String getVariableReceive()

setVariableReceive

public void setVariableReceive(String variableReceive)

To use a variable to store a copy of the received message body (only body, not headers). This is handy for easy access to the received message body via variables.

getEndpoint

public org.apache.camel.Endpoint getEndpoint()

Gets tne endpoint if an Endpoint instance was set.

This implementation may return null which means you need to use getEndpointUri() to get information about the endpoint.

Returns:

the endpoint instance, or null

setEndpoint

public void setEndpoint(org.apache.camel.Endpoint endpoint)

getEndpointConsumerBuilder

public EndpointConsumerBuilder getEndpointConsumerBuilder()

setEndpointConsumerBuilder

public void setEndpointConsumerBuilder(EndpointConsumerBuilder endpointConsumerBuilder)

clear

protected void clear()