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

Interface StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    StubEndpointBuilderFactory.AdvancedStubEndpointBuilder
    Enclosing interface:
    StubEndpointBuilderFactory
    public static interface StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Advanced builder for endpoint consumers for the Stub component.

    • Method Detail

      • exceptionHandler

        default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder exceptionHandler​(org.apache.camel.spi.ExceptionHandler exceptionHandler)
        To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)
        Parameters:
        exceptionHandler - the value to set
        Returns:
        the dsl builder

      • exceptionHandler

        default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder exceptionHandler​(String exceptionHandler)
        To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)
        Parameters:
        exceptionHandler - the value to set
        Returns:
        the dsl builder

      • exchangePattern

        default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder exchangePattern​(org.apache.camel.ExchangePattern exchangePattern)
        Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)
        Parameters:
        exchangePattern - the value to set
        Returns:
        the dsl builder

      • exchangePattern

        default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder exchangePattern​(String exchangePattern)
        Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)
        Parameters:
        exchangePattern - the value to set
        Returns:
        the dsl builder

      • limitConcurrentConsumers

        default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder limitConcurrentConsumers​(boolean limitConcurrentConsumers)
        Whether to limit the number of concurrentConsumers to the maximum of 500. By default, an exception will be thrown if an endpoint is configured with a greater number. You can disable that check by turning this option off. The option is a: <code>boolean</code> type. Default: true Group: consumer (advanced)
        Parameters:
        limitConcurrentConsumers - the value to set
        Returns:
        the dsl builder

      • limitConcurrentConsumers

        default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder limitConcurrentConsumers​(String limitConcurrentConsumers)
        Whether to limit the number of concurrentConsumers to the maximum of 500. By default, an exception will be thrown if an endpoint is configured with a greater number. You can disable that check by turning this option off. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer (advanced)
        Parameters:
        limitConcurrentConsumers - the value to set
        Returns:
        the dsl builder

      • multipleConsumers

        default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder multipleConsumers​(boolean multipleConsumers)
        Specifies whether multiple consumers are allowed. If enabled, you can use SEDA for Publish-Subscribe messaging. That is, you can send a message to the SEDA queue and have each consumer receive a copy of the message. When enabled, this option should be specified on every consumer endpoint. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)
        Parameters:
        multipleConsumers - the value to set
        Returns:
        the dsl builder

      • multipleConsumers

        default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder multipleConsumers​(String multipleConsumers)
        Specifies whether multiple consumers are allowed. If enabled, you can use SEDA for Publish-Subscribe messaging. That is, you can send a message to the SEDA queue and have each consumer receive a copy of the message. When enabled, this option should be specified on every consumer endpoint. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)
        Parameters:
        multipleConsumers - the value to set
        Returns:
        the dsl builder

      • pollTimeout

        default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder pollTimeout​(int pollTimeout)
        The timeout (in milliseconds) used when polling. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. The option is a: <code>int</code> type. Default: 1000 Group: consumer (advanced)
        Parameters:
        pollTimeout - the value to set
        Returns:
        the dsl builder

      • pollTimeout

        default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder pollTimeout​(String pollTimeout)
        The timeout (in milliseconds) used when polling. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. The option will be converted to a <code>int</code> type. Default: 1000 Group: consumer (advanced)
        Parameters:
        pollTimeout - the value to set
        Returns:
        the dsl builder

      • purgeWhenStopping

        default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder purgeWhenStopping​(boolean purgeWhenStopping)
        Whether to purge the task queue when stopping the consumer/route. This allows to stop faster, as any pending messages on the queue is discarded. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)
        Parameters:
        purgeWhenStopping - the value to set
        Returns:
        the dsl builder

      • purgeWhenStopping

        default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder purgeWhenStopping​(String purgeWhenStopping)
        Whether to purge the task queue when stopping the consumer/route. This allows to stop faster, as any pending messages on the queue is discarded. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)
        Parameters:
        purgeWhenStopping - the value to set
        Returns:
        the dsl builder