org.apache.camel.model
Class RecipientListDefinition

java.lang.Object
  extended by org.apache.camel.model.OptionalIdentifiedDefinition
      extended by org.apache.camel.model.ProcessorDefinition<ExpressionNode>
          extended by org.apache.camel.model.ExpressionNode
              extended by org.apache.camel.model.RecipientListDefinition
All Implemented Interfaces:
Block

public class RecipientListDefinition
extends ExpressionNode

Represents an XML <recipientList/> element

Version:
$Revision: 16981 $

Field Summary
 
Fields inherited from class org.apache.camel.model.ProcessorDefinition
errorHandlerBuilder, errorHandlerRef, log
 
Constructor Summary
RecipientListDefinition()
           
RecipientListDefinition(Expression expression)
           
RecipientListDefinition(ExpressionDefinition expression)
           
 
Method Summary
 void addOutput(ProcessorDefinition processorType)
          Adds the given definition as output to this block
 RecipientListDefinition aggregationStrategy(AggregationStrategy aggregationStrategy)
          Set the aggregationStrategy
 Processor createProcessor(RouteContext routeContext)
           
 RecipientListDefinition executorService(ExecutorService executorService)
          Setting the executor service for executing the sending to the recipients.
 AggregationStrategy getAggregationStrategy()
           
 String getDelimiter()
           
 ExecutorService getExecutorService()
           
 String getExecutorServiceRef()
           
 List<ProcessorDefinition> getOutputs()
           
 String getShortName()
          Returns a short name for this node which can be useful for ID generation or referring to related resources like images
 String getStrategyRef()
           
 Boolean isParallelProcessing()
           
 Boolean isStopOnException()
           
 RecipientListDefinition parallelProcessing()
          Doing the splitting work in parallel
 void setAggregationStrategy(AggregationStrategy aggregationStrategy)
           
 void setDelimiter(String delimiter)
           
 void setExecutorService(ExecutorService executorService)
           
 void setExecutorServiceRef(String executorServiceRef)
           
 void setParallelProcessing(Boolean parallelProcessing)
           
 void setStopOnException(Boolean stopOnException)
           
 void setStrategyRef(String strategyRef)
           
 RecipientListDefinition stopOnException()
          Will now stop further processing if an exception occurred during processing of an Exchange and the caused exception will be thrown.
 String toString()
           
 
Methods inherited from class org.apache.camel.model.ExpressionNode
createFilterProcessor, getExpression, getLabel, setExpression, setOutputs
 
Methods inherited from class org.apache.camel.model.ProcessorDefinition
addInterceptStrategies, addInterceptStrategy, addRoutes, aggregate, aggregate, aggregate, aggregate, aggregate, aop, bean, bean, bean, bean, beanRef, beanRef, choice, clearOutput, configureChild, convertBodyTo, convertBodyTo, createChannel, createCompositeProcessor, createErrorHandlerBuilder, createOutputsProcessor, createOutputsProcessor, delay, delay, delay, doTry, end, enrich, enrich, enrichRef, filter, filter, filter, filter, getErrorHandlerBuilder, getInterceptStrategies, getNodeFactory, getParent, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, isAbstract, loadBalance, loadBalance, log, log, log, loop, loop, loop, makeProcessor, markRollbackOnly, markRollbackOnlyLast, 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, wrapInErrorHandler, 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

RecipientListDefinition

public RecipientListDefinition()

RecipientListDefinition

public RecipientListDefinition(ExpressionDefinition expression)

RecipientListDefinition

public RecipientListDefinition(Expression expression)
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 ExpressionNode
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<ExpressionNode>
Throws:
Exception

getOutputs

public List<ProcessorDefinition> getOutputs()
Overrides:
getOutputs in class ExpressionNode

addOutput

public void addOutput(ProcessorDefinition processorType)
Description copied from interface: Block
Adds the given definition as output to this block

Specified by:
addOutput in interface Block
Overrides:
addOutput in class ProcessorDefinition<ExpressionNode>
Parameters:
processorType - the processor definition

aggregationStrategy

public RecipientListDefinition aggregationStrategy(AggregationStrategy aggregationStrategy)
Set the aggregationStrategy

Returns:
the builder

parallelProcessing

public RecipientListDefinition parallelProcessing()
Doing the splitting work in parallel

Returns:
the builder

stopOnException

public RecipientListDefinition 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 RecipientListDefinition executorService(ExecutorService executorService)
Setting the executor service for executing the sending to the recipients.

Parameters:
executorService - the executor service
Returns:
the builder

getDelimiter

public String getDelimiter()

setDelimiter

public void setDelimiter(String delimiter)

isParallelProcessing

public Boolean isParallelProcessing()

setParallelProcessing

public void setParallelProcessing(Boolean parallelProcessing)

getStrategyRef

public String getStrategyRef()

setStrategyRef

public void setStrategyRef(String strategyRef)

getExecutorServiceRef

public String getExecutorServiceRef()

setExecutorServiceRef

public void setExecutorServiceRef(String executorServiceRef)

isStopOnException

public Boolean isStopOnException()

setStopOnException

public void setStopOnException(Boolean stopOnException)

getAggregationStrategy

public AggregationStrategy getAggregationStrategy()

setAggregationStrategy

public void setAggregationStrategy(AggregationStrategy aggregationStrategy)

getExecutorService

public ExecutorService getExecutorService()

setExecutorService

public void setExecutorService(ExecutorService executorService)


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