Package org.apache.camel.model
Class ToDynamicDefinition
- java.lang.Object
-
- org.apache.camel.model.OptionalIdentifiedDefinition<Type>
-
- org.apache.camel.model.ProcessorDefinition<Type>
-
- 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.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
inheritErrorHandler
-
-
Constructor Summary
Constructors Constructor Description ToDynamicDefinition()
ToDynamicDefinition(String uri)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ToDynamicDefinition
allowOptimisedComponents(boolean allowOptimisedComponents)
Whether to allow components to optimise toD if they areSendDynamicAware
.ToDynamicDefinition
allowOptimisedComponents(String allowOptimisedComponents)
Whether to allow components to optimise toD if they areSendDynamicAware
.ToDynamicDefinition
autoStartComponents(String autoStartComponents)
Whether to auto startup components when toD is starting up.ToDynamicDefinition
cacheSize(int cacheSize)
Sets the maximum size used by theProducerCache
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 theProducerCache
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 nodeString
getPattern()
String
getShortName()
String
getUri()
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 optionalExchangePattern
used to invoke this endpointToDynamicDefinition
pattern(org.apache.camel.ExchangePattern pattern)
Sets the optionalExchangePattern
used to invoke this endpointvoid
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.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.-
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, delay, delay, delay, 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, getIndex, getInterceptStrategies, getParent, getRouteConfiguration, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, 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, onCompletion, onException, onException, pausable, pausable, pausable, pausable, pipeline, 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, resequence, resequence, resumable, resumable, resumable, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setExchangePattern, setExchangePattern, setHeader, setHeader, setHeader, setInheritErrorHandler, setParent, setProperty, setProperty, setProperty, setRouteConfiguration, 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, to, to, toD, toD, toD, toD, toD, toD, toD, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap
-
Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition
description, description, getCamelContext, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, hasCustomIdAssigned, idOrCreate, setCamelContext, setCustomId, setDescription, setGeneratedId, setId, setLineNumber, setLocation
-
-
-
-
Field Detail
-
endpointProducerBuilder
protected EndpointProducerBuilder endpointProducerBuilder
-
-
Constructor Detail
-
ToDynamicDefinition
public ToDynamicDefinition()
-
ToDynamicDefinition
public ToDynamicDefinition(String uri)
-
-
Method Detail
-
getShortName
public String getShortName()
-
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 interfaceorg.apache.camel.NamedNode
- Overrides:
getLabel
in classProcessorDefinition<ToDynamicDefinition>
-
uri
public ToDynamicDefinition uri(@AsEndpointUri String uri)
The uri of the endpoint to send to. The uri can be dynamic computed using theorg.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)
-
pattern
public ToDynamicDefinition pattern(org.apache.camel.ExchangePattern pattern)
Sets the optionalExchangePattern
used to invoke this endpoint
-
pattern
public ToDynamicDefinition pattern(String pattern)
Sets the optionalExchangePattern
used to invoke this endpoint
-
cacheSize
public ToDynamicDefinition cacheSize(int cacheSize)
Sets the maximum size used by theProducerCache
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 of 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 theProducerCache
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 of 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 areSendDynamicAware
.- Returns:
- the builder
-
allowOptimisedComponents
public ToDynamicDefinition allowOptimisedComponents(String allowOptimisedComponents)
Whether to allow components to optimise toD if they areSendDynamicAware
.- 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 theorg.apache.camel.language.simple.SimpleLanguage
expression.
-
getEndpointProducerBuilder
public EndpointProducerBuilder getEndpointProducerBuilder()
-
setEndpointProducerBuilder
public void setEndpointProducerBuilder(EndpointProducerBuilder endpointProducerBuilder)
-
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)
-
-