Package org.apache.camel.model

Class ToDynamicDefinition

java.lang.Object

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

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

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

org.apache.camel.model.ToDynamicDefinition

All Implemented Interfaces:

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

Direct Known Subclasses:

WireTapDefinition

@Metadata(label="eip,routing")
public class ToDynamicDefinition
extends NoOutputDefinition<ToDynamicDefinition>

Sends the message to a dynamic endpoint

Field Summary

Fields

Modifier and Type	Field	Description
protected EndpointProducerBuilder	endpointProducerBuilder

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

disabled, inheritErrorHandler

Constructor Summary

Constructors

Constructor	Description
ToDynamicDefinition()
ToDynamicDefinition(String uri)

Method Summary

Modifier and Type	Method	Description
ToDynamicDefinition	allowOptimisedComponents(boolean allowOptimisedComponents)	Whether to allow components to optimise toD if they are SendDynamicAware.
ToDynamicDefinition	allowOptimisedComponents(String allowOptimisedComponents)	Whether to allow components to optimise toD if they are SendDynamicAware.
ToDynamicDefinition	autoStartComponents(String autoStartComponents)	Whether to auto startup components when toD is starting up.
ToDynamicDefinition	cacheSize(int cacheSize)	Sets the maximum size used by the ProducerCache which is used to cache and reuse producers when using this recipient list, when uris are reused.
ToDynamicDefinition	cacheSize(String cacheSize)	Sets the maximum size used by the ProducerCache which is used to cache and reuse producers when using this recipient list, when uris are reused.
String	getAllowOptimisedComponents()
String	getAutoStartComponents()
String	getCacheSize()
EndpointProducerBuilder	getEndpointProducerBuilder()
String	getIgnoreInvalidEndpoint()
String	getLabel()	Returns a label to describe this node such as the expression if some kind of expression node
String	getPattern()
String	getShortName()
String	getUri()
String	getVariableReceive()
String	getVariableSend()
ToDynamicDefinition	ignoreInvalidEndpoint(boolean ignoreInvalidEndpoint)	Whether to ignore invalid endpoint URIs and skip sending the message.
ToDynamicDefinition	ignoreInvalidEndpoint(String ignoreInvalidEndpoint)	Whether to ignore invalid endpoint URIs and skip sending the message.
ToDynamicDefinition	pattern(String pattern)	Sets the optional ExchangePattern used to invoke this endpoint
ToDynamicDefinition	pattern(org.apache.camel.ExchangePattern pattern)	Sets the optional ExchangePattern used to invoke this endpoint
void	setAllowOptimisedComponents(String allowOptimisedComponents)
void	setAutoStartComponents(String autoStartComponents)
void	setCacheSize(String cacheSize)
void	setEndpointProducerBuilder(EndpointProducerBuilder endpointProducerBuilder)
void	setIgnoreInvalidEndpoint(String ignoreInvalidEndpoint)
void	setPattern(String pattern)
void	setUri(String uri)	The uri of the endpoint to send to.
void	setVariableReceive(String variableReceive)
void	setVariableSend(String variableSend)
String	toString()
ToDynamicDefinition	uri(String uri)	The uri of the endpoint to send to.
ToDynamicDefinition	uri(EndpointProducerBuilder endpointProducerBuilder)	The uri of the endpoint to send to.
ToDynamicDefinition	variableReceive(String variableReceive)	To use a variable as the source for the message body to send.
ToDynamicDefinition	variableSend(String variableSend)	To use a variable to store the received message body (only body, not headers).

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

Field Details

endpointProducerBuilder

protected EndpointProducerBuilder endpointProducerBuilder

Constructor Details

ToDynamicDefinition

public ToDynamicDefinition()

ToDynamicDefinition

public ToDynamicDefinition(String uri)

Method Details

getShortName

public String getShortName()

toString

public String toString()

Overrides:

toString in class Object

getLabel

public String getLabel()

Description copied from class: ProcessorDefinition

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

Specified by:

getLabel in interface org.apache.camel.NamedNode

Overrides:

getLabel in class ProcessorDefinition<ToDynamicDefinition>

uri

public ToDynamicDefinition uri(@AsEndpointUri
 String uri)

The uri of the endpoint to send to. The uri can be dynamic computed using the

invalid reference

org.apache.camel.language.simple.SimpleLanguage

expression.

uri

public ToDynamicDefinition uri(@AsEndpointUri
 EndpointProducerBuilder endpointProducerBuilder)

The uri of the endpoint to send to.

Parameters:

endpointProducerBuilder - the dynamic endpoint to send to (resolved using simple language by default)

variableReceive

public ToDynamicDefinition variableReceive(String variableReceive)

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.

variableSend

public ToDynamicDefinition variableSend(String variableSend)

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.

pattern

public ToDynamicDefinition pattern(org.apache.camel.ExchangePattern pattern)

Sets the optional ExchangePattern used to invoke this endpoint

pattern

public ToDynamicDefinition pattern(String pattern)

Sets the optional ExchangePattern used to invoke this endpoint

cacheSize

public ToDynamicDefinition cacheSize(int cacheSize)

Sets the maximum size used by the ProducerCache which is used to cache and reuse producers when using this recipient list, when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn off caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers.

Parameters:

cacheSize - the cache size, use 0 for default cache size, or -1 to turn cache off.

Returns:

the builder

cacheSize

public ToDynamicDefinition cacheSize(String cacheSize)

Sets the maximum size used by the ProducerCache which is used to cache and reuse producers when using this recipient list, when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn off caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers.

Parameters:

cacheSize - the cache size, use 0 for default cache size, or -1 to turn cache off.

Returns:

the builder

ignoreInvalidEndpoint

public ToDynamicDefinition ignoreInvalidEndpoint(boolean ignoreInvalidEndpoint)

Whether to ignore invalid endpoint URIs and skip sending the message.

ignoreInvalidEndpoint

public ToDynamicDefinition ignoreInvalidEndpoint(String ignoreInvalidEndpoint)

Whether to ignore invalid endpoint URIs and skip sending the message.

allowOptimisedComponents

public ToDynamicDefinition allowOptimisedComponents(boolean allowOptimisedComponents)

Whether to allow components to optimise toD if they are SendDynamicAware.

Returns:

the builder

allowOptimisedComponents

public ToDynamicDefinition allowOptimisedComponents(String allowOptimisedComponents)

Whether to allow components to optimise toD if they are SendDynamicAware.

Returns:

the builder

autoStartComponents

public ToDynamicDefinition autoStartComponents(String autoStartComponents)

Whether to auto startup components when toD is starting up.

Returns:

the builder

getUri

public String getUri()

setUri

public void setUri(String uri)

The uri of the endpoint to send to. The uri can be dynamic computed using the

invalid reference

org.apache.camel.language.simple.SimpleLanguage

expression.

getEndpointProducerBuilder

public EndpointProducerBuilder getEndpointProducerBuilder()

setEndpointProducerBuilder

public void setEndpointProducerBuilder(EndpointProducerBuilder endpointProducerBuilder)

getVariableSend

public String getVariableSend()

setVariableSend

public void setVariableSend(String variableSend)

getVariableReceive

public String getVariableReceive()

setVariableReceive

public void setVariableReceive(String variableReceive)

getPattern

public String getPattern()

setPattern

public void setPattern(String pattern)

getCacheSize

public String getCacheSize()

setCacheSize

public void setCacheSize(String cacheSize)

getIgnoreInvalidEndpoint

public String getIgnoreInvalidEndpoint()

setIgnoreInvalidEndpoint

public void setIgnoreInvalidEndpoint(String ignoreInvalidEndpoint)

getAllowOptimisedComponents

public String getAllowOptimisedComponents()

setAllowOptimisedComponents

public void setAllowOptimisedComponents(String allowOptimisedComponents)

getAutoStartComponents

public String getAutoStartComponents()

setAutoStartComponents

public void setAutoStartComponents(String autoStartComponents)