blob: 1ab9684a03512c2cc61e5f2d96407f5b8150ee06 [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.builder.endpoint.dsl;
import javax.annotation.Generated;
import org.apache.camel.builder.EndpointConsumerBuilder;
import org.apache.camel.builder.EndpointProducerBuilder;
import org.apache.camel.builder.endpoint.AbstractEndpointBuilder;
/**
* The dataset-test component extends the mock component by on startup to pull
* messages from another endpoint to set the expected message bodies.
*
* Generated by camel-package-maven-plugin - do not edit this file!
*/
@Generated("org.apache.camel.maven.packaging.EndpointDslMojo")
public interface DataSetTestEndpointBuilderFactory {
/**
* Builder for endpoint for the DataSet Test component.
*/
public interface DataSetTestEndpointBuilder
extends
EndpointProducerBuilder {
default AdvancedDataSetTestEndpointBuilder advanced() {
return (AdvancedDataSetTestEndpointBuilder) this;
}
/**
* Whether the expected messages should arrive in the same order or can
* be in any order.
*
* The option is a: <code>boolean</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder anyOrder(boolean anyOrder) {
doSetProperty("anyOrder", anyOrder);
return this;
}
/**
* Whether the expected messages should arrive in the same order or can
* be in any order.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder anyOrder(String anyOrder) {
doSetProperty("anyOrder", anyOrder);
return this;
}
/**
* The split delimiter to use when split is enabled. By default the
* delimiter is new line based. The delimiter can be a regular
* expression.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder delimiter(String delimiter) {
doSetProperty("delimiter", delimiter);
return this;
}
/**
* If enabled the messages loaded from the test endpoint will be split
* using new line delimiters so each line is an expected message. For
* example to use a file endpoint to load a file where each line is an
* expected message.
*
* The option is a: <code>boolean</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder split(boolean split) {
doSetProperty("split", split);
return this;
}
/**
* If enabled the messages loaded from the test endpoint will be split
* using new line delimiters so each line is an expected message. For
* example to use a file endpoint to load a file where each line is an
* expected message.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder split(String split) {
doSetProperty("split", split);
return this;
}
/**
* The timeout to use when polling for message bodies from the URI.
*
* The option is a: <code>long</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder timeout(long timeout) {
doSetProperty("timeout", timeout);
return this;
}
/**
* The timeout to use when polling for message bodies from the URI.
*
* The option will be converted to a <code>long</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder timeout(String timeout) {
doSetProperty("timeout", timeout);
return this;
}
/**
* Sets a grace period after which the mock endpoint will re-assert to
* ensure the preliminary assertion is still valid. This is used for
* example to assert that exactly a number of messages arrives. For
* example if expectedMessageCount(int) was set to 5, then the assertion
* is satisfied when 5 or more message arrives. To ensure that exactly 5
* messages arrives, then you would need to wait a little period to
* ensure no further message arrives. This is what you can use this
* method for. By default this period is disabled.
*
* The option is a: <code>long</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder assertPeriod(long assertPeriod) {
doSetProperty("assertPeriod", assertPeriod);
return this;
}
/**
* Sets a grace period after which the mock endpoint will re-assert to
* ensure the preliminary assertion is still valid. This is used for
* example to assert that exactly a number of messages arrives. For
* example if expectedMessageCount(int) was set to 5, then the assertion
* is satisfied when 5 or more message arrives. To ensure that exactly 5
* messages arrives, then you would need to wait a little period to
* ensure no further message arrives. This is what you can use this
* method for. By default this period is disabled.
*
* The option will be converted to a <code>long</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder assertPeriod(String assertPeriod) {
doSetProperty("assertPeriod", assertPeriod);
return this;
}
/**
* Specifies the expected number of message exchanges that should be
* received by this endpoint. Beware: If you want to expect that 0
* messages, then take extra care, as 0 matches when the tests starts,
* so you need to set a assert period time to let the test run for a
* while to make sure there are still no messages arrived; for that use
* setAssertPeriod(long). An alternative is to use NotifyBuilder, and
* use the notifier to know when Camel is done routing some messages,
* before you call the assertIsSatisfied() method on the mocks. This
* allows you to not use a fixed assert period, to speedup testing
* times. If you want to assert that exactly n'th message arrives to
* this mock endpoint, then see also the setAssertPeriod(long) method
* for further details.
*
* The option is a: <code>int</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder expectedCount(int expectedCount) {
doSetProperty("expectedCount", expectedCount);
return this;
}
/**
* Specifies the expected number of message exchanges that should be
* received by this endpoint. Beware: If you want to expect that 0
* messages, then take extra care, as 0 matches when the tests starts,
* so you need to set a assert period time to let the test run for a
* while to make sure there are still no messages arrived; for that use
* setAssertPeriod(long). An alternative is to use NotifyBuilder, and
* use the notifier to know when Camel is done routing some messages,
* before you call the assertIsSatisfied() method on the mocks. This
* allows you to not use a fixed assert period, to speedup testing
* times. If you want to assert that exactly n'th message arrives to
* this mock endpoint, then see also the setAssertPeriod(long) method
* for further details.
*
* The option will be converted to a <code>int</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder expectedCount(String expectedCount) {
doSetProperty("expectedCount", expectedCount);
return this;
}
/**
* Sets whether assertIsSatisfied() should fail fast at the first
* detected failed expectation while it may otherwise wait for all
* expected messages to arrive before performing expectations
* verifications. Is by default true. Set to false to use behavior as in
* Camel 2.x.
*
* The option is a: <code>boolean</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder failFast(boolean failFast) {
doSetProperty("failFast", failFast);
return this;
}
/**
* Sets whether assertIsSatisfied() should fail fast at the first
* detected failed expectation while it may otherwise wait for all
* expected messages to arrive before performing expectations
* verifications. Is by default true. Set to false to use behavior as in
* Camel 2.x.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder failFast(String failFast) {
doSetProperty("failFast", failFast);
return this;
}
/**
* Whether the producer should be started lazy (on the first message).
* By starting lazy you can use this to allow CamelContext and routes to
* startup in situations where a producer may otherwise fail during
* starting and cause the route to fail being started. By deferring this
* startup to be lazy then the startup failure can be handled during
* routing messages via Camel's routing error handlers. Beware that when
* the first message is processed then creating and starting the
* producer may take a little time and prolong the total processing time
* of the processing.
*
* The option is a: <code>boolean</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder lazyStartProducer(
boolean lazyStartProducer) {
doSetProperty("lazyStartProducer", lazyStartProducer);
return this;
}
/**
* Whether the producer should be started lazy (on the first message).
* By starting lazy you can use this to allow CamelContext and routes to
* startup in situations where a producer may otherwise fail during
* starting and cause the route to fail being started. By deferring this
* startup to be lazy then the startup failure can be handled during
* routing messages via Camel's routing error handlers. Beware that when
* the first message is processed then creating and starting the
* producer may take a little time and prolong the total processing time
* of the processing.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder lazyStartProducer(
String lazyStartProducer) {
doSetProperty("lazyStartProducer", lazyStartProducer);
return this;
}
/**
* A number that is used to turn on throughput logging based on groups
* of the size.
*
* The option is a: <code>int</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder reportGroup(int reportGroup) {
doSetProperty("reportGroup", reportGroup);
return this;
}
/**
* A number that is used to turn on throughput logging based on groups
* of the size.
*
* The option will be converted to a <code>int</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder reportGroup(String reportGroup) {
doSetProperty("reportGroup", reportGroup);
return this;
}
/**
* Sets the minimum expected amount of time (in millis) the
* assertIsSatisfied() will wait on a latch until it is satisfied.
*
* The option is a: <code>long</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder resultMinimumWaitTime(
long resultMinimumWaitTime) {
doSetProperty("resultMinimumWaitTime", resultMinimumWaitTime);
return this;
}
/**
* Sets the minimum expected amount of time (in millis) the
* assertIsSatisfied() will wait on a latch until it is satisfied.
*
* The option will be converted to a <code>long</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder resultMinimumWaitTime(
String resultMinimumWaitTime) {
doSetProperty("resultMinimumWaitTime", resultMinimumWaitTime);
return this;
}
/**
* Sets the maximum amount of time (in millis) the assertIsSatisfied()
* will wait on a latch until it is satisfied.
*
* The option is a: <code>long</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder resultWaitTime(long resultWaitTime) {
doSetProperty("resultWaitTime", resultWaitTime);
return this;
}
/**
* Sets the maximum amount of time (in millis) the assertIsSatisfied()
* will wait on a latch until it is satisfied.
*
* The option will be converted to a <code>long</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder resultWaitTime(String resultWaitTime) {
doSetProperty("resultWaitTime", resultWaitTime);
return this;
}
/**
* Specifies to only retain the first n'th number of received Exchanges.
* This is used when testing with big data, to reduce memory consumption
* by not storing copies of every Exchange this mock endpoint receives.
* Important: When using this limitation, then the getReceivedCounter()
* will still return the actual number of received Exchanges. For
* example if we have received 5000 Exchanges, and have configured to
* only retain the first 10 Exchanges, then the getReceivedCounter()
* will still return 5000 but there is only the first 10 Exchanges in
* the getExchanges() and getReceivedExchanges() methods. When using
* this method, then some of the other expectation methods is not
* supported, for example the expectedBodiesReceived(Object...) sets a
* expectation on the first number of bodies received. You can configure
* both setRetainFirst(int) and setRetainLast(int) methods, to limit
* both the first and last received.
*
* The option is a: <code>int</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder retainFirst(int retainFirst) {
doSetProperty("retainFirst", retainFirst);
return this;
}
/**
* Specifies to only retain the first n'th number of received Exchanges.
* This is used when testing with big data, to reduce memory consumption
* by not storing copies of every Exchange this mock endpoint receives.
* Important: When using this limitation, then the getReceivedCounter()
* will still return the actual number of received Exchanges. For
* example if we have received 5000 Exchanges, and have configured to
* only retain the first 10 Exchanges, then the getReceivedCounter()
* will still return 5000 but there is only the first 10 Exchanges in
* the getExchanges() and getReceivedExchanges() methods. When using
* this method, then some of the other expectation methods is not
* supported, for example the expectedBodiesReceived(Object...) sets a
* expectation on the first number of bodies received. You can configure
* both setRetainFirst(int) and setRetainLast(int) methods, to limit
* both the first and last received.
*
* The option will be converted to a <code>int</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder retainFirst(String retainFirst) {
doSetProperty("retainFirst", retainFirst);
return this;
}
/**
* Specifies to only retain the last n'th number of received Exchanges.
* This is used when testing with big data, to reduce memory consumption
* by not storing copies of every Exchange this mock endpoint receives.
* Important: When using this limitation, then the getReceivedCounter()
* will still return the actual number of received Exchanges. For
* example if we have received 5000 Exchanges, and have configured to
* only retain the last 20 Exchanges, then the getReceivedCounter() will
* still return 5000 but there is only the last 20 Exchanges in the
* getExchanges() and getReceivedExchanges() methods. When using this
* method, then some of the other expectation methods is not supported,
* for example the expectedBodiesReceived(Object...) sets a expectation
* on the first number of bodies received. You can configure both
* setRetainFirst(int) and setRetainLast(int) methods, to limit both the
* first and last received.
*
* The option is a: <code>int</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder retainLast(int retainLast) {
doSetProperty("retainLast", retainLast);
return this;
}
/**
* Specifies to only retain the last n'th number of received Exchanges.
* This is used when testing with big data, to reduce memory consumption
* by not storing copies of every Exchange this mock endpoint receives.
* Important: When using this limitation, then the getReceivedCounter()
* will still return the actual number of received Exchanges. For
* example if we have received 5000 Exchanges, and have configured to
* only retain the last 20 Exchanges, then the getReceivedCounter() will
* still return 5000 but there is only the last 20 Exchanges in the
* getExchanges() and getReceivedExchanges() methods. When using this
* method, then some of the other expectation methods is not supported,
* for example the expectedBodiesReceived(Object...) sets a expectation
* on the first number of bodies received. You can configure both
* setRetainFirst(int) and setRetainLast(int) methods, to limit both the
* first and last received.
*
* The option will be converted to a <code>int</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder retainLast(String retainLast) {
doSetProperty("retainLast", retainLast);
return this;
}
/**
* Allows a sleep to be specified to wait to check that this endpoint
* really is empty when expectedMessageCount(int) is called with zero.
*
* The option is a: <code>long</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder sleepForEmptyTest(
long sleepForEmptyTest) {
doSetProperty("sleepForEmptyTest", sleepForEmptyTest);
return this;
}
/**
* Allows a sleep to be specified to wait to check that this endpoint
* really is empty when expectedMessageCount(int) is called with zero.
*
* The option will be converted to a <code>long</code> type.
*
* Group: producer
*/
default DataSetTestEndpointBuilder sleepForEmptyTest(
String sleepForEmptyTest) {
doSetProperty("sleepForEmptyTest", sleepForEmptyTest);
return this;
}
}
/**
* Advanced builder for endpoint for the DataSet Test component.
*/
public interface AdvancedDataSetTestEndpointBuilder
extends
EndpointProducerBuilder {
default DataSetTestEndpointBuilder basic() {
return (DataSetTestEndpointBuilder) this;
}
/**
* Sets whether to make a deep copy of the incoming Exchange when
* received at this mock endpoint. Is by default true.
*
* The option is a: <code>boolean</code> type.
*
* Group: producer (advanced)
*/
default AdvancedDataSetTestEndpointBuilder copyOnExchange(
boolean copyOnExchange) {
doSetProperty("copyOnExchange", copyOnExchange);
return this;
}
/**
* Sets whether to make a deep copy of the incoming Exchange when
* received at this mock endpoint. Is by default true.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: producer (advanced)
*/
default AdvancedDataSetTestEndpointBuilder copyOnExchange(
String copyOnExchange) {
doSetProperty("copyOnExchange", copyOnExchange);
return this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedDataSetTestEndpointBuilder basicPropertyBinding(
boolean basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedDataSetTestEndpointBuilder basicPropertyBinding(
String basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedDataSetTestEndpointBuilder synchronous(
boolean synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedDataSetTestEndpointBuilder synchronous(
String synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
}
/**
* DataSet Test (camel-dataset)
* The dataset-test component extends the mock component by on startup to
* pull messages from another endpoint to set the expected message bodies.
*
* Category: core,testing
* Available as of version: 1.3
* Maven coordinates: org.apache.camel:camel-dataset
*
* Syntax: <code>dataset-test:name</code>
*
* Path parameter: name (required)
* Name of endpoint to lookup in the registry to use for polling messages
* used for testing
*/
default DataSetTestEndpointBuilder datasetTest(String path) {
class DataSetTestEndpointBuilderImpl extends AbstractEndpointBuilder implements DataSetTestEndpointBuilder, AdvancedDataSetTestEndpointBuilder {
public DataSetTestEndpointBuilderImpl(String path) {
super("dataset-test", path);
}
}
return new DataSetTestEndpointBuilderImpl(path);
}
}