Package org.apache.camel.model

Class PausableDefinition

java.lang.Object

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

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

org.apache.camel.model.NoOutputDefinition<PausableDefinition>

org.apache.camel.model.PausableDefinition

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.LineNumberAware, Block, org.apache.camel.NamedNode, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HasId, org.apache.camel.spi.IdAware

@Metadata(label="eip,routing")
public class PausableDefinition
extends NoOutputDefinition<PausableDefinition>

Pausable EIP to support resuming processing from last known offset.

Field Summary

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

disabled, inheritErrorHandler

Constructor Summary

Constructors

Constructor	Description
PausableDefinition()

Method Summary

Modifier and Type	Method	Description
PausableDefinition	consumerListener(String consumerListenerRef)	Sets the consumer listener to use
PausableDefinition	consumerListener(org.apache.camel.resume.ConsumerListener<?,?> consumerListener)	Sets the consumer listener to use
String	getConsumerListener()
org.apache.camel.resume.ConsumerListener<?,?>	getConsumerListenerBean()
String	getLabel()	Returns a label to describe this node such as the expression if some kind of expression node
String	getShortName()
String	getUntilCheck()
Predicate<?>	getUntilCheckBean()
void	setConsumerListener(String consumerListener)
void	setConsumerListener(org.apache.camel.resume.ConsumerListener<?,?> consumerListenerBean)
void	setUntilCheck(String untilCheck)
void	setUntilCheck(Predicate<?> untilCheckBean)
PausableDefinition	untilCheck(String untilCheck)	References to a java.util.function.Predicate to use for until checks.
PausableDefinition	untilCheck(Predicate<?> untilCheck)	The java.util.function.Predicate to use for until checks.

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

getOutputs

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, configureChild, convertBodyTo, convertBodyTo, convertBodyTo, convertHeaderTo, convertHeaderTo, convertHeaderTo, convertHeaderTo, convertVariableTo, convertVariableTo, convertVariableTo, convertVariableTo, 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, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, 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, onException, onException, pausable, pausable, pausable, pausable, 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, preCreateProcessor, process, process, process, recipientList, recipientList, recipientList, recipientList, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, removeVariable, resequence, resequence, resumable, resumable, resumable, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setDisabled, setExchangePattern, setExchangePattern, setHeader, setHeader, setHeader, setHeaders, setInheritErrorHandler, setParent, setProperty, setProperty, setProperty, setRouteConfiguration, setVariable, setVariable, setVariable, 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, toD, toD, toD, toD, toD, toD, toD, toD, toD, toF, toV, transacted, transacted, transform, transform, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap, wireTap, wireTap

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

PausableDefinition

public PausableDefinition()

Method Details

getShortName

public String getShortName()

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 ProcessorDefinition<PausableDefinition>

getConsumerListenerBean

public org.apache.camel.resume.ConsumerListener<?,?> getConsumerListenerBean()

setConsumerListener

public void setConsumerListener(org.apache.camel.resume.ConsumerListener<?,?> consumerListenerBean)

getConsumerListener

public String getConsumerListener()

setConsumerListener

public void setConsumerListener(String consumerListener)

getUntilCheckBean

public Predicate<?> getUntilCheckBean()

setUntilCheck

public void setUntilCheck(Predicate<?> untilCheckBean)

getUntilCheck

public String getUntilCheck()

setUntilCheck

public void setUntilCheck(String untilCheck)

consumerListener

public PausableDefinition consumerListener(String consumerListenerRef)

Sets the consumer listener to use

consumerListener

public PausableDefinition consumerListener(org.apache.camel.resume.ConsumerListener<?,?> consumerListener)

Sets the consumer listener to use

untilCheck

public PausableDefinition untilCheck(String untilCheck)

References to a java.util.function.Predicate to use for until checks. The predicate is responsible for evaluating whether the processing can resume or not. Such predicate should return true if the consumption can resume, or false otherwise. The exact point of when the predicate is called is dependent on the component, and it may be called on either one of the available events. Implementations should not assume the predicate to be called at any specific point.

untilCheck

public PausableDefinition untilCheck(Predicate<?> untilCheck)

The java.util.function.Predicate to use for until checks. The predicate is responsible for evaluating whether the processing can resume or not. Such predicate should return true if the consumption can resume, or false otherwise. The exact point of when the predicate is called is dependent on the component, and it may be called on either one of the available events. Implementations should not assume the predicate to be called at any specific point.