|
||||||||||
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<Type> org.apache.camel.model.OutputDefinition<MulticastDefinition> org.apache.camel.model.MulticastDefinition
public class MulticastDefinition
Represents an XML <multicast/> element
Field Summary |
---|
Fields inherited from class org.apache.camel.model.OutputDefinition |
---|
outputs |
Fields inherited from class org.apache.camel.model.ProcessorDefinition |
---|
inheritErrorHandler, log |
Constructor Summary | |
---|---|
MulticastDefinition()
|
Method Summary | |
---|---|
MulticastDefinition |
aggregationStrategy(AggregationStrategy aggregationStrategy)
Set the multicasting aggregationStrategy |
MulticastDefinition |
aggregationStrategyRef(String aggregationStrategyRef)
Set the aggregationStrategy |
protected Processor |
createCompositeProcessor(RouteContext routeContext,
List<Processor> list)
Creates a new instance of some kind of composite processor which defaults to using a Pipeline but derived classes could change the behaviour |
Processor |
createProcessor(RouteContext routeContext)
Override this in definition class and implement logic to create the processor based on the definition model. |
MulticastDefinition |
executorService(ExecutorService executorService)
Setting the executor service for executing |
MulticastDefinition |
executorServiceRef(String executorServiceRef)
Setting the executor service for executing |
AggregationStrategy |
getAggregationStrategy()
|
ExecutorService |
getExecutorService()
Gets the executor service |
String |
getExecutorServiceRef()
Gets the reference to lookup in the Registry for the executor service to be used. |
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()
|
boolean |
isParallelProcessing()
|
boolean |
isShareUnitOfWork()
|
Boolean |
isStopOnException()
|
boolean |
isStreaming()
|
MulticastDefinition |
onPrepare(Processor onPrepare)
Uses the Processor when preparing the Exchange to be send. |
MulticastDefinition |
onPrepareRef(String onPrepareRef)
Uses the Processor when preparing the Exchange to be send. |
MulticastDefinition |
parallelProcessing()
Uses the ExecutorService to do the multicasting work |
MulticastDefinition |
setAggregationStrategy(AggregationStrategy aggregationStrategy)
|
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 |
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)
|
MulticastDefinition |
shareUnitOfWork()
Shares the UnitOfWork with the parent and each of the sub messages. |
MulticastDefinition |
stopOnException()
Will now stop further processing if an exception or failure occurred during processing of an Exchange and the caused exception will be thrown. |
MulticastDefinition |
streaming()
Aggregates the responses as the are done (e.g. |
MulticastDefinition |
timeout(long timeout)
Sets a timeout value in millis to use when using parallelProcessing. |
String |
toString()
|
Methods inherited from class org.apache.camel.model.OutputDefinition |
---|
getOutputs, isOutputSupported, 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 MulticastDefinition()
Method Detail |
---|
public String toString()
toString
in class OutputDefinition<MulticastDefinition>
public String getLabel()
ProcessorDefinition
getLabel
in class ProcessorDefinition<MulticastDefinition>
public String getShortName()
OptionalIdentifiedDefinition
getShortName
in interface NamedNode
getShortName
in class OutputDefinition<MulticastDefinition>
public Processor createProcessor(RouteContext routeContext) throws Exception
ProcessorDefinition
createProcessor
in class ProcessorDefinition<MulticastDefinition>
Exception
public MulticastDefinition aggregationStrategy(AggregationStrategy aggregationStrategy)
public MulticastDefinition aggregationStrategyRef(String aggregationStrategyRef)
aggregationStrategyRef
- a reference to a strategy to lookup
public MulticastDefinition parallelProcessing()
ExecutorService
to do the multicasting work
public MulticastDefinition streaming()
public MulticastDefinition 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 multicast 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 MulticastDefinition executorService(ExecutorService executorService)
ExecutorServiceAwareDefinition
executorService
in interface ExecutorServiceAwareDefinition<MulticastDefinition>
executorService
- the executor service
public MulticastDefinition executorServiceRef(String executorServiceRef)
ExecutorServiceAwareDefinition
executorServiceRef
in interface ExecutorServiceAwareDefinition<MulticastDefinition>
executorServiceRef
- reference for a ExecutorService
to lookup in the Registry
public MulticastDefinition onPrepare(Processor onPrepare)
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.
onPrepare
- the processor
public MulticastDefinition 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 MulticastDefinition timeout(long timeout)
timeout
- timeout in millis
public MulticastDefinition shareUnitOfWork()
UnitOfWork
with the parent and each of the sub messages.
SubUnitOfWork
protected Processor createCompositeProcessor(RouteContext routeContext, List<Processor> list) throws Exception
ProcessorDefinition
Pipeline
but derived classes could change the behaviour
createCompositeProcessor
in class ProcessorDefinition<MulticastDefinition>
Exception
public AggregationStrategy getAggregationStrategy()
public MulticastDefinition setAggregationStrategy(AggregationStrategy aggregationStrategy)
public Boolean getParallelProcessing()
public void setParallelProcessing(Boolean parallelProcessing)
public boolean isParallelProcessing()
public Boolean getStreaming()
public void setStreaming(Boolean streaming)
public boolean isStreaming()
public Boolean getStopOnException()
public void setStopOnException(Boolean stopOnException)
public Boolean isStopOnException()
public ExecutorService getExecutorService()
ExecutorServiceAware
getExecutorService
in interface ExecutorServiceAware
public void setExecutorService(ExecutorService executorService)
ExecutorServiceAware
setExecutorService
in interface ExecutorServiceAware
executorService
- the executorpublic 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 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 |