org.apache.camel.model
Class SamplingDefinition

java.lang.Object
  org.apache.camel.model.OptionalIdentifiedDefinition
      org.apache.camel.model.ProcessorDefinition<Type>
          org.apache.camel.model.OutputDefinition<SamplingDefinition>
              org.apache.camel.model.SamplingDefinition

All Implemented Interfaces:

Block

public class SamplingDefinition
extends OutputDefinition<SamplingDefinition>

Represents an XML <sample/> element

Version:

$Revision: 1057086 $

Field Summary

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

outputs

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

errorHandlerBuilder, errorHandlerRef, inheritErrorHandler, log

Constructor Summary

SamplingDefinition()

SamplingDefinition(long messageFrequency)

SamplingDefinition(long samplePeriod, TimeUnit units)

Method Summary

Processor	createProcessor(RouteContext routeContext) Override this in definition class and implement logic to create the processor based on the definition model.
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
Long	getMessageFrequency()
Long	getSamplePeriod()
String	getShortName() Returns a short name for this node which can be useful for ID generation or referring to related resources like images
TimeUnit	getUnits()
SamplingDefinition	sampleMessageFrequency(long messageFrequency) Sets the sample message count which only a single Exchange will pass through after this many received.
SamplingDefinition	samplePeriod(long samplePeriod) Sets the sample period during which only a single Exchange will pass through.
void	setMessageFrequency(Long messageFrequency)
void	setSamplePeriod(Long samplePeriod)
void	setUnits(String units)
void	setUnits(TimeUnit units)
SamplingDefinition	timeUnits(TimeUnit units) Sets the time units for the sample period, defaulting to seconds.
String	toString()

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

getOutputs, setOutputs

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

addInterceptStrategies, addInterceptStrategy, addOutput, addRoutes, aggregate, aggregate, aggregate, aggregate, aop, bean, bean, bean, bean, beanRef, beanRef, choice, clearOutput, configureChild, convertBodyTo, convertBodyTo, createChannel, createChildProcessor, createCompositeProcessor, createErrorHandlerBuilder, createOutputsProcessor, createOutputsProcessor, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, end, enrich, enrich, enrichRef, filter, filter, filter, filter, getErrorHandlerBuilder, getInterceptStrategies, getNodeFactory, getParent, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, loadBalance, loadBalance, log, log, log, loop, loop, loop, makeProcessor, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onCompletion, onException, onException, pipeline, pipeline, pipeline, pipeline, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichRef, process, processRef, recipientList, recipientList, recipientList, removeFaultHeader, removeHeader, removeHeaders, removeHeaders, removeProperty, resequence, resequence, resequence, resequence, resolveKnownConstantFields, resolvePropertyPlaceholders, rollback, rollback, routeId, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, sample, sample, sample, setBody, setBody, setErrorHandlerBuilder, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setInheritErrorHandler, setNodeFactory, setOutHeader, setOutHeader, setParent, setProperty, setProperty, sort, sort, sortBody, sortBody, split, split, split, stop, threads, threads, threads, throttle, throwException, to, to, to, to, to, to, to, to, to, to, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wrapChannel, wrapInErrorHandler, wrapProcessor

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SamplingDefinition

public SamplingDefinition()

SamplingDefinition

public SamplingDefinition(long samplePeriod,
                          TimeUnit units)

SamplingDefinition

public SamplingDefinition(long messageFrequency)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getShortName

public String getShortName()

Description copied from class: OptionalIdentifiedDefinition

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 OptionalIdentifiedDefinition

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<SamplingDefinition>

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<SamplingDefinition>

Throws:

Exception

sampleMessageFrequency

public SamplingDefinition sampleMessageFrequency(long messageFrequency)

Sets the sample message count which only a single Exchange will pass through after this many received.

Parameters:

messageFrequency -

Returns:

the builder

samplePeriod

public SamplingDefinition samplePeriod(long samplePeriod)

Sets the sample period during which only a single Exchange will pass through.

Parameters:

samplePeriod - the period

Returns:

the builder

timeUnits

public SamplingDefinition timeUnits(TimeUnit units)

Sets the time units for the sample period, defaulting to seconds.

Parameters:

units - the time unit of the sample period.

Returns:

the builder

getSamplePeriod

public Long getSamplePeriod()

setSamplePeriod

public void setSamplePeriod(Long samplePeriod)

getMessageFrequency

public Long getMessageFrequency()

setMessageFrequency

public void setMessageFrequency(Long messageFrequency)

setUnits

public void setUnits(String units)

setUnits

public void setUnits(TimeUnit units)

getUnits

public TimeUnit getUnits()