Package org.apache.camel.builder.component.dsl

Interface CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.caffeine.cache.CaffeineCacheComponent>
All Known Implementing Classes:
CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilderImpl
Enclosing interface:
CaffeineCacheComponentBuilderFactory
public static interface CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilder extends ComponentBuilder<org.apache.camel.component.caffeine.cache.CaffeineCacheComponent>
Builder for the Caffeine Cache component.

  • Method Details

    • action

      default CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilder action(String action)
      To configure the default cache action. If an action is set in the message header, then the operation from the header takes precedence. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      action - the value to set
      Returns:
      the dsl builder

    • createCacheIfNotExist

      default CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilder createCacheIfNotExist(boolean createCacheIfNotExist)
      Automatic create the Caffeine cache if none has been configured or exists in the registry. The option is a: <code>boolean</code> type. Default: true Group: producer
      Parameters:
      createCacheIfNotExist - the value to set
      Returns:
      the dsl builder

    • evictionType

      default CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilder evictionType(org.apache.camel.component.caffeine.EvictionType evictionType)
      Set the eviction Type for this cache. The option is a: <code>org.apache.camel.component.caffeine.EvictionType</code> type. Default: SIZE_BASED Group: producer
      Parameters:
      evictionType - the value to set
      Returns:
      the dsl builder

    • expireAfterAccessTime

      default CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilder expireAfterAccessTime(int expireAfterAccessTime)
      Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, the most recent replacement of its value, or its last read. Access time is reset by all cache read and write operations. The unit is in seconds. The option is a: <code>int</code> type. Default: 300 Group: producer
      Parameters:
      expireAfterAccessTime - the value to set
      Returns:
      the dsl builder

    • expireAfterWriteTime

      default CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilder expireAfterWriteTime(int expireAfterWriteTime)
      Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, or the most recent replacement of its value. The unit is in seconds. The option is a: <code>int</code> type. Default: 300 Group: producer
      Parameters:
      expireAfterWriteTime - the value to set
      Returns:
      the dsl builder

    • initialCapacity

      default CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilder initialCapacity(Integer initialCapacity)
      Sets the minimum total size for the internal data structures. Providing a large enough estimate at construction time avoids the need for expensive resizing operations later, but setting this value unnecessarily high wastes memory. The option is a: <code>java.lang.Integer</code> type. Group: producer
      Parameters:
      initialCapacity - the value to set
      Returns:
      the dsl builder

    • key

      default CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilder key(String key)
      To configure the default action key. If a key is set in the message header, then the key from the header takes precedence. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      key - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilder lazyStartProducer(boolean lazyStartProducer)
      Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • maximumSize

      default CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilder maximumSize(Integer maximumSize)
      Specifies the maximum number of entries the cache may contain. Note that the cache may evict an entry before this limit is exceeded or temporarily exceed the threshold while evicting. As the cache size grows close to the maximum, the cache evicts entries that are less likely to be used again. For example, the cache may evict an entry because it hasn't been used recently or very often. When size is zero, elements will be evicted immediately after being loaded into the cache. This can be useful in testing or to disable caching temporarily without a code change. As eviction is scheduled on the configured executor, tests may instead prefer to configure the cache to execute tasks directly on the same thread. The option is a: <code>java.lang.Integer</code> type. Group: producer
      Parameters:
      maximumSize - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • cacheLoader

      default CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilder cacheLoader(com.github.benmanes.caffeine.cache.CacheLoader cacheLoader)
      To configure a CacheLoader in case of a LoadCache use. The option is a: <code>com.github.benmanes.caffeine.cache.CacheLoader</code> type. Group: advanced
      Parameters:
      cacheLoader - the value to set
      Returns:
      the dsl builder

    • configuration

      default CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilder configuration(org.apache.camel.component.caffeine.CaffeineConfiguration configuration)
      Sets the global component configuration. The option is a: <code>org.apache.camel.component.caffeine.CaffeineConfiguration</code> type. Group: advanced
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • removalListener

      default CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilder removalListener(com.github.benmanes.caffeine.cache.RemovalListener removalListener)
      Set a specific removal Listener for the cache. The option is a: <code>com.github.benmanes.caffeine.cache.RemovalListener</code> type. Group: advanced
      Parameters:
      removalListener - the value to set
      Returns:
      the dsl builder

    • statsCounter

      default CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilder statsCounter(com.github.benmanes.caffeine.cache.stats.StatsCounter statsCounter)
      Set a specific Stats Counter for the cache stats. The option is a: <code>com.github.benmanes.caffeine.cache.stats.StatsCounter</code> type. Group: advanced
      Parameters:
      statsCounter - the value to set
      Returns:
      the dsl builder

    • statsEnabled

      default CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilder statsEnabled(boolean statsEnabled)
      To enable stats on the cache. The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      statsEnabled - the value to set
      Returns:
      the dsl builder

    • valueType

      default CaffeineCacheComponentBuilderFactory.CaffeineCacheComponentBuilder valueType(String valueType)
      The cache value type, default java.lang.Object. The option is a: <code>java.lang.String</code> type. Group: advanced
      Parameters:
      valueType - the value to set
      Returns:
      the dsl builder