Package org.apache.camel.model

Class ToDefinition

java.lang.Object

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

org.apache.camel.model.ProcessorDefinition<ToDefinition>

org.apache.camel.model.NoOutputDefinition<ToDefinition>

org.apache.camel.model.SendDefinition<ToDefinition>

org.apache.camel.model.ToDefinition

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.LineNumberAware, Block, 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 ToDefinition
extends SendDefinition<ToDefinition>

Sends the message to a static endpoint

Field Summary

Fields inherited from class org.apache.camel.model.SendDefinition

endpoint, endpointProducerBuilder, uri

Fields inherited from class org.apache.camel.model.ProcessorDefinition

disabled, inheritErrorHandler

Constructor Summary

Constructors

Constructor	Description
ToDefinition()
ToDefinition(String uri)
ToDefinition(String uri, org.apache.camel.ExchangePattern pattern)
ToDefinition(EndpointProducerBuilder endpointDefinition)
ToDefinition(EndpointProducerBuilder endpoint, org.apache.camel.ExchangePattern pattern)
ToDefinition(org.apache.camel.Endpoint endpoint)
ToDefinition(org.apache.camel.Endpoint endpoint, org.apache.camel.ExchangePattern pattern)

Method Summary

Modifier and Type	Method	Description
String	getPattern()
String	getShortName()
String	getVariableReceive()
String	getVariableSend()
void	setPattern(String pattern)	Sets the optional ExchangePattern used to invoke this endpoint
void	setVariableReceive(String variableReceive)	To use a variable to store the received message body (only body, not headers).
void	setVariableSend(String variableSend)	To use a variable as the source for the message body to send.
String	toString()

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

clear, getEndpoint, getEndpointProducerBuilder, getEndpointUri, getLabel, getUri, setEndpoint, setEndpointProducerBuilder, setUri

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

getOutputs

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

addInterceptStrategy, addOutput, aggregate, aggregate, aggregate, aggregate, bean, bean, bean, bean, bean, bean, bean, bean, bean, bean, bean, choice, circuitBreaker, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, configureChild, convertBodyTo, convertBodyTo, convertBodyTo, convertHeaderTo, convertHeaderTo, convertHeaderTo, convertHeaderTo, convertVariableTo, convertVariableTo, convertVariableTo, convertVariableTo, delay, delay, delay, disabled, disabled, disabled, doTry, dynamicRouter, dynamicRouter, end, endChoice, endCircuitBreaker, endDoCatch, endDoTry, endParent, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getDisabled, getIndex, getInterceptStrategies, getParent, getRouteConfiguration, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, isAbstract, isInheritErrorHandler, isTopLevelOnly, isWrappingEntireOutput, kamelet, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, loopDoWhile, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, nodePrefixId, onCompletion, onException, onException, onException, onException, pausable, pausable, pausable, pausable, pipeline, pipeline, pipeline, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, preCreateProcessor, process, process, process, recipientList, recipientList, recipientList, recipientList, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, removeVariable, resequence, resequence, resumable, resumable, resumable, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setDisabled, setExchangePattern, setExchangePattern, setHeader, setHeader, setHeader, setHeaders, setInheritErrorHandler, setParent, setProperty, setProperty, setProperty, setRouteConfiguration, setVariable, setVariable, setVariable, sort, sort, sort, split, split, split, split, startupOrder, step, step, stop, threads, threads, threads, threads, throttle, throttle, throttle, throttle, throttle, throwException, throwException, to, to, to, to, to, to, to, to, to, to, to, to, toD, toD, toD, toD, toD, toD, toD, toD, toD, toF, toV, transacted, transacted, transform, transform, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap, wireTap, wireTap

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

description, getCamelContext, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, getNodePrefixId, hasCustomIdAssigned, 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

Constructor Details

ToDefinition

public ToDefinition()

ToDefinition

public ToDefinition(String uri)

ToDefinition

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

ToDefinition

public ToDefinition(EndpointProducerBuilder endpointDefinition)

ToDefinition

public ToDefinition(String uri,
 org.apache.camel.ExchangePattern pattern)

ToDefinition

public ToDefinition(org.apache.camel.Endpoint endpoint,
 org.apache.camel.ExchangePattern pattern)

ToDefinition

public ToDefinition(EndpointProducerBuilder endpoint,
 org.apache.camel.ExchangePattern pattern)

Method Details

getShortName

public String getShortName()

toString

public String toString()

Overrides:

toString in class Object

getPattern

public String getPattern()

Overrides:

getPattern in class SendDefinition<ToDefinition>

setPattern

public void setPattern(String pattern)

Sets the optional ExchangePattern used to invoke this endpoint

getVariableSend

public String getVariableSend()

setVariableSend

public void setVariableSend(String variableSend)

To use a variable as the source for the message body to send. This makes it handy to use variables for user data and to easily control what data to use for sending and receiving. Important: When using send variable then the message body is taken from this variable instead of the current Message, however the headers from the Message will still be used as well. In other words, the variable is used instead of the message body, but everything else is as usual.

getVariableReceive

public String getVariableReceive()

setVariableReceive

public void setVariableReceive(String variableReceive)

To use a variable to store the received message body (only body, not headers). This is handy for easy access to the received message body via variables. Important: When using receive variable then the received body is stored only in this variable and not on the current Message.