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

Interface JpaEndpointBuilderFactory.AdvancedJpaEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
JpaEndpointBuilderFactory.AdvancedJpaEndpointBuilder
Enclosing interface:
JpaEndpointBuilderFactory
public static interface JpaEndpointBuilderFactory.AdvancedJpaEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the JPA component.

  • Method Details

    • basic

      default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder basic()

    • bridgeErrorHandler

      default JpaEndpointBuilderFactory.AdvancedJpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.AdvancedJpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.AdvancedJpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.AdvancedJpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.AdvancedJpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.AdvancedJpaEndpointConsumerBuilder 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

    • parameters

      default JpaEndpointBuilderFactory.AdvancedJpaEndpointConsumerBuilder parameters(String key, Object value)
      This key/value mapping is used for building the query parameters. It is expected to be of the generic type java.util.Map where the keys are the named parameters of a given JPA query and the values are their corresponding effective values you want to select for. When it's used for producer, Simple expression can be used as a parameter value. It allows you to retrieve parameter values from the message body, header and etc. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the parameters(String, Object) method to add a value (call the method multiple times to set more values). Group: consumer (advanced)
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder

    • parameters

      default JpaEndpointBuilderFactory.AdvancedJpaEndpointConsumerBuilder parameters(Map values)
      This key/value mapping is used for building the query parameters. It is expected to be of the generic type java.util.Map where the keys are the named parameters of a given JPA query and the values are their corresponding effective values you want to select for. When it's used for producer, Simple expression can be used as a parameter value. It allows you to retrieve parameter values from the message body, header and etc. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the parameters(String, Object) method to add a value (call the method multiple times to set more values). Group: consumer (advanced)
      Parameters:
      values - the values
      Returns:
      the dsl builder

    • pollStrategy

      default JpaEndpointBuilderFactory.AdvancedJpaEndpointConsumerBuilder pollStrategy(org.apache.camel.spi.PollingConsumerPollStrategy pollStrategy)
      A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option is a: <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type. Group: consumer (advanced)
      Parameters:
      pollStrategy - the value to set
      Returns:
      the dsl builder

    • pollStrategy

      default JpaEndpointBuilderFactory.AdvancedJpaEndpointConsumerBuilder pollStrategy(String pollStrategy)
      A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option will be converted to a <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type. Group: consumer (advanced)
      Parameters:
      pollStrategy - the value to set
      Returns:
      the dsl builder

    • entityManagerProperties

      default JpaEndpointBuilderFactory.AdvancedJpaEndpointConsumerBuilder entityManagerProperties(String key, Object value)
      Additional properties for the entity manager to use. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the entityManagerProperties(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

    • entityManagerProperties

      default JpaEndpointBuilderFactory.AdvancedJpaEndpointConsumerBuilder entityManagerProperties(Map values)
      Additional properties for the entity manager to use. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the entityManagerProperties(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

    • sharedEntityManager

      default JpaEndpointBuilderFactory.AdvancedJpaEndpointConsumerBuilder sharedEntityManager(boolean sharedEntityManager)
      Whether to use Spring's SharedEntityManager for the consumer/producer. Note in most cases joinTransaction should be set to false as this is not an EXTENDED EntityManager. The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      sharedEntityManager - the value to set
      Returns:
      the dsl builder

    • sharedEntityManager

      default JpaEndpointBuilderFactory.AdvancedJpaEndpointConsumerBuilder sharedEntityManager(String sharedEntityManager)
      Whether to use Spring's SharedEntityManager for the consumer/producer. Note in most cases joinTransaction should be set to false as this is not an EXTENDED EntityManager. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      sharedEntityManager - the value to set
      Returns:
      the dsl builder