org.apache.camel.model
Class MulticastType

java.lang.Object
  extended by org.apache.camel.model.OptionalIdentifiedType<Type>
      extended by org.apache.camel.model.ProcessorType<Type>
          extended by org.apache.camel.model.OutputType<ProcessorType>
              extended by org.apache.camel.model.MulticastType
All Implemented Interfaces:
Block

public class MulticastType
extends OutputType<ProcessorType>

Represents an XML <multicast/> element

Version:
$Revision: 2063 $

Field Summary
 
Fields inherited from class org.apache.camel.model.OutputType
outputs
 
Fields inherited from class org.apache.camel.model.ProcessorType
DEFAULT_TRACE_CATEGORY
 
Fields inherited from class org.apache.camel.model.OptionalIdentifiedType
nodeCounters
 
Constructor Summary
MulticastType()
           
 
Method Summary
 MulticastType 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)
           
 MulticastType executor(ThreadPoolExecutor executor)
          Setting the executor for executing the multicasting action.
 AggregationStrategy getAggregationStrategy()
           
 String getShortName()
          Returns a short name for this node which can be useful for ID generation or referring to related resources like images
 ThreadPoolExecutor getThreadPoolExecutor()
           
 boolean isParallelProcessing()
           
 MulticastType parallelProcessing()
          Set to run the multicasting action parallely
 MulticastType parallelProcessing(boolean parallelProcessing)
          Set the multicasting action's thread model
 void setAggregationStrategy(AggregationStrategy aggregationStrategy)
           
 void setParallelProcessing(boolean parallelProcessing)
           
 void setThreadPoolExecutor(ThreadPoolExecutor executor)
           
 String toString()
           
protected  Processor wrapProcessorInInterceptors(RouteContext routeContext, Processor target)
          A strategy method which allows derived classes to wrap the child processor in some kind of interceptor
 
Methods inherited from class org.apache.camel.model.OutputType
configureChild, getOutputs, setOutputs
 
Methods inherited from class org.apache.camel.model.ProcessorType
addInterceptor, addInterceptor, addOutput, addRoutes, aggregator, aggregator, aggregator, aggregator, aggregator, bean, bean, bean, bean, beanRef, beanRef, choice, clearOutput, convertBodyTo, convertBodyTo, convertFaultBodyTo, convertOutBodyTo, createErrorHandlerBuilder, createOutputsProcessor, createOutputsProcessor, delayer, delayer, delayer, delayer, end, errorHandler, exception, filter, filter, filter, filter, getErrorHandlerBuilder, getErrorHandlerRef, getInheritErrorHandlerFlag, getLabel, getNodeFactory, getParent, handleFault, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, intercept, intercept, intercept, intercept, interceptor, interceptors, isInheritErrorHandler, isInheritErrorHandler, loadBalance, loop, loop, loop, makeProcessor, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onException, pipeline, pipeline, pipeline, policies, policy, popBlock, proceed, process, processRef, pushBlock, recipientList, recipientList, removeFaultHeader, removeHeader, removeProperty, resequencer, resequencer, resequencer, resequencer, routingSlip, routingSlip, routingSlip, setBody, setBody, setErrorHandlerBuilder, setErrorHandlerBuilderIfNull, setErrorHandlerRef, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setHeader, setInheritErrorHandlerFlag, setNodeFactory, setOutBody, setOutBody, setOutHeader, setOutHeader, setParent, setProperty, setProperty, splitter, splitter, splitter, splitter, splitter, splitter, splitter, splitter, splitter, splitter, splitter, splitter, stop, thread, thread, throttler, throwFault, throwFault, to, to, to, to, to, to, to, to, to, to, trace, trace, transform, transform, tryBlock, unmarshal, unmarshal, unmarshal, unmarshal, wrapInErrorHandler, wrapProcessor
 
Methods inherited from class org.apache.camel.model.OptionalIdentifiedType
createId, describe, description, description, getDescription, getId, getNodeCounter, id, idOrCreate, setDescription, setId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MulticastType

public MulticastType()
Method Detail

toString

public String toString()
Overrides:
toString in class Object

getShortName

public String getShortName()
Description copied from class: OptionalIdentifiedType
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 OptionalIdentifiedType<ProcessorType>
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 ProcessorType<ProcessorType>
Throws:
Exception

aggregationStrategy

public MulticastType aggregationStrategy(AggregationStrategy aggregationStrategy)
Set the multicasting aggregationStrategy

Parameters:
aggregationStrategy -
Returns:
the builder

parallelProcessing

public MulticastType parallelProcessing()
Set to run the multicasting action parallely

Returns:
the builder

parallelProcessing

public MulticastType parallelProcessing(boolean parallelProcessing)
Set the multicasting action's thread model

Parameters:
parallelProcessing - true to use a thread pool, if false then work is done in the calling thread
Returns:
the builder

executor

public MulticastType executor(ThreadPoolExecutor executor)
Setting the executor for executing the multicasting action.

Parameters:
executor - , it should be a instance of ThreadPoolExcutor NOTE in Camel 2.0 , it will change to use the instance which implements Executor interface
Returns:
the builder

createCompositeProcessor

protected Processor createCompositeProcessor(RouteContext routeContext,
                                             List<Processor> list)
Description copied from class: ProcessorType
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 ProcessorType<ProcessorType>

getAggregationStrategy

public AggregationStrategy getAggregationStrategy()

setAggregationStrategy

public void setAggregationStrategy(AggregationStrategy aggregationStrategy)

isParallelProcessing

public boolean isParallelProcessing()

setParallelProcessing

public void setParallelProcessing(boolean parallelProcessing)

getThreadPoolExecutor

public ThreadPoolExecutor getThreadPoolExecutor()

setThreadPoolExecutor

public void setThreadPoolExecutor(ThreadPoolExecutor executor)

wrapProcessorInInterceptors

protected Processor wrapProcessorInInterceptors(RouteContext routeContext,
                                                Processor target)
                                         throws Exception
Description copied from class: ProcessorType
A strategy method which allows derived classes to wrap the child processor in some kind of interceptor

Overrides:
wrapProcessorInInterceptors in class ProcessorType<ProcessorType>
target - the processor which can be wrapped
Returns:
the original processor or a new wrapped interceptor
Throws:
Exception


Copyright © 2010 IONA Open Source Community. All Rights Reserved.