org.apache.camel.model
Class ThrottleDefinition

java.lang.Object
  org.apache.camel.model.OptionalIdentifiedType<Type>
      org.apache.camel.model.ProcessorDefinition<ProcessorDefinition>
          org.apache.camel.model.ThrottleDefinition

All Implemented Interfaces:

Block

public class ThrottleDefinition
extends ProcessorDefinition<ProcessorDefinition>

Represents an XML <throttle/> element

Version:

$Revision: 751373 $

Field Summary

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

nodeCounters

Constructor Summary

ThrottleDefinition()

ThrottleDefinition(long maximumRequestsPerPeriod)

Method Summary

Processor	createProcessor(RouteContext routeContext)
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
Long	getMaximumRequestsPerPeriod()
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
long	getTimePeriodMillis()
ThrottleDefinition	maximumRequestsPerPeriod(Long maximumRequestsPerPeriod) Sets the time period during which the maximum request count per period
void	setMaximumRequestsPerPeriod(Long maximumRequestsPerPeriod)
void	setOutputs(List<ProcessorDefinition> outputs)
void	setTimePeriodMillis(long timePeriodMillis)
ThrottleDefinition	timePeriodMillis(long timePeriodMillis) Sets the time period during which the maximum request count is valid for
String	toString()

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

addInterceptStrategy, addOutput, 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, errorHandler, filter, filter, filter, filter, getErrorHandlerBuilder, getErrorHandlerRef, getInterceptStrategies, getNodeFactory, getParent, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, loadBalance, loadBalance, loop, loop, loop, makeProcessor, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onCompletion, onException, pipeline, pipeline, pipeline, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, process, processRef, recipientList, recipientList, removeFaultHeader, removeHeader, removeProperty, resequence, resequence, resequence, resequencer, rollback, rollback, routingSlip, routingSlip, setBody, setBody, setErrorHandlerBuilder, setErrorHandlerBuilderIfNull, setErrorHandlerRef, 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, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, wireTap, wireTap, wireTap, wrapChannel, wrapProcessor

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

createId, description, getDescription, getId, getNodeCounter, hasCustomIdAssigned, idOrCreate, setDescription, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

ThrottleDefinition

public ThrottleDefinition()

ThrottleDefinition

public ThrottleDefinition(long maximumRequestsPerPeriod)

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

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

Overrides:

getLabel in class ProcessorDefinition<ProcessorDefinition>

createProcessor

public Processor createProcessor(RouteContext routeContext)
                          throws Exception

Overrides:

createProcessor in class ProcessorDefinition<ProcessorDefinition>

Throws:

Exception

timePeriodMillis

public ThrottleDefinition timePeriodMillis(long timePeriodMillis)

Sets the time period during which the maximum request count is valid for

Parameters:

timePeriodMillis - period in millis

Returns:

the builder

maximumRequestsPerPeriod

public ThrottleDefinition maximumRequestsPerPeriod(Long maximumRequestsPerPeriod)

Sets the time period during which the maximum request count per period

Parameters:

maximumRequestsPerPeriod - the maximum request count number per time period

Returns:

the builder

getMaximumRequestsPerPeriod

public Long getMaximumRequestsPerPeriod()

setMaximumRequestsPerPeriod

public void setMaximumRequestsPerPeriod(Long maximumRequestsPerPeriod)

getTimePeriodMillis

public long getTimePeriodMillis()

setTimePeriodMillis

public void setTimePeriodMillis(long timePeriodMillis)

getOutputs

public List<ProcessorDefinition> getOutputs()

Specified by:

getOutputs in class ProcessorDefinition<ProcessorDefinition>

setOutputs

public void setOutputs(List<ProcessorDefinition> outputs)