Package org.apache.camel.builder.endpoint.dsl

Interface DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
All Known Subinterfaces:
DataSetEndpointBuilderFactory.AdvancedDataSetEndpointBuilder
Enclosing interface:
DataSetEndpointBuilderFactory
public static interface DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Advanced builder for endpoint producers for the Dataset component.

  • Method Details

    • basic

      default DataSetEndpointBuilderFactory.DataSetEndpointProducerBuilder basic()

    • copyOnExchange

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder copyOnExchange(boolean copyOnExchange)
      Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. The option is a: boolean type. Default: true Group: producer (advanced)
      Parameters:
      copyOnExchange - the value to set
      Returns:
      the dsl builder

    • copyOnExchange

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder copyOnExchange(String copyOnExchange)
      Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. The option will be converted to a boolean type. Default: true Group: producer (advanced)
      Parameters:
      copyOnExchange - the value to set
      Returns:
      the dsl builder

    • failFast

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder failFast(boolean failFast)
      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: boolean type. Default: true Group: producer (advanced)
      Parameters:
      failFast - the value to set
      Returns:
      the dsl builder

    • failFast

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder failFast(String failFast)
      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 boolean type. Default: true Group: producer (advanced)
      Parameters:
      failFast - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder lazyStartProducer(boolean lazyStartProducer)
      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: boolean type. Default: false Group: producer (advanced)
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder lazyStartProducer(String lazyStartProducer)
      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 boolean type. Default: false Group: producer (advanced)
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • log

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder log(boolean log)
      To turn on logging when the mock receives an incoming message. This will log only one time at INFO level for the incoming message. For more detailed logging, then set the logger to DEBUG level for the org.apache.camel.component.mock.MockEndpoint class. The option is a: boolean type. Default: false Group: producer (advanced)
      Parameters:
      log - the value to set
      Returns:
      the dsl builder

    • log

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder log(String log)
      To turn on logging when the mock receives an incoming message. This will log only one time at INFO level for the incoming message. For more detailed logging, then set the logger to DEBUG level for the org.apache.camel.component.mock.MockEndpoint class. The option will be converted to a boolean type. Default: false Group: producer (advanced)
      Parameters:
      log - the value to set
      Returns:
      the dsl builder

    • reportGroup

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder reportGroup(int reportGroup)
      A number that is used to turn on throughput logging based on groups of the size. The option is a: int type. Group: producer (advanced)
      Parameters:
      reportGroup - the value to set
      Returns:
      the dsl builder

    • reportGroup

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder reportGroup(String reportGroup)
      A number that is used to turn on throughput logging based on groups of the size. The option will be converted to a int type. Group: producer (advanced)
      Parameters:
      reportGroup - the value to set
      Returns:
      the dsl builder

    • resultMinimumWaitTime

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder resultMinimumWaitTime(long resultMinimumWaitTime)
      Sets the minimum expected amount of time the assertIsSatisfied() will wait on a latch until it is satisfied. The option is a: long type. Group: producer (advanced)
      Parameters:
      resultMinimumWaitTime - the value to set
      Returns:
      the dsl builder

    • resultMinimumWaitTime

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder resultMinimumWaitTime(String resultMinimumWaitTime)
      Sets the minimum expected amount of time the assertIsSatisfied() will wait on a latch until it is satisfied. The option will be converted to a long type. Group: producer (advanced)
      Parameters:
      resultMinimumWaitTime - the value to set
      Returns:
      the dsl builder

    • resultWaitTime

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder resultWaitTime(long resultWaitTime)
      Sets the maximum amount of time the assertIsSatisfied() will wait on a latch until it is satisfied. The option is a: long type. Group: producer (advanced)
      Parameters:
      resultWaitTime - the value to set
      Returns:
      the dsl builder

    • resultWaitTime

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder resultWaitTime(String resultWaitTime)
      Sets the maximum amount of time the assertIsSatisfied() will wait on a latch until it is satisfied. The option will be converted to a long type. Group: producer (advanced)
      Parameters:
      resultWaitTime - the value to set
      Returns:
      the dsl builder

    • retainFirst

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder retainFirst(int retainFirst)
      Specifies to only retain the first nth 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 message. For example if we have received 5000 messages 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 retainFirst and retainLast options, to limit both the first and last received. The option is a: int type. Default: -1 Group: producer (advanced)
      Parameters:
      retainFirst - the value to set
      Returns:
      the dsl builder

    • retainFirst

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder retainFirst(String retainFirst)
      Specifies to only retain the first nth 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 message. For example if we have received 5000 messages 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 retainFirst and retainLast options, to limit both the first and last received. The option will be converted to a int type. Default: -1 Group: producer (advanced)
      Parameters:
      retainFirst - the value to set
      Returns:
      the dsl builder

    • retainLast

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder retainLast(int retainLast)
      Specifies to only retain the last nth 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 message. For example if we have received 5000 messages 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 retainFirst and retainLast options, to limit both the first and last received. The option is a: int type. Default: -1 Group: producer (advanced)
      Parameters:
      retainLast - the value to set
      Returns:
      the dsl builder

    • retainLast

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder retainLast(String retainLast)
      Specifies to only retain the last nth 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 message. For example if we have received 5000 messages 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 retainFirst and retainLast options, to limit both the first and last received. The option will be converted to a int type. Default: -1 Group: producer (advanced)
      Parameters:
      retainLast - the value to set
      Returns:
      the dsl builder

    • sleepForEmptyTest

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder sleepForEmptyTest(long sleepForEmptyTest)
      Allows a sleep to be specified to wait to check that this mock really is empty when expectedMessageCount(int) is called with zero value. The option is a: long type. Group: producer (advanced)
      Parameters:
      sleepForEmptyTest - the value to set
      Returns:
      the dsl builder

    • sleepForEmptyTest

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder sleepForEmptyTest(String sleepForEmptyTest)
      Allows a sleep to be specified to wait to check that this mock really is empty when expectedMessageCount(int) is called with zero value. The option will be converted to a long type. Group: producer (advanced)
      Parameters:
      sleepForEmptyTest - the value to set
      Returns:
      the dsl builder

    • browseLimit

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder browseLimit(int browseLimit)
      Maximum number of messages to keep in memory available for browsing. Use 0 for unlimited. The option is a: int type. Default: 100 Group: advanced
      Parameters:
      browseLimit - the value to set
      Returns:
      the dsl builder

    • browseLimit

      default DataSetEndpointBuilderFactory.AdvancedDataSetEndpointProducerBuilder browseLimit(String browseLimit)
      Maximum number of messages to keep in memory available for browsing. Use 0 for unlimited. The option will be converted to a int type. Default: 100 Group: advanced
      Parameters:
      browseLimit - the value to set
      Returns:
      the dsl builder