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

Interface JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
JCacheEndpointBuilderFactory.AdvancedJCacheEndpointBuilder
Enclosing interface:
JCacheEndpointBuilderFactory
public static interface JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the JCache component.

  • Method Details

    • basic

      default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder basic()

    • bridgeErrorHandler

      default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder 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 JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder 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

    • eventFilters

      default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder eventFilters(List<javax.cache.event.CacheEntryEventFilter> eventFilters)
      The CacheEntryEventFilter. If using eventFilters option, then filteredEvents one will be ignored. The option is a: java.util.List<javax.cache.event.CacheEntryEventFilter> type. Group: consumer (advanced)
      Parameters:
      eventFilters - the value to set
      Returns:
      the dsl builder

    • eventFilters

      default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder eventFilters(String eventFilters)
      The CacheEntryEventFilter. If using eventFilters option, then filteredEvents one will be ignored. The option will be converted to a java.util.List<javax.cache.event.CacheEntryEventFilter> type. Group: consumer (advanced)
      Parameters:
      eventFilters - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder 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 JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder 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 JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder 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 JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder 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

    • cacheConfiguration

      default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder cacheConfiguration(javax.cache.configuration.Configuration cacheConfiguration)
      A Configuration for the Cache. The option is a: javax.cache.configuration.Configuration type. Group: advanced
      Parameters:
      cacheConfiguration - the value to set
      Returns:
      the dsl builder

    • cacheConfiguration

      default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder cacheConfiguration(String cacheConfiguration)
      A Configuration for the Cache. The option will be converted to a javax.cache.configuration.Configuration type. Group: advanced
      Parameters:
      cacheConfiguration - the value to set
      Returns:
      the dsl builder

    • cacheLoaderFactory

      default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder cacheLoaderFactory(javax.cache.configuration.Factory<javax.cache.integration.CacheLoader> cacheLoaderFactory)
      The CacheLoader factory. The option is a: javax.cache.configuration.Factory<javax.cache.integration.CacheLoader> type. Group: advanced
      Parameters:
      cacheLoaderFactory - the value to set
      Returns:
      the dsl builder

    • cacheLoaderFactory

      default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder cacheLoaderFactory(String cacheLoaderFactory)
      The CacheLoader factory. The option will be converted to a javax.cache.configuration.Factory<javax.cache.integration.CacheLoader> type. Group: advanced
      Parameters:
      cacheLoaderFactory - the value to set
      Returns:
      the dsl builder

    • cacheWriterFactory

      default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder cacheWriterFactory(javax.cache.configuration.Factory<javax.cache.integration.CacheWriter> cacheWriterFactory)
      The CacheWriter factory. The option is a: javax.cache.configuration.Factory<javax.cache.integration.CacheWriter> type. Group: advanced
      Parameters:
      cacheWriterFactory - the value to set
      Returns:
      the dsl builder

    • cacheWriterFactory

      default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder cacheWriterFactory(String cacheWriterFactory)
      The CacheWriter factory. The option will be converted to a javax.cache.configuration.Factory<javax.cache.integration.CacheWriter> type. Group: advanced
      Parameters:
      cacheWriterFactory - the value to set
      Returns:
      the dsl builder

    • createCacheIfNotExists

      default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder createCacheIfNotExists(boolean createCacheIfNotExists)
      Configure if a cache need to be created if it does exist or can't be pre-configured. The option is a: boolean type. Default: true Group: advanced
      Parameters:
      createCacheIfNotExists - the value to set
      Returns:
      the dsl builder

    • createCacheIfNotExists

      default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder createCacheIfNotExists(String createCacheIfNotExists)
      Configure if a cache need to be created if it does exist or can't be pre-configured. The option will be converted to a boolean type. Default: true Group: advanced
      Parameters:
      createCacheIfNotExists - the value to set
      Returns:
      the dsl builder

    • expiryPolicyFactory

      default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder expiryPolicyFactory(javax.cache.configuration.Factory<javax.cache.expiry.ExpiryPolicy> expiryPolicyFactory)
      The ExpiryPolicy factory. The option is a: javax.cache.configuration.Factory<javax.cache.expiry.ExpiryPolicy> type. Group: advanced
      Parameters:
      expiryPolicyFactory - the value to set
      Returns:
      the dsl builder

    • expiryPolicyFactory

      default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder expiryPolicyFactory(String expiryPolicyFactory)
      The ExpiryPolicy factory. The option will be converted to a javax.cache.configuration.Factory<javax.cache.expiry.ExpiryPolicy> type. Group: advanced
      Parameters:
      expiryPolicyFactory - the value to set
      Returns:
      the dsl builder

    • lookupProviders

      default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder lookupProviders(boolean lookupProviders)
      Configure if a camel-cache should try to find implementations of jcache api in runtimes like OSGi. The option is a: boolean type. Default: false Group: advanced
      Parameters:
      lookupProviders - the value to set
      Returns:
      the dsl builder

    • lookupProviders

      default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder lookupProviders(String lookupProviders)
      Configure if a camel-cache should try to find implementations of jcache api in runtimes like OSGi. The option will be converted to a boolean type. Default: false Group: advanced
      Parameters:
      lookupProviders - the value to set
      Returns:
      the dsl builder