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

Interface NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder
Enclosing interface:
NatsEndpointBuilderFactory
public static interface NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the Nats component.

  • Method Details

    • basic

      default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder basic()

    • bridgeErrorHandler

      default NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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 boolean type. Default: false Group: consumer (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • consumerConfiguration

      default NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder consumerConfiguration(io.nats.client.api.ConsumerConfiguration consumerConfiguration)
      Sets a custom ConsumerConfiguration object for the JetStream consumer. This is an advanced option typically used when you need to configure properties not exposed as simple Camel URI parameters. When set, this object will be used to build the final consumer subscription options. The option is a: io.nats.client.api.ConsumerConfiguration type. Group: consumer (advanced)
      Parameters:
      consumerConfiguration - the value to set
      Returns:
      the dsl builder

    • consumerConfiguration

      default NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder consumerConfiguration(String consumerConfiguration)
      Sets a custom ConsumerConfiguration object for the JetStream consumer. This is an advanced option typically used when you need to configure properties not exposed as simple Camel URI parameters. When set, this object will be used to build the final consumer subscription options. The option will be converted to a io.nats.client.api.ConsumerConfiguration type. Group: consumer (advanced)
      Parameters:
      consumerConfiguration - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder 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: org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder 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 org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option is a: org.apache.camel.ExchangePattern type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • exchangePattern

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

    • connection

      default NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder connection(io.nats.client.Connection connection)
      Reference an already instantiated connection to Nats server. The option is a: io.nats.client.Connection type. Group: advanced
      Parameters:
      connection - the value to set
      Returns:
      the dsl builder

    • connection

      default NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder connection(String connection)
      Reference an already instantiated connection to Nats server. The option will be converted to a io.nats.client.Connection type. Group: advanced
      Parameters:
      connection - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

      default NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
      To use a custom header filter strategy. The option is a: org.apache.camel.spi.HeaderFilterStrategy type. Group: advanced
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

      default NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder headerFilterStrategy(String headerFilterStrategy)
      To use a custom header filter strategy. The option will be converted to a org.apache.camel.spi.HeaderFilterStrategy type. Group: advanced
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • jetstreamAsync

      default NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder jetstreamAsync(boolean jetstreamAsync)
      Sets whether to operate JetStream requests asynchronously. The option is a: boolean type. Default: true Group: advanced
      Parameters:
      jetstreamAsync - the value to set
      Returns:
      the dsl builder

    • jetstreamAsync

      default NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder jetstreamAsync(String jetstreamAsync)
      Sets whether to operate JetStream requests asynchronously. The option will be converted to a boolean type. Default: true Group: advanced
      Parameters:
      jetstreamAsync - the value to set
      Returns:
      the dsl builder

    • traceConnection

      default NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder traceConnection(boolean traceConnection)
      Whether or not connection trace messages should be printed to standard out for fine grained debugging of connection issues. The option is a: boolean type. Default: false Group: advanced
      Parameters:
      traceConnection - the value to set
      Returns:
      the dsl builder

    • traceConnection

      default NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder traceConnection(String traceConnection)
      Whether or not connection trace messages should be printed to standard out for fine grained debugging of connection issues. The option will be converted to a boolean type. Default: false Group: advanced
      Parameters:
      traceConnection - the value to set
      Returns:
      the dsl builder