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

Interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointBuilder
Enclosing interface:
PahoMqtt5EndpointBuilderFactory
public static interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the Paho MQTT 5 component.

  • Method Details

    • basic

      default PahoMqtt5EndpointBuilderFactory.PahoMqtt5EndpointConsumerBuilder basic()

    • bridgeErrorHandler

      default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder 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 PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder 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 PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder 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 PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder 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 PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder 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 PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder 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 PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder client(org.eclipse.paho.mqttv5.client.MqttClient client)
      To use an existing mqtt client. The option is a: org.eclipse.paho.mqttv5.client.MqttClient type. Group: advanced
      Parameters:
      client - the value to set
      Returns:
      the dsl builder

    • client

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

    • customWebSocketHeaders

      default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder customWebSocketHeaders(Map<String,String> customWebSocketHeaders)
      Sets the Custom WebSocket Headers for the WebSocket Connection. The option is a: java.util.Map<java.lang.String, java.lang.String> type. Group: advanced
      Parameters:
      customWebSocketHeaders - the value to set
      Returns:
      the dsl builder

    • customWebSocketHeaders

      default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder customWebSocketHeaders(String customWebSocketHeaders)
      Sets the Custom WebSocket Headers for the WebSocket Connection. The option will be converted to a java.util.Map<java.lang.String, java.lang.String> type. Group: advanced
      Parameters:
      customWebSocketHeaders - the value to set
      Returns:
      the dsl builder

    • executorServiceTimeout

      default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder 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 PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder 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