org.apache.camel.model
Class ThrottlerType

java.lang.Object
  extended by org.apache.camel.model.OptionalIdentifiedType<Type>
      extended by org.apache.camel.model.ProcessorType<ProcessorType>
          extended by org.apache.camel.model.ThrottlerType
All Implemented Interfaces:
Block

public class ThrottlerType
extends ProcessorType<ProcessorType>

Represents an XML <throttler/> element

Version:
$Revision: 64792 $

Field Summary
 
Fields inherited from class org.apache.camel.model.ProcessorType
DEFAULT_TRACE_CATEGORY
 
Fields inherited from class org.apache.camel.model.OptionalIdentifiedType
nodeCounters
 
Constructor Summary
ThrottlerType()
           
ThrottlerType(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<ProcessorType<?>> 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()
           
 ThrottlerType maximumRequestsPerPeriod(Long maximumRequestsPerPeriod)
          Sets the time period during which the maximum request count per period
 void setMaximumRequestsPerPeriod(Long maximumRequestsPerPeriod)
           
 void setOutputs(List<ProcessorType<?>> outputs)
           
 void setTimePeriodMillis(long timePeriodMillis)
           
 ThrottlerType 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.ProcessorType
addInterceptor, addInterceptor, addOutput, addRoutes, aggregator, aggregator, aggregator, aggregator, aggregator, bean, bean, bean, bean, beanRef, beanRef, choice, clearOutput, configureChild, convertBodyTo, convertBodyTo, convertFaultBodyTo, convertOutBodyTo, createCompositeProcessor, createErrorHandlerBuilder, createOutputsProcessor, createOutputsProcessor, delayer, delayer, delayer, delayer, end, errorHandler, exception, filter, filter, filter, filter, getErrorHandlerBuilder, getErrorHandlerRef, getInheritErrorHandlerFlag, getNodeFactory, getParent, handleFault, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, intercept, intercept, intercept, intercept, interceptor, interceptors, isInheritErrorHandler, isInheritErrorHandler, loadBalance, loop, loop, loop, makeProcessor, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onException, pipeline, pipeline, pipeline, policies, policy, popBlock, proceed, process, processRef, pushBlock, recipientList, recipientList, removeFaultHeader, removeHeader, removeProperty, resequencer, resequencer, resequencer, resequencer, routingSlip, routingSlip, routingSlip, setBody, setBody, setErrorHandlerBuilder, setErrorHandlerBuilderIfNull, setErrorHandlerRef, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setHeader, setInheritErrorHandlerFlag, setNodeFactory, setOutBody, setOutBody, setOutHeader, setOutHeader, setParent, setProperty, setProperty, splitter, splitter, splitter, splitter, splitter, splitter, splitter, splitter, splitter, splitter, splitter, splitter, stop, thread, thread, throttler, throwFault, throwFault, to, to, to, to, to, to, to, to, to, to, trace, trace, transform, transform, tryBlock, unmarshal, unmarshal, unmarshal, unmarshal, wrapInErrorHandler, wrapProcessor, wrapProcessorInInterceptors
 
Methods inherited from class org.apache.camel.model.OptionalIdentifiedType
createId, describe, description, description, getDescription, getId, getNodeCounter, id, idOrCreate, setDescription, setId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ThrottlerType

public ThrottlerType()

ThrottlerType

public ThrottlerType(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<ProcessorType>
Returns:
defaults to "node" but derived nodes should overload this to provide a unique name

getLabel

public String getLabel()
Description copied from class: ProcessorType
Returns a label to describe this node such as the expression if some kind of expression node

Overrides:
getLabel in class ProcessorType<ProcessorType>

createProcessor

public Processor createProcessor(RouteContext routeContext)
                          throws Exception
Overrides:
createProcessor in class ProcessorType<ProcessorType>
Throws:
Exception

timePeriodMillis

public ThrottlerType timePeriodMillis(long timePeriodMillis)
Sets the time period during which the maximum request count is valid for


maximumRequestsPerPeriod

public ThrottlerType 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<ProcessorType<?>> getOutputs()
Specified by:
getOutputs in class ProcessorType<ProcessorType>

setOutputs

public void setOutputs(List<ProcessorType<?>> outputs)


Copyright © 2009 IONA Open Source Community. All Rights Reserved.