org.apache.camel.model

Class ThreadsDefinition

java.lang.Object

org.apache.camel.model.OptionalIdentifiedDefinition<Type>

org.apache.camel.model.ProcessorDefinition<Type>

org.apache.camel.model.OutputDefinition<ThreadsDefinition>

org.apache.camel.model.ThreadsDefinition

All Implemented Interfaces:

ExecutorServiceAware, Block, ExecutorServiceAwareDefinition<ThreadsDefinition>, OtherAttributesAware, NamedNode

@Metadata(label="eip,routing")
public class ThreadsDefinition
extends OutputDefinition<ThreadsDefinition>
implements ExecutorServiceAwareDefinition<ThreadsDefinition>

Specifies that all steps after this node are processed asynchronously

Version:

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

Constructors

Constructor and Description
ThreadsDefinition()

Method Summary

Modifier and Type	Method and Description
ThreadsDefinition	allowCoreThreadTimeOut(boolean allowCoreThreadTimeOut) Whether idle core threads is allowed to timeout and therefore can shrink the pool size below the core pool size Is by default false
ThreadsDefinition	callerRunsWhenRejected(boolean callerRunsWhenRejected) Whether or not to use as caller runs as fallback when a task is rejected being added to the thread pool (when its full).
Processor	createProcessor(RouteContext routeContext) Override this in definition class and implement logic to create the processor based on the definition model.
ThreadsDefinition	executorService(ExecutorService executorService) To use a custom thread pool
ThreadsDefinition	executorServiceRef(String executorServiceRef) To refer to a custom thread pool or use a thread pool profile (as overlay)
Boolean	getAllowCoreThreadTimeOut()
Boolean	getCallerRunsWhenRejected()
ExecutorService	getExecutorService() Gets the executor service
String	getExecutorServiceRef() Gets the reference to lookup in the Registry for the executor service to be used.
Long	getKeepAliveTime()
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
Integer	getMaxPoolSize()
Integer	getMaxQueueSize()
Integer	getPoolSize()
ThreadPoolRejectedPolicy	getRejectedPolicy()
String	getShortName() Returns a short name for this node which can be useful for ID generation or referring to related resources like images
String	getThreadName()
TimeUnit	getTimeUnit()
ThreadsDefinition	keepAliveTime(long keepAliveTime) Sets the keep alive time for idle threads
ThreadsDefinition	maxPoolSize(int maxPoolSize) Sets the maximum pool size
ThreadsDefinition	maxQueueSize(int maxQueueSize) Sets the maximum number of tasks in the work queue.
ThreadsDefinition	poolSize(int poolSize) Sets the core pool size
ThreadsDefinition	rejectedPolicy(ThreadPoolRejectedPolicy rejectedPolicy) Sets the handler for tasks which cannot be executed by the thread pool.
protected ThreadPoolRejectedPolicy	resolveRejectedPolicy(RouteContext routeContext)
void	setAllowCoreThreadTimeOut(Boolean allowCoreThreadTimeOut)
void	setCallerRunsWhenRejected(Boolean callerRunsWhenRejected)
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	setKeepAliveTime(Long keepAliveTime)
void	setMaxPoolSize(Integer maxPoolSize)
void	setMaxQueueSize(Integer maxQueueSize)
void	setPoolSize(Integer poolSize)
void	setRejectedPolicy(ThreadPoolRejectedPolicy rejectedPolicy)
void	setThreadName(String threadName)
void	setTimeUnit(TimeUnit timeUnit)
ThreadsDefinition	threadName(String threadName) Sets the thread name to use.
ThreadsDefinition	timeUnit(TimeUnit keepAliveTimeUnits) Sets the keep alive time unit.
String	toString()

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

getOutputs, isOutputSupported, setOutputs

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

addInterceptStrategies, addInterceptStrategy, addOutput, addRoutes, aggregate, aggregate, aggregate, aggregate, aop, attribute, bean, bean, bean, bean, bean, bean, bean, bean, beanRef, beanRef, beanRef, beanRef, beanRef, choice, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, configureChild, convertBodyTo, convertBodyTo, createChannel, createChildProcessor, createCompositeProcessor, createOutputsProcessor, createOutputsProcessor, createOutputsProcessorImpl, createProcessor, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, end, endChoice, endDoTry, endHystrix, endParent, endRest, enrich, enrich, enrich, enrich, enrich, enrichRef, enrichRef, enrichRef, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getIndex, getInterceptStrategies, getOtherAttributes, getParent, hystrix, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, isWrappingEntireOutput, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, loopDoWhile, makeProcessor, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onCompletion, onException, onException, pipeline, pipeline, pipeline, pipeline, placeholder, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichRef, pollEnrichRef, pollEnrichWith, pollEnrichWith, pollEnrichWith, preCreateProcessor, process, process, process, processRef, recipientList, recipientList, recipientList, recipientList, removeFaultHeader, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, resequence, resequence, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setBody, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setHeader, setInheritErrorHandler, setOtherAttributes, setOutHeader, setOutHeader, setParent, setProperty, setProperty, sort, sort, sort, split, split, split, startupOrder, stop, threads, threads, threads, threads, throttle, throttle, throttle, throttle, throttle, throwException, throwException, to, to, to, to, to, to, to, to, to, to, toD, toD, toD, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wrapChannel, wrapChannel, wrapInErrorHandler, wrapProcessor

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

description, description, getCustomId, getDescription, getDescriptionText, getId, hasCustomIdAssigned, idOrCreate, setCustomId, setDescription, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadsDefinition

public ThreadsDefinition()

Method Detail

createProcessor

public Processor createProcessor(RouteContext routeContext)
                          throws Exception

Description copied from class: ProcessorDefinition

Override this in definition class and implement logic to create the processor based on the definition model.

Overrides:

createProcessor in class ProcessorDefinition<ThreadsDefinition>

Throws:

Exception

resolveRejectedPolicy

protected ThreadPoolRejectedPolicy resolveRejectedPolicy(RouteContext routeContext)

getShortName

public String getShortName()

Description copied from interface: NamedNode

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

Specified by:

getShortName in interface NamedNode

Overrides:

getShortName in class OutputDefinition<ThreadsDefinition>

Returns:

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

getLabel

public String getLabel()

Description copied from class: ProcessorDefinition

Returns a label to describe this node such as the expression if some kind of expression node

Specified by:

getLabel in interface NamedNode

Overrides:

getLabel in class ProcessorDefinition<ThreadsDefinition>

toString

public String toString()

Overrides:

toString in class OutputDefinition<ThreadsDefinition>

executorService

public ThreadsDefinition executorService(ExecutorService executorService)

To use a custom thread pool

Specified by:

executorService in interface ExecutorServiceAwareDefinition<ThreadsDefinition>

Parameters:

executorService - the executor service

Returns:

the builder

executorServiceRef

public ThreadsDefinition executorServiceRef(String executorServiceRef)

To refer to a custom thread pool or use a thread pool profile (as overlay)

Specified by:

executorServiceRef in interface ExecutorServiceAwareDefinition<ThreadsDefinition>

Parameters:

executorServiceRef - reference for a ExecutorService to lookup in the Registry

Returns:

the builder

poolSize

public ThreadsDefinition poolSize(int poolSize)

Sets the core pool size

Parameters:

poolSize - the core pool size to keep minimum in the pool

Returns:

the builder

maxPoolSize

public ThreadsDefinition maxPoolSize(int maxPoolSize)

Sets the maximum pool size

Parameters:

maxPoolSize - the maximum pool size

Returns:

the builder

keepAliveTime

public ThreadsDefinition keepAliveTime(long keepAliveTime)

Sets the keep alive time for idle threads

Parameters:

keepAliveTime - keep alive time

Returns:

the builder

timeUnit

public ThreadsDefinition timeUnit(TimeUnit keepAliveTimeUnits)

Sets the keep alive time unit. By default SECONDS is used.

Parameters:

keepAliveTimeUnits - time unit

Returns:

the builder

maxQueueSize

public ThreadsDefinition maxQueueSize(int maxQueueSize)

Sets the maximum number of tasks in the work queue.

Use -1 or Integer.MAX_VALUE for an unbounded queue

Parameters:

maxQueueSize - the max queue size

Returns:

the builder

rejectedPolicy

public ThreadsDefinition rejectedPolicy(ThreadPoolRejectedPolicy rejectedPolicy)

Sets the handler for tasks which cannot be executed by the thread pool.

Parameters:

rejectedPolicy - the policy for the handler

Returns:

the builder

threadName

public ThreadsDefinition threadName(String threadName)

Sets the thread name to use.

Parameters:

threadName - the thread name

Returns:

the builder

callerRunsWhenRejected

public ThreadsDefinition callerRunsWhenRejected(boolean callerRunsWhenRejected)

Whether or not to use as caller runs as fallback when a task is rejected being added to the thread pool (when its full). This is only used as fallback if no rejectedPolicy has been configured, or the thread pool has no configured rejection handler.

Is by default true

Parameters:

callerRunsWhenRejected - whether or not the caller should run

Returns:

the builder

allowCoreThreadTimeOut

public ThreadsDefinition allowCoreThreadTimeOut(boolean allowCoreThreadTimeOut)

Whether idle core threads is allowed to timeout and therefore can shrink the pool size below the core pool size

Is by default false

Parameters:

allowCoreThreadTimeOut - true to allow timeout

Returns:

the builder

getExecutorService

public ExecutorService getExecutorService()

Description copied from interface: ExecutorServiceAware

Gets the executor service

Specified by:

getExecutorService in interface ExecutorServiceAware

Returns:

the executor

setExecutorService

public void setExecutorService(ExecutorService executorService)

Description copied from interface: ExecutorServiceAware

Sets the executor service to be used.

Specified by:

setExecutorService in interface ExecutorServiceAware

Parameters:

executorService - the executor

getExecutorServiceRef

public String getExecutorServiceRef()

Description copied from interface: ExecutorServiceAware

Gets the reference to lookup in the Registry for the executor service to be used.

Specified by:

getExecutorServiceRef in interface ExecutorServiceAware

Returns:

the reference, or null if the executor was set directly

setExecutorServiceRef

public void setExecutorServiceRef(String executorServiceRef)

Description copied from interface: ExecutorServiceAware

Sets a reference to lookup in the Registry for the executor service to be used.

Specified by:

setExecutorServiceRef in interface ExecutorServiceAware

Parameters:

executorServiceRef - reference for the executor

getPoolSize

public Integer getPoolSize()

setPoolSize

public void setPoolSize(Integer poolSize)

getMaxPoolSize

public Integer getMaxPoolSize()

setMaxPoolSize

public void setMaxPoolSize(Integer maxPoolSize)

getKeepAliveTime

public Long getKeepAliveTime()

setKeepAliveTime

public void setKeepAliveTime(Long keepAliveTime)

getTimeUnit

public TimeUnit getTimeUnit()

setTimeUnit

public void setTimeUnit(TimeUnit timeUnit)

getMaxQueueSize

public Integer getMaxQueueSize()

setMaxQueueSize

public void setMaxQueueSize(Integer maxQueueSize)

getThreadName

public String getThreadName()

setThreadName

public void setThreadName(String threadName)

getRejectedPolicy

public ThreadPoolRejectedPolicy getRejectedPolicy()

setRejectedPolicy

public void setRejectedPolicy(ThreadPoolRejectedPolicy rejectedPolicy)

getCallerRunsWhenRejected

public Boolean getCallerRunsWhenRejected()

setCallerRunsWhenRejected

public void setCallerRunsWhenRejected(Boolean callerRunsWhenRejected)

getAllowCoreThreadTimeOut

public Boolean getAllowCoreThreadTimeOut()

setAllowCoreThreadTimeOut

public void setAllowCoreThreadTimeOut(Boolean allowCoreThreadTimeOut)