org.apache.camel.builder.endpoint.dsl

Interface CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

CaffeineCacheEndpointBuilderFactory

public static interface CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the Caffeine Cache component.

Method Summary

Modifier and Type	Method and Description
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	action(String action) To configure the default cache action.
default CaffeineCacheEndpointBuilderFactory.AdvancedCaffeineCacheEndpointBuilder	advanced()
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	cacheLoader(Object cacheLoader) To configure a CacheLoader in case of a LoadCache use.
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	cacheLoader(String cacheLoader) To configure a CacheLoader in case of a LoadCache use.
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	createCacheIfNotExist(boolean createCacheIfNotExist) Configure if a cache need to be created if it does exist or can't be pre-configured.
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	createCacheIfNotExist(String createCacheIfNotExist) Configure if a cache need to be created if it does exist or can't be pre-configured.
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	evictionType(CaffeineCacheEndpointBuilderFactory.EvictionType evictionType) Set the eviction Type for this cache.
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	evictionType(String evictionType) Set the eviction Type for this cache.
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	expireAfterAccessTime(int expireAfterAccessTime) Set the expire After Access Time in case of time based Eviction (in seconds).
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	expireAfterAccessTime(String expireAfterAccessTime) Set the expire After Access Time in case of time based Eviction (in seconds).
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	expireAfterWriteTime(int expireAfterWriteTime) Set the expire After Access Write in case of time based Eviction (in seconds).
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	expireAfterWriteTime(String expireAfterWriteTime) Set the expire After Access Write in case of time based Eviction (in seconds).
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	initialCapacity(int initialCapacity) Set the initial Capacity for the cache.
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	initialCapacity(String initialCapacity) Set the initial Capacity for the cache.
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	key(Object key) To configure the default action key.
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	key(String key) To configure the default action key.
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	maximumSize(int maximumSize) Set the maximum size for the cache.
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	maximumSize(String maximumSize) Set the maximum size for the cache.
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	removalListener(Object removalListener) Set a specific removal Listener for the cache.
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	removalListener(String removalListener) Set a specific removal Listener for the cache.
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	statsCounter(Object statsCounter) Set a specific Stats Counter for the cache stats.
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	statsCounter(String statsCounter) Set a specific Stats Counter for the cache stats.
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	statsEnabled(boolean statsEnabled) To enable stats on the cache.
default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder	statsEnabled(String statsEnabled) To enable stats on the cache.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default CaffeineCacheEndpointBuilderFactory.AdvancedCaffeineCacheEndpointBuilder advanced()

action

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder 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

cacheLoader

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder cacheLoader(Object 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: producer

Parameters:

cacheLoader - the value to set

Returns:

the dsl builder

cacheLoader

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder cacheLoader(String cacheLoader)

To configure a CacheLoader in case of a LoadCache use. The option will be converted to a <code>com.github.benmanes.caffeine.cache.CacheLoader</code> type. Group: producer

Parameters:

cacheLoader - the value to set

Returns:

the dsl builder

createCacheIfNotExist

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder createCacheIfNotExist(boolean createCacheIfNotExist)

Configure if a cache need to be created if it does exist or can't be pre-configured. The option is a: <code>boolean</code> type. Default: true Group: producer

Parameters:

createCacheIfNotExist - the value to set

Returns:

the dsl builder

createCacheIfNotExist

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder createCacheIfNotExist(String createCacheIfNotExist)

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 <code>boolean</code> type. Default: true Group: producer

Parameters:

createCacheIfNotExist - the value to set

Returns:

the dsl builder

evictionType

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder evictionType(CaffeineCacheEndpointBuilderFactory.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

evictionType

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder evictionType(String evictionType)

Set the eviction Type for this cache. The option will be converted to 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 CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder expireAfterAccessTime(int expireAfterAccessTime)

Set the expire After Access Time in case of time based Eviction (in seconds). The option is a: <code>int</code> type. Default: 300 Group: producer

Parameters:

expireAfterAccessTime - the value to set

Returns:

the dsl builder

expireAfterAccessTime

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder expireAfterAccessTime(String expireAfterAccessTime)

Set the expire After Access Time in case of time based Eviction (in seconds). The option will be converted to a <code>int</code> type. Default: 300 Group: producer

Parameters:

expireAfterAccessTime - the value to set

Returns:

the dsl builder

expireAfterWriteTime

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder expireAfterWriteTime(int expireAfterWriteTime)

Set the expire After Access Write in case of time based Eviction (in seconds). The option is a: <code>int</code> type. Default: 300 Group: producer

Parameters:

expireAfterWriteTime - the value to set

Returns:

the dsl builder

expireAfterWriteTime

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder expireAfterWriteTime(String expireAfterWriteTime)

Set the expire After Access Write in case of time based Eviction (in seconds). The option will be converted to a <code>int</code> type. Default: 300 Group: producer

Parameters:

expireAfterWriteTime - the value to set

Returns:

the dsl builder

initialCapacity

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder initialCapacity(int initialCapacity)

Set the initial Capacity for the cache. The option is a: <code>int</code> type. Default: 10000 Group: producer

Parameters:

initialCapacity - the value to set

Returns:

the dsl builder

initialCapacity

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder initialCapacity(String initialCapacity)

Set the initial Capacity for the cache. The option will be converted to a <code>int</code> type. Default: 10000 Group: producer

Parameters:

initialCapacity - the value to set

Returns:

the dsl builder

key

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder key(Object 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.Object</code> type. Group: producer

Parameters:

key - the value to set

Returns:

the dsl builder

key

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder 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 will be converted to a <code>java.lang.Object</code> type. Group: producer

Parameters:

key - the value to set

Returns:

the dsl builder

lazyStartProducer

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder 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

lazyStartProducer

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder lazyStartProducer(String 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 will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

maximumSize

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder maximumSize(int maximumSize)

Set the maximum size for the cache. The option is a: <code>int</code> type. Default: 10000 Group: producer

Parameters:

maximumSize - the value to set

Returns:

the dsl builder

maximumSize

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder maximumSize(String maximumSize)

Set the maximum size for the cache. The option will be converted to a <code>int</code> type. Default: 10000 Group: producer

Parameters:

maximumSize - the value to set

Returns:

the dsl builder

removalListener

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder removalListener(Object removalListener)

Set a specific removal Listener for the cache. The option is a: <code>com.github.benmanes.caffeine.cache.RemovalListener</code> type. Group: producer

Parameters:

removalListener - the value to set

Returns:

the dsl builder

removalListener

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder removalListener(String removalListener)

Set a specific removal Listener for the cache. The option will be converted to a <code>com.github.benmanes.caffeine.cache.RemovalListener</code> type. Group: producer

Parameters:

removalListener - the value to set

Returns:

the dsl builder

statsCounter

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder statsCounter(Object 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: producer

Parameters:

statsCounter - the value to set

Returns:

the dsl builder

statsCounter

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder statsCounter(String statsCounter)

Set a specific Stats Counter for the cache stats. The option will be converted to a <code>com.github.benmanes.caffeine.cache.stats.StatsCounter</code> type. Group: producer

Parameters:

statsCounter - the value to set

Returns:

the dsl builder

statsEnabled

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder statsEnabled(boolean statsEnabled)

To enable stats on the cache. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

statsEnabled - the value to set

Returns:

the dsl builder

statsEnabled

default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder statsEnabled(String statsEnabled)

To enable stats on the cache. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

statsEnabled - the value to set

Returns:

the dsl builder