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

Interface OnceEndpointBuilderFactory.AdvancedOnceEndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
Enclosing interface:
OnceEndpointBuilderFactory
public static interface OnceEndpointBuilderFactory.AdvancedOnceEndpointBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint for the Once component.

  • Method Details

    • basic

      default OnceEndpointBuilderFactory.OnceEndpointBuilder basic()

    • bridgeErrorHandler

      default OnceEndpointBuilderFactory.AdvancedOnceEndpointBuilder 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 OnceEndpointBuilderFactory.AdvancedOnceEndpointBuilder 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 OnceEndpointBuilderFactory.AdvancedOnceEndpointBuilder 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 OnceEndpointBuilderFactory.AdvancedOnceEndpointBuilder 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 OnceEndpointBuilderFactory.AdvancedOnceEndpointBuilder 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 OnceEndpointBuilderFactory.AdvancedOnceEndpointBuilder 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

    • delay

      default OnceEndpointBuilderFactory.AdvancedOnceEndpointBuilder delay(long delay)
      The number of milliseconds to wait before triggering. The default value is 1000. The option is a: long type. Default: 1000 Group: advanced
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • delay

      default OnceEndpointBuilderFactory.AdvancedOnceEndpointBuilder delay(String delay)
      The number of milliseconds to wait before triggering. The default value is 1000. The option will be converted to a long type. Default: 1000 Group: advanced
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • exchangeProperties

      default OnceEndpointBuilderFactory.AdvancedOnceEndpointBuilder exchangeProperties(String key, Object value)
      The data to use as exchange properties as key=value pairs. You can externalize the data by using file: or classpath: as prefix and specify the location of the file. This is a multi-value option with prefix: exchangeProperty. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a: java.util.Map<java.lang.String, java.lang.String> type. The option is multivalued, and you can use the exchangeProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder

    • exchangeProperties

      default OnceEndpointBuilderFactory.AdvancedOnceEndpointBuilder exchangeProperties(Map values)
      The data to use as exchange properties as key=value pairs. You can externalize the data by using file: or classpath: as prefix and specify the location of the file. This is a multi-value option with prefix: exchangeProperty. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a: java.util.Map<java.lang.String, java.lang.String> type. The option is multivalued, and you can use the exchangeProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced
      Parameters:
      values - the values
      Returns:
      the dsl builder

    • variables

      default OnceEndpointBuilderFactory.AdvancedOnceEndpointBuilder variables(String key, Object value)
      The data to use as exchange variables as key=value pairs. You can externalize the data by using file: or classpath: as prefix and specify the location of the file. This is a multi-value option with prefix: variable. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a: java.util.Map<java.lang.String, java.lang.String> type. The option is multivalued, and you can use the variables(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder

    • variables

      default OnceEndpointBuilderFactory.AdvancedOnceEndpointBuilder variables(Map values)
      The data to use as exchange variables as key=value pairs. You can externalize the data by using file: or classpath: as prefix and specify the location of the file. This is a multi-value option with prefix: variable. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a: java.util.Map<java.lang.String, java.lang.String> type. The option is multivalued, and you can use the variables(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced
      Parameters:
      values - the values
      Returns:
      the dsl builder