org.apache.camel.model

Class FromDefinition

java.lang.Object

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

org.apache.camel.model.FromDefinition

All Implemented Interfaces:

EndpointRequiredDefinition, NamedNode

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

Act as a message source as input to a route

Version:

Constructor Summary

Constructors

Constructor and Description
FromDefinition()
FromDefinition(Endpoint endpoint)
FromDefinition(String uri)

Method Summary

Modifier and Type	Method and Description
protected void	clear()
protected static String	description(String uri, String ref, Endpoint endpoint)
Endpoint	getEndpoint() Gets tne endpoint if an Endpoint instance was set.
String	getEndpointUri() Gets the uri of the endpoint used by this definition.
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
String	getRef()
String	getUri()
Object	getUriOrRef() Returns the endpoint URI or the name of the reference to it
Endpoint	resolveEndpoint(RouteContext context)
void	setEndpoint(Endpoint endpoint)
void	setRef(String ref) Deprecated. use uri with ref:uri instead
void	setUri(String uri) Sets the URI of the endpoint to use
String	toString()

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

FromDefinition

public FromDefinition()

FromDefinition

public FromDefinition(String uri)

FromDefinition

public FromDefinition(Endpoint endpoint)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getLabel

public String getLabel()

Description copied from interface: NamedNode

Returns a label to describe this node such as the expression if some kind of expression node

Specified by:

getLabel in interface NamedNode

resolveEndpoint

public Endpoint resolveEndpoint(RouteContext context)

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

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

getRef

public String getRef()

setRef

@Deprecated
public void setRef(String ref)

Deprecated. use uri with ref:uri instead

Sets the name of the endpoint within the registry (such as the Spring ApplicationContext or JNDI) to use

Parameters:

ref - the reference name to use

getEndpoint

public Endpoint getEndpoint()

Gets tne endpoint if an Endpoint instance was set.

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

Returns:

the endpoint instance, or null

setEndpoint

public void setEndpoint(Endpoint endpoint)

getUriOrRef

public Object getUriOrRef()

Returns the endpoint URI or the name of the reference to it

description

protected static String description(String uri,
                                    String ref,
                                    Endpoint endpoint)

clear

protected void clear()