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

Interface PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
PahoEndpointBuilderFactory.AdvancedPahoEndpointBuilder
Enclosing interface:
PahoEndpointBuilderFactory
public static interface PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the Paho component.

  • Method Details

    • basic

      default PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder basic()

    • bridgeErrorHandler

      default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder 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 PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder 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

    • exceptionHandler

      default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder 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 PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder 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 PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder 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 PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder 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

    • client

      default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder client(org.eclipse.paho.client.mqttv3.MqttClient client)
      To use an existing mqtt client. The option is a: org.eclipse.paho.client.mqttv3.MqttClient type. Group: advanced
      Parameters:
      client - the value to set
      Returns:
      the dsl builder

    • client

      default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder client(String client)
      To use an existing mqtt client. The option will be converted to a org.eclipse.paho.client.mqttv3.MqttClient type. Group: advanced
      Parameters:
      client - the value to set
      Returns:
      the dsl builder

    • customWebSocketHeaders

      default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder customWebSocketHeaders(Properties customWebSocketHeaders)
      Sets the Custom WebSocket Headers for the WebSocket Connection. The option is a: java.util.Properties type. Group: advanced
      Parameters:
      customWebSocketHeaders - the value to set
      Returns:
      the dsl builder

    • customWebSocketHeaders

      default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder customWebSocketHeaders(String customWebSocketHeaders)
      Sets the Custom WebSocket Headers for the WebSocket Connection. The option will be converted to a java.util.Properties type. Group: advanced
      Parameters:
      customWebSocketHeaders - the value to set
      Returns:
      the dsl builder

    • executorServiceTimeout

      default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder executorServiceTimeout(int executorServiceTimeout)
      Set the time in seconds that the executor service should wait when terminating before forcefully terminating. It is not recommended to change this value unless you are absolutely sure that you need to. The option is a: int type. Default: 1 Group: advanced
      Parameters:
      executorServiceTimeout - the value to set
      Returns:
      the dsl builder

    • executorServiceTimeout

      default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder executorServiceTimeout(String executorServiceTimeout)
      Set the time in seconds that the executor service should wait when terminating before forcefully terminating. It is not recommended to change this value unless you are absolutely sure that you need to. The option will be converted to a int type. Default: 1 Group: advanced
      Parameters:
      executorServiceTimeout - the value to set
      Returns:
      the dsl builder