org.apache.camel.model
Class MulticastDefinition

java.lang.Object
  extended by org.apache.camel.model.OptionalIdentifiedType<Type>
      extended by org.apache.camel.model.ProcessorDefinition<Type>
          extended by org.apache.camel.model.OutputDefinition<ProcessorDefinition>
              extended by org.apache.camel.model.MulticastDefinition
All Implemented Interfaces:
Block

public class MulticastDefinition
extends OutputDefinition<ProcessorDefinition>

Represents an XML <multicast/> element

Version:
$Revision: 750806 $

Field Summary
 
Fields inherited from class org.apache.camel.model.OutputDefinition
outputs
 
Fields inherited from class org.apache.camel.model.OptionalIdentifiedType
nodeCounters
 
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 executor(Executor executor)
          Setting the executor for executing the multicasting action.
 AggregationStrategy getAggregationStrategy()
           
 Executor getExecutor()
           
 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()
           
 MulticastDefinition parallelProcessing()
          use a thread pool to do the multicasting work
 MulticastDefinition parallelProcessing(boolean parallelProcessing)
          Set the multicasting action's thread model
 MulticastDefinition setAggregationStrategy(AggregationStrategy aggregationStrategy)
           
 void setExecutor(Executor executor)
           
 void setParallelProcessing(boolean parallelProcessing)
           
 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.OutputDefinition
configureChild, getOutputs, setOutputs
 
Methods inherited from class org.apache.camel.model.ProcessorDefinition
addInterceptor, addInterceptor, addOutput, addRoutes, aggregate, aggregate, aggregate, aggregate, aggregate, bean, bean, bean, bean, beanRef, beanRef, choice, clearOutput, convertBodyTo, convertBodyTo, createErrorHandlerBuilder, createOutputsProcessor, createOutputsProcessor, delay, delay, delay, delay, end, enrich, errorHandler, filter, filter, filter, filter, getErrorHandlerBuilder, getErrorHandlerRef, getInheritErrorHandlerFlag, getLabel, getNodeFactory, getParent, handleFault, idempotentConsumer, 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, resequence, resequence, resequence, resequencer, routingSlip, routingSlip, setBody, setBody, setErrorHandlerBuilder, setErrorHandlerBuilderIfNull, setErrorHandlerRef, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setInheritErrorHandlerFlag, setNodeFactory, setOutHeader, setOutHeader, setParent, setProperty, setProperty, sort, sort, sortBody, sortBody, split, split, split, stop, thread, thread, throttle, throwFault, throwFault, to, to, to, to, to, to, to, to, to, to, transform, transform, tryBlock, unmarshal, unmarshal, unmarshal, unmarshal, wireTap, wrapInErrorHandler, wrapProcessor
 
Methods inherited from class org.apache.camel.model.OptionalIdentifiedType
createId, description, getDescription, getId, getNodeCounter, 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: 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<ProcessorDefinition>
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()
use a thread pool to do the multicasting work

Returns:
the builder

parallelProcessing

public MulticastDefinition 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 MulticastDefinition executor(Executor executor)
Setting the executor 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)

getExecutor

public Executor getExecutor()

setExecutor

public void setExecutor(Executor executor)

wrapProcessorInInterceptors

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

Overrides:
wrapProcessorInInterceptors in class ProcessorDefinition<ProcessorDefinition>
Parameters:
routeContext - the route context
target - the processor which can be wrapped
Returns:
the original processor or a new wrapped interceptor
Throws:
Exception - can be thrown in case of error


Copyright © 2009 Apache Software Foundation. All Rights Reserved.