org.apache.camel.component.dataset

Class DataSetEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.mock.MockEndpoint

org.apache.camel.component.dataset.DataSetEndpoint

All Implemented Interfaces:

CamelContextAware, Endpoint, IsSingleton, Service, ShutdownableService, BrowsableEndpoint, HasId, StatefulService, SuspendableService

@UriEndpoint(firstVersion="1.3.0",
             scheme="dataset",
             title="Dataset",
             syntax="dataset:name",
             consumerClass=DataSetConsumer.class,
             label="core,testing",
             lenientProperties=true)
public class DataSetEndpoint
extends MockEndpoint
implements Service

The dataset component provides a mechanism to easily perform load & soak testing of your system. It works by allowing you to create DataSet instances both as a source of messages and as a way to assert that the data set is received. Camel will use the throughput logger when sending dataset's.

Field Summary

Fields inherited from class org.apache.camel.component.mock.MockEndpoint

reporter

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
DataSetEndpoint() Deprecated.
DataSetEndpoint(String endpointUri, Component component, DataSet dataSet)

Method Summary

Modifier and Type	Method and Description
static void	assertEquals(String description, Object expected, Object actual, Exchange exchange)
protected void	assertMessageExpected(long index, Exchange expected, Exchange actual)
Consumer	createConsumer(Processor processor) Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor
Exchange	createExchange(long messageIndex) Creates a message exchange for the given index in the DataSet
Producer	createProducer() Creates a new producer which is used send messages into the endpoint
protected ThroughputLogger	createReporter()
protected void	doStart() Implementations override this method to support customized start/stop.
long	getConsumeDelay()
DataSet	getDataSet()
String	getDataSetIndex()
long	getInitialDelay()
int	getMinRate()
long	getPreloadSize()
long	getProduceDelay()
int	getReceivedCounter()
protected void	performAssertions(Exchange actual, Exchange copy) Performs the assertions on the incoming exchange.
void	reset()
void	setConsumeDelay(long consumeDelay) Allows a delay to be specified which causes a delay when a message is consumed by the producer (to simulate slow processing)
void	setDataSet(DataSet dataSet)
void	setDataSetIndex(String dataSetIndex) Controls the behaviour of the CamelDataSetIndex header.
void	setInitialDelay(long initialDelay) Time period in millis to wait before starting sending messages.
void	setMinRate(int minRate) Wait until the DataSet contains at least this number of messages
void	setPreloadSize(long preloadSize) Sets how many messages should be preloaded (sent) before the route completes its initialization
void	setProduceDelay(long produceDelay) Allows a delay to be specified which causes a delay when a message is sent by the consumer (to simulate slow processing)
protected void	waitForCompleteLatch(long timeout)

Methods inherited from class org.apache.camel.component.mock.MockEndpoint

addReceivedExchange, allMessages, assertEquals, assertExchangeReceived, assertIsNotSatisfied, assertIsNotSatisfied, assertIsSatisfied, assertIsSatisfied, assertIsSatisfied, assertIsSatisfied, assertIsSatisfied, assertIsSatisfied, assertMessagesAscending, assertMessagesDescending, assertMessagesSorted, assertNoDuplicates, assertTrue, assertWait, await, await, doAssertIsSatisfied, expectedBodiesReceived, expectedBodiesReceived, expectedBodiesReceivedInAnyOrder, expectedBodiesReceivedInAnyOrder, expectedBodyReceived, expectedExchangePattern, expectedFileExists, expectedFileExists, expectedHeaderReceived, expectedHeaderValuesReceivedInAnyOrder, expectedHeaderValuesReceivedInAnyOrder, expectedMessageCount, expectedMessagesMatches, expectedMinimumMessageCount, expectedPropertyReceived, expectedPropertyValuesReceivedInAnyOrder, expectedPropertyValuesReceivedInAnyOrder, expects, expectsAscending, expectsAscending, expectsDescending, expectsDescending, expectsMessageCount, expectsNoDuplicates, expectsNoDuplicates, fail, getExchanges, getExpectedCount, getExpectedMinimumCount, getFailures, getName, getReceivedExchanges, getReporter, getResultWaitTime, getSleepForEmptyTest, handle, isCopyOnExchange, isLenientProperties, isReportGroup, isSingleton, message, onExchange, resetMocks, resolve, returnReplyBody, returnReplyHeader, setAssertPeriod, setAssertPeriod, setCopyOnExchange, setExpectedCount, setExpectedMessageCount, setMinimumExpectedMessageCount, setMinimumResultWaitTime, setName, setReporter, setReportGroup, setResultMinimumWaitTime, setResultWaitTime, setRetainFirst, setRetainLast, setSleepForEmptyTest, waitForCompleteLatch, whenAnyExchangeReceived, whenExchangeReceived

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, doStop, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Methods inherited from interface org.apache.camel.Endpoint

configureProperties, createExchange, createExchange, createExchange, createPollingConsumer, getCamelContext, getEndpointConfiguration, getEndpointKey, getEndpointUri, setCamelContext

Constructor Detail

DataSetEndpoint

@Deprecated
public DataSetEndpoint()

Deprecated.

DataSetEndpoint

public DataSetEndpoint(String endpointUri,
                       Component component,
                       DataSet dataSet)

Method Detail

assertEquals

public static void assertEquals(String description,
                                Object expected,
                                Object actual,
                                Exchange exchange)

createConsumer

public Consumer createConsumer(Processor processor)
                        throws Exception

Description copied from interface: Endpoint

Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor

Specified by:

createConsumer in interface Endpoint

Overrides:

createConsumer in class MockEndpoint

Parameters:

processor - the given processor

Returns:

a newly created consumer

Throws:

Exception - can be thrown

createProducer

public Producer createProducer()
                        throws Exception

Description copied from interface: Endpoint

Creates a new producer which is used send messages into the endpoint

Specified by:

createProducer in interface Endpoint

Overrides:

createProducer in class MockEndpoint

Returns:

a newly created producer

Throws:

Exception - can be thrown

reset

public void reset()

Overrides:

reset in class MockEndpoint

getReceivedCounter

public int getReceivedCounter()

Overrides:

getReceivedCounter in class MockEndpoint

createExchange

public Exchange createExchange(long messageIndex)
                        throws Exception

Creates a message exchange for the given index in the DataSet

Throws:

Exception

waitForCompleteLatch

protected void waitForCompleteLatch(long timeout)
                             throws InterruptedException

Overrides:

waitForCompleteLatch in class MockEndpoint

Throws:

InterruptedException

getDataSet

public DataSet getDataSet()

setDataSet

public void setDataSet(DataSet dataSet)

getMinRate

public int getMinRate()

setMinRate

public void setMinRate(int minRate)

Wait until the DataSet contains at least this number of messages

getPreloadSize

public long getPreloadSize()

setPreloadSize

public void setPreloadSize(long preloadSize)

Sets how many messages should be preloaded (sent) before the route completes its initialization

getConsumeDelay

public long getConsumeDelay()

setConsumeDelay

public void setConsumeDelay(long consumeDelay)

Allows a delay to be specified which causes a delay when a message is consumed by the producer (to simulate slow processing)

getProduceDelay

public long getProduceDelay()

setProduceDelay

public void setProduceDelay(long produceDelay)

Allows a delay to be specified which causes a delay when a message is sent by the consumer (to simulate slow processing)

getInitialDelay

public long getInitialDelay()

setInitialDelay

public void setInitialDelay(long initialDelay)

Time period in millis to wait before starting sending messages.

setDataSetIndex

public void setDataSetIndex(String dataSetIndex)

Controls the behaviour of the CamelDataSetIndex header. For Consumers: - off => the header will not be set - strict/lenient => the header will be set For Producers: - off => the header value will not be verified, and will not be set if it is not present = strict => the header value must be present and will be verified = lenient => the header value will be verified if it is present, and will be set if it is not present

getDataSetIndex

public String getDataSetIndex()

performAssertions

protected void performAssertions(Exchange actual,
                                 Exchange copy)
                          throws Exception

Description copied from class: MockEndpoint

Performs the assertions on the incoming exchange.

Overrides:

performAssertions in class MockEndpoint

Parameters:

actual - the actual exchange

copy - a copy of the exchange (only store this)

Throws:

Exception - can be thrown if something went wrong

assertMessageExpected

protected void assertMessageExpected(long index,
                                     Exchange expected,
                                     Exchange actual)
                              throws Exception

Throws:

Exception

createReporter

protected ThroughputLogger createReporter()

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Overrides:

doStart in class DefaultEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStop()