org.apache.camel.model
Class MulticastDefinition

java.lang.Object
  org.apache.camel.model.OptionalIdentifiedDefinition
      org.apache.camel.model.ProcessorDefinition<Type>
          org.apache.camel.model.OutputDefinition<ProcessorDefinition>
              org.apache.camel.model.MulticastDefinition

All Implemented Interfaces:

Block

public class MulticastDefinition
extends OutputDefinition<ProcessorDefinition>

Represents an XML <multicast/> element

Version:

$Revision: 881198 $

Field Summary

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

outputs

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

errorHandlerBuilder, errorHandlerRef, log

Constructor Summary

MulticastDefinition()

Method Summary

MulticastDefinition	aggregationStrategy(AggregationStrategy aggregationStrategy) Set the multicasting 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)
MulticastDefinition	executorService(ExecutorService executorService) Setting the executor service for executing the multicasting action.
AggregationStrategy	getAggregationStrategy()
ExecutorService	getExecutorService()
String	getShortName() Returns a short name for this node which can be useful for ID generation or referring to related resources like images
boolean	isParallelProcessing()
Boolean	isStopOnException()
boolean	isStreaming()
MulticastDefinition	parallelProcessing() Uses the ExecutorService to do the multicasting work
MulticastDefinition	setAggregationStrategy(AggregationStrategy aggregationStrategy)
void	setExecutorService(ExecutorService executorService)
void	setParallelProcessing(boolean parallelProcessing)
void	setStopOnException(Boolean stopOnException)
void	setStreaming(boolean streaming)
MulticastDefinition	stopOnException() Will now stop further processing if an exception occurred during processing of an Exchange and the caused exception will be thrown.
MulticastDefinition	streaming() Aggregates the responses as the are done (e.g.
String	toString()

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

getOutputs, setOutputs

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

addInterceptStrategies, addInterceptStrategy, addOutput, addRoutes, aggregate, aggregate, aggregate, aggregate, aggregate, aop, bean, bean, bean, bean, beanRef, beanRef, choice, clearOutput, configureChild, convertBodyTo, convertBodyTo, createChannel, createErrorHandlerBuilder, createOutputsProcessor, createOutputsProcessor, delay, delay, delay, doTry, end, enrich, enrich, enrichRef, filter, filter, filter, filter, getErrorHandlerBuilder, getInterceptStrategies, getLabel, getNodeFactory, getParent, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, loadBalance, loadBalance, loop, loop, loop, makeProcessor, markRollbackOnly, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onCompletion, onException, pipeline, pipeline, pipeline, pipeline, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichRef, process, processRef, recipientList, recipientList, recipientList, removeFaultHeader, removeHeader, removeProperty, resequence, resequence, resequence, resequencer, rollback, rollback, routeId, routingSlip, routingSlip, sample, sample, setBody, setBody, setErrorHandlerBuilder, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setNodeFactory, setOutHeader, setOutHeader, setParent, setProperty, setProperty, sort, sort, sortBody, sortBody, split, split, split, stop, threads, threads, throttle, throwException, to, to, to, to, to, to, to, to, to, to, toAsync, toAsync, toAsync, toAsync, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, wireTap, wireTap, wireTap, wrapChannel, wrapProcessor

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

description, getDescription, getId, hasCustomIdAssigned, idOrCreate, setDescription, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MulticastDefinition

public MulticastDefinition()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getShortName

public String getShortName()

Description copied from class: OptionalIdentifiedDefinition

Returns a short name for this node which can be useful for ID generation or referring to related resources like images

Overrides:

getShortName in class OptionalIdentifiedDefinition

Returns:

defaults to "node" but derived nodes should overload this to provide a unique name

createProcessor

public Processor createProcessor(RouteContext routeContext)
                          throws Exception

Overrides:

createProcessor in class ProcessorDefinition<ProcessorDefinition>

Throws:

Exception

aggregationStrategy

public MulticastDefinition aggregationStrategy(AggregationStrategy aggregationStrategy)

Set the multicasting aggregationStrategy

Returns:

the builder

parallelProcessing

public MulticastDefinition parallelProcessing()

Uses the ExecutorService to do the multicasting work

Returns:

the builder

streaming

public MulticastDefinition streaming()

Aggregates the responses as the are done (e.g. out of order sequence)

Returns:

the builder

stopOnException

public MulticastDefinition stopOnException()

Will now stop further processing if an exception occurred during processing of an Exchange and the caused exception will be thrown.

The default behavior is to not stop but continue processing till the end

Returns:

the builder

executorService

public MulticastDefinition executorService(ExecutorService executorService)

Setting the executor service for executing the multicasting action.

Returns:

the builder

createCompositeProcessor

protected Processor createCompositeProcessor(RouteContext routeContext,
                                             List<Processor> list)

Description copied from class: ProcessorDefinition

Creates a new instance of some kind of composite processor which defaults to using a Pipeline but derived classes could change the behaviour

Overrides:

createCompositeProcessor in class ProcessorDefinition<ProcessorDefinition>

getAggregationStrategy

public AggregationStrategy getAggregationStrategy()

setAggregationStrategy

public MulticastDefinition setAggregationStrategy(AggregationStrategy aggregationStrategy)

isParallelProcessing

public boolean isParallelProcessing()

setParallelProcessing

public void setParallelProcessing(boolean parallelProcessing)

isStreaming

public boolean isStreaming()

setStreaming

public void setStreaming(boolean streaming)

isStopOnException

public Boolean isStopOnException()

setStopOnException

public void setStopOnException(Boolean stopOnException)

getExecutorService

public ExecutorService getExecutorService()

setExecutorService

public void setExecutorService(ExecutorService executorService)