Package org.apache.camel.model

Class DelayDefinition

java.lang.Object

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

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

org.apache.camel.model.ExpressionNode

org.apache.camel.model.DelayDefinition

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.LineNumberAware, Block, ExecutorServiceAwareDefinition<DelayDefinition>, HasExpressionType, org.apache.camel.NamedNode, org.apache.camel.spi.HasId, org.apache.camel.spi.IdAware

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

Delays processing for a specified length of time

Field Summary

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

disabled, inheritErrorHandler

Constructor Summary

Constructors

Constructor	Description
DelayDefinition()
DelayDefinition(org.apache.camel.Expression delay)

Method Summary

Modifier and Type	Method	Description
DelayDefinition	asyncDelayed()	Enables asynchronous delay which means the thread will not block while delaying.
DelayDefinition	asyncDelayed(String asyncDelayed)	Enables asynchronous delay which means the thread will not block while delaying.
DelayDefinition	callerRunsWhenRejected(boolean callerRunsWhenRejected)	Whether or not the caller should run the task when it was rejected by the thread pool.
DelayDefinition	callerRunsWhenRejected(String callerRunsWhenRejected)	Whether or not the caller should run the task when it was rejected by the thread pool.
DelayDefinition	delayTime(Long delay)	Sets the delay time in millis to delay
DelayDefinition	executorService(String executorService)	Refers to a custom Thread Pool if asyncDelay has been enabled.
DelayDefinition	executorService(ExecutorService executorService)	To use a custom Thread Pool if asyncDelay has been enabled.
String	getAsyncDelayed()
String	getCallerRunsWhenRejected()
String	getExecutorService()
ExecutorService	getExecutorServiceBean()	Gets the executor service for executing
String	getExecutorServiceRef()	Gets a reference id to lookup the executor service from the registry
String	getLabel()	Returns a label to describe this node such as the expression if some kind of expression node
String	getShortName()
void	setAsyncDelayed(String asyncDelayed)
void	setCallerRunsWhenRejected(String callerRunsWhenRejected)
void	setExecutorService(String executorService)
void	setExpression(ExpressionDefinition expression)	Expression to define how long time to wait (in millis)
DelayDefinition	syncDelayed()	Enables asynchronous delay which means the thread will not block while delaying.
String	toString()

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

configureChild, getExpression, getExpressionType, getOutputs, id, preCreateProcessor, setExpression, setExpressionType

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

addInterceptStrategy, addOutput, aggregate, aggregate, aggregate, aggregate, bean, bean, bean, bean, bean, bean, bean, bean, bean, bean, bean, choice, circuitBreaker, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, convertBodyTo, convertBodyTo, convertBodyTo, delay, delay, delay, disabled, disabled, disabled, doTry, dynamicRouter, dynamicRouter, end, endChoice, endCircuitBreaker, endDoCatch, endDoTry, endParent, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getDisabled, getIndex, getInterceptStrategies, getParent, getRouteConfiguration, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, isWrappingEntireOutput, kamelet, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, loopDoWhile, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, nodePrefixId, onCompletion, onException, onException, pausable, pausable, pausable, pausable, pipeline, pipeline, pipeline, pipeline, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, process, process, process, recipientList, recipientList, recipientList, recipientList, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, resequence, resequence, resumable, resumable, resumable, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setDisabled, setExchangePattern, setExchangePattern, setHeader, setHeader, setHeader, setInheritErrorHandler, setParent, setProperty, setProperty, setProperty, setRouteConfiguration, sort, sort, sort, split, split, split, split, startupOrder, step, step, stop, threads, threads, threads, threads, throttle, throttle, throttle, throttle, throttle, throwException, throwException, to, to, to, to, to, to, to, to, to, to, to, to, to, to, toD, toD, toD, toD, toD, toD, toD, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap

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

description, description, getCamelContext, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, hasCustomIdAssigned, idOrCreate, setCamelContext, setCustomId, setDescription, setGeneratedId, setId, setLineNumber, setLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

DelayDefinition

public DelayDefinition()

DelayDefinition

public DelayDefinition(org.apache.camel.Expression delay)

Method Detail

getShortName

public String getShortName()

Specified by:

getShortName in interface org.apache.camel.NamedNode

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 org.apache.camel.NamedNode

Overrides:

getLabel in class ExpressionNode

toString

public String toString()

Overrides:

toString in class Object

delayTime

public DelayDefinition delayTime(Long delay)

Sets the delay time in millis to delay

Parameters:

delay - delay time in millis

Returns:

the builder

callerRunsWhenRejected

public DelayDefinition callerRunsWhenRejected(boolean callerRunsWhenRejected)

Whether or not the caller should run the task when it was rejected by the thread pool.

Is by default true

Parameters:

callerRunsWhenRejected - whether or not the caller should run

Returns:

the builder

callerRunsWhenRejected

public DelayDefinition callerRunsWhenRejected(String callerRunsWhenRejected)

Whether or not the caller should run the task when it was rejected by the thread pool.

Is by default true

Parameters:

callerRunsWhenRejected - whether or not the caller should run

Returns:

the builder

asyncDelayed

public DelayDefinition asyncDelayed()

Enables asynchronous delay which means the thread will not block while delaying.

asyncDelayed

public DelayDefinition asyncDelayed(String asyncDelayed)

Enables asynchronous delay which means the thread will not block while delaying.

syncDelayed

public DelayDefinition syncDelayed()

Enables asynchronous delay which means the thread will not block while delaying.

executorService

public DelayDefinition executorService(ExecutorService executorService)

To use a custom Thread Pool if asyncDelay has been enabled.

Specified by:

executorService in interface ExecutorServiceAwareDefinition<DelayDefinition>

Parameters:

executorService - the executor service

Returns:

the builder

executorService

public DelayDefinition executorService(String executorService)

Refers to a custom Thread Pool if asyncDelay has been enabled.

Specified by:

executorService in interface ExecutorServiceAwareDefinition<DelayDefinition>

Parameters:

executorService - reference for a ExecutorService to lookup in the Registry

Returns:

the builder

getExecutorServiceBean

public ExecutorService getExecutorServiceBean()

Description copied from interface: ExecutorServiceAwareDefinition

Gets the executor service for executing

Specified by:

getExecutorServiceBean in interface ExecutorServiceAwareDefinition<DelayDefinition>

getExecutorServiceRef

public String getExecutorServiceRef()

Description copied from interface: ExecutorServiceAwareDefinition

Gets a reference id to lookup the executor service from the registry

Specified by:

getExecutorServiceRef in interface ExecutorServiceAwareDefinition<DelayDefinition>

setExpression

public void setExpression(ExpressionDefinition expression)

Expression to define how long time to wait (in millis)

Overrides:

setExpression in class ExpressionNode

getAsyncDelayed

public String getAsyncDelayed()

setAsyncDelayed

public void setAsyncDelayed(String asyncDelayed)

getCallerRunsWhenRejected

public String getCallerRunsWhenRejected()

setCallerRunsWhenRejected

public void setCallerRunsWhenRejected(String callerRunsWhenRejected)

getExecutorService

public String getExecutorService()

setExecutorService

public void setExecutorService(String executorService)