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

Interface KafkaEndpointBuilderFactory.AdvancedKafkaEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    KafkaEndpointBuilderFactory.AdvancedKafkaEndpointBuilder
    Enclosing interface:
    KafkaEndpointBuilderFactory
    public static interface KafkaEndpointBuilderFactory.AdvancedKafkaEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Advanced builder for endpoint consumers for the Kafka component.

    • Method Detail

      • bridgeErrorHandler

        default KafkaEndpointBuilderFactory.AdvancedKafkaEndpointConsumerBuilder bridgeErrorHandler​(boolean bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • bridgeErrorHandler

        default KafkaEndpointBuilderFactory.AdvancedKafkaEndpointConsumerBuilder bridgeErrorHandler​(String bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • exceptionHandler

        default KafkaEndpointBuilderFactory.AdvancedKafkaEndpointConsumerBuilder 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 KafkaEndpointBuilderFactory.AdvancedKafkaEndpointConsumerBuilder 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 KafkaEndpointBuilderFactory.AdvancedKafkaEndpointConsumerBuilder 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 KafkaEndpointBuilderFactory.AdvancedKafkaEndpointConsumerBuilder 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

      • isolationLevel

        default KafkaEndpointBuilderFactory.AdvancedKafkaEndpointConsumerBuilder isolationLevel​(String isolationLevel)
        Controls how to read messages written transactionally. If set to read_committed, consumer.poll() will only return transactional messages which have been committed. If set to read_uncommitted (the default), consumer.poll() will return all messages, even transactional messages which have been aborted. Non-transactional messages will be returned unconditionally in either mode. Messages will always be returned in offset order. Hence, in read_committed mode, consumer.poll() will only return messages up to the last stable offset (LSO), which is the one less than the offset of the first open transaction. In particular any messages appearing after messages belonging to ongoing transactions will be withheld until the relevant transaction has been completed. As a result, read_committed consumers will not be able to read up to the high watermark when there are in flight transactions. Further, when in read_committed the seekToEnd method will return the LSO. The option is a: <code>java.lang.String</code> type. Default: read_uncommitted Group: consumer (advanced)
        Parameters:
        isolationLevel - the value to set
        Returns:
        the dsl builder

      • kafkaManualCommitFactory

        default KafkaEndpointBuilderFactory.AdvancedKafkaEndpointConsumerBuilder kafkaManualCommitFactory​(org.apache.camel.component.kafka.consumer.KafkaManualCommitFactory kafkaManualCommitFactory)
        Factory to use for creating KafkaManualCommit instances. This allows to plugin a custom factory to create custom KafkaManualCommit instances in case special logic is needed when doing manual commits that deviates from the default implementation that comes out of the box. The option is a: <code>org.apache.camel.component.kafka.consumer.KafkaManualCommitFactory</code> type. Group: consumer (advanced)
        Parameters:
        kafkaManualCommitFactory - the value to set
        Returns:
        the dsl builder

      • kafkaManualCommitFactory

        default KafkaEndpointBuilderFactory.AdvancedKafkaEndpointConsumerBuilder kafkaManualCommitFactory​(String kafkaManualCommitFactory)
        Factory to use for creating KafkaManualCommit instances. This allows to plugin a custom factory to create custom KafkaManualCommit instances in case special logic is needed when doing manual commits that deviates from the default implementation that comes out of the box. The option will be converted to a <code>org.apache.camel.component.kafka.consumer.KafkaManualCommitFactory</code> type. Group: consumer (advanced)
        Parameters:
        kafkaManualCommitFactory - the value to set
        Returns:
        the dsl builder

      • kafkaClientFactory

        default KafkaEndpointBuilderFactory.AdvancedKafkaEndpointConsumerBuilder kafkaClientFactory​(org.apache.camel.component.kafka.KafkaClientFactory kafkaClientFactory)
        Factory to use for creating org.apache.kafka.clients.consumer.KafkaConsumer and org.apache.kafka.clients.producer.KafkaProducer instances. This allows to configure a custom factory to create instances with logic that extends the vanilla Kafka clients. The option is a: <code>org.apache.camel.component.kafka.KafkaClientFactory</code> type. Group: advanced
        Parameters:
        kafkaClientFactory - the value to set
        Returns:
        the dsl builder

      • kafkaClientFactory

        default KafkaEndpointBuilderFactory.AdvancedKafkaEndpointConsumerBuilder kafkaClientFactory​(String kafkaClientFactory)
        Factory to use for creating org.apache.kafka.clients.consumer.KafkaConsumer and org.apache.kafka.clients.producer.KafkaProducer instances. This allows to configure a custom factory to create instances with logic that extends the vanilla Kafka clients. The option will be converted to a <code>org.apache.camel.component.kafka.KafkaClientFactory</code> type. Group: advanced
        Parameters:
        kafkaClientFactory - the value to set
        Returns:
        the dsl builder

      • synchronous

        default KafkaEndpointBuilderFactory.AdvancedKafkaEndpointConsumerBuilder synchronous​(boolean synchronous)
        Sets whether synchronous processing should be strictly used. The option is a: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        synchronous - the value to set
        Returns:
        the dsl builder