|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.camel.model.OptionalIdentifiedDefinition<Type> org.apache.camel.model.ProcessorDefinition<ExpressionNode> org.apache.camel.model.ExpressionNode org.apache.camel.model.NoOutputExpressionNode org.apache.camel.model.RecipientListDefinition<Type>
public class RecipientListDefinition<Type extends ProcessorDefinition<Type>>
Represents an XML <recipientList/> element
Field Summary |
---|
Fields inherited from class org.apache.camel.model.ProcessorDefinition |
---|
inheritErrorHandler, log |
Constructor Summary | |
---|---|
RecipientListDefinition()
|
|
RecipientListDefinition(Expression expression)
|
|
RecipientListDefinition(ExpressionDefinition expression)
|
Method Summary | |
---|---|
RecipientListDefinition<Type> |
aggregationStrategy(AggregationStrategy aggregationStrategy)
Set the aggregationStrategy |
RecipientListDefinition<Type> |
aggregationStrategyRef(String aggregationStrategyRef)
Set the aggregationStrategy |
Processor |
createProcessor(RouteContext routeContext)
Override this in definition class and implement logic to create the processor based on the definition model. |
RecipientListDefinition<Type> |
delimiter(String delimiter)
Set the delimiter |
Type |
end()
Ends the current block |
RecipientListDefinition<Type> |
executorService(ExecutorService executorService)
Setting the executor service for executing |
RecipientListDefinition<Type> |
executorServiceRef(String executorServiceRef)
Setting the executor service for executing |
AggregationStrategy |
getAggregationStrategy()
|
String |
getDelimiter()
|
ExecutorService |
getExecutorService()
Gets the executor service |
String |
getExecutorServiceRef()
Gets the reference to lookup in the Registry for the executor service to be used. |
Boolean |
getIgnoreInvalidEndpoints()
|
String |
getLabel()
Returns a label to describe this node such as the expression if some kind of expression node |
Processor |
getOnPrepare()
|
String |
getOnPrepareRef()
|
Boolean |
getParallelProcessing()
|
Boolean |
getShareUnitOfWork()
|
String |
getShortName()
Returns a short name for this node which can be useful for ID generation or referring to related resources like images |
Boolean |
getStopOnException()
|
String |
getStrategyRef()
|
Boolean |
getStreaming()
|
Long |
getTimeout()
|
RecipientListDefinition<Type> |
ignoreInvalidEndpoints()
Ignore the invalidate endpoint exception when try to create a producer with that endpoint |
boolean |
isIgnoreInvalidEndpoints()
|
boolean |
isParallelProcessing()
|
boolean |
isShareUnitOfWork()
|
boolean |
isStopOnException()
|
boolean |
isStreaming()
|
RecipientListDefinition<Type> |
onPrepare(Processor onPrepare)
Uses the Processor when preparing the Exchange to be used send. |
RecipientListDefinition<Type> |
onPrepareRef(String onPrepareRef)
Uses the Processor when preparing the Exchange to be send. |
RecipientListDefinition<Type> |
parallelProcessing()
Doing the recipient list work in parallel |
void |
setAggregationStrategy(AggregationStrategy aggregationStrategy)
|
void |
setDelimiter(String delimiter)
|
void |
setExecutorService(ExecutorService executorService)
Sets the executor service to be used. |
void |
setExecutorServiceRef(String executorServiceRef)
Sets a reference to lookup in the Registry for the executor service to be used. |
void |
setIgnoreInvalidEndpoints(Boolean ignoreInvalidEndpoints)
|
void |
setOnPrepare(Processor onPrepare)
|
void |
setOnPrepareRef(String onPrepareRef)
|
void |
setParallelProcessing(Boolean parallelProcessing)
|
void |
setShareUnitOfWork(Boolean shareUnitOfWork)
|
void |
setStopOnException(Boolean stopOnException)
|
void |
setStrategyRef(String strategyRef)
|
void |
setStreaming(Boolean streaming)
|
void |
setTimeout(Long timeout)
|
RecipientListDefinition<Type> |
shareUnitOfWork()
Shares the UnitOfWork with the parent and each of the sub messages. |
RecipientListDefinition<Type> |
stopOnException()
Will now stop further processing if an exception or failure occurred during processing of an Exchange and the caused exception will be thrown. |
RecipientListDefinition<Type> |
streaming()
Doing the recipient list work in streaming model |
RecipientListDefinition<Type> |
timeout(long timeout)
Sets a timeout value in millis to use when using parallelProcessing. |
String |
toString()
|
Methods inherited from class org.apache.camel.model.NoOutputExpressionNode |
---|
addOutput, getOutputs, id, isOutputSupported |
Methods inherited from class org.apache.camel.model.ExpressionNode |
---|
configureChild, createFilterProcessor, createPredicate, getExpression, preCreateProcessor, setExpression, setOutputs |
Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition |
---|
description, getDescription, getDescriptionText, getId, hasCustomIdAssigned, idOrCreate, setDescription, setId |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public RecipientListDefinition()
public RecipientListDefinition(ExpressionDefinition expression)
public RecipientListDefinition(Expression expression)
Method Detail |
---|
public String toString()
toString
in class Object
public String getShortName()
OptionalIdentifiedDefinition
getShortName
in interface NamedNode
getShortName
in class ExpressionNode
public String getLabel()
ProcessorDefinition
getLabel
in class ExpressionNode
public Processor createProcessor(RouteContext routeContext) throws Exception
ProcessorDefinition
createProcessor
in class ProcessorDefinition<ExpressionNode>
Exception
public Type end()
ProcessorDefinition
end
in class ProcessorDefinition<ExpressionNode>
public RecipientListDefinition<Type> delimiter(String delimiter)
delimiter
- the delimiter
public RecipientListDefinition<Type> aggregationStrategy(AggregationStrategy aggregationStrategy)
aggregationStrategy
- the strategy
public RecipientListDefinition<Type> aggregationStrategyRef(String aggregationStrategyRef)
aggregationStrategyRef
- a reference to a strategy to lookup
public RecipientListDefinition<Type> ignoreInvalidEndpoints()
public RecipientListDefinition<Type> parallelProcessing()
public RecipientListDefinition<Type> streaming()
public RecipientListDefinition<Type> stopOnException()
Exchange
and the caused exception will be thrown.
Will also stop if processing the exchange failed (has a fault message) or an exception
was thrown and handled by the error handler (such as using onException). In all situations
the recipient list will stop further processing. This is the same behavior as in pipeline, which
is used by the routing engine.
The default behavior is to not stop but continue processing till the end
public RecipientListDefinition<Type> executorService(ExecutorService executorService)
ExecutorServiceAwareDefinition
executorService
in interface ExecutorServiceAwareDefinition<RecipientListDefinition<Type extends ProcessorDefinition<Type>>>
executorService
- the executor service
public RecipientListDefinition<Type> executorServiceRef(String executorServiceRef)
ExecutorServiceAwareDefinition
executorServiceRef
in interface ExecutorServiceAwareDefinition<RecipientListDefinition<Type extends ProcessorDefinition<Type>>>
executorServiceRef
- reference for a ExecutorService
to lookup in the Registry
public RecipientListDefinition<Type> onPrepare(Processor onPrepare)
Processor
when preparing the Exchange
to be used send.
This can be used to deep-clone messages that should be send, or any custom logic needed before
the exchange is send.
onPrepare
- the processor
public RecipientListDefinition<Type> onPrepareRef(String onPrepareRef)
Processor
when preparing the Exchange
to be send.
This can be used to deep-clone messages that should be send, or any custom logic needed before
the exchange is send.
onPrepareRef
- reference to the processor to lookup in the Registry
public RecipientListDefinition<Type> timeout(long timeout)
timeout
- timeout in millis
public RecipientListDefinition<Type> shareUnitOfWork()
UnitOfWork
with the parent and each of the sub messages.
SubUnitOfWork
public String getDelimiter()
public void setDelimiter(String delimiter)
public Boolean getParallelProcessing()
public void setParallelProcessing(Boolean parallelProcessing)
public boolean isParallelProcessing()
public String getStrategyRef()
public void setStrategyRef(String strategyRef)
public String getExecutorServiceRef()
ExecutorServiceAware
Registry
for the executor service to be used.
getExecutorServiceRef
in interface ExecutorServiceAware
public void setExecutorServiceRef(String executorServiceRef)
ExecutorServiceAware
Registry
for the executor service to be used.
setExecutorServiceRef
in interface ExecutorServiceAware
executorServiceRef
- reference for the executorpublic Boolean getIgnoreInvalidEndpoints()
public void setIgnoreInvalidEndpoints(Boolean ignoreInvalidEndpoints)
public boolean isIgnoreInvalidEndpoints()
public Boolean getStopOnException()
public void setStopOnException(Boolean stopOnException)
public boolean isStopOnException()
public AggregationStrategy getAggregationStrategy()
public void setAggregationStrategy(AggregationStrategy aggregationStrategy)
public ExecutorService getExecutorService()
ExecutorServiceAware
getExecutorService
in interface ExecutorServiceAware
public void setExecutorService(ExecutorService executorService)
ExecutorServiceAware
setExecutorService
in interface ExecutorServiceAware
executorService
- the executorpublic Boolean getStreaming()
public void setStreaming(Boolean streaming)
public boolean isStreaming()
public Long getTimeout()
public void setTimeout(Long timeout)
public String getOnPrepareRef()
public void setOnPrepareRef(String onPrepareRef)
public Processor getOnPrepare()
public void setOnPrepare(Processor onPrepare)
public Boolean getShareUnitOfWork()
public void setShareUnitOfWork(Boolean shareUnitOfWork)
public boolean isShareUnitOfWork()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |