Package 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 Detail

      • 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

      • createCacheIfNotExist

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

      • createCacheIfNotExist

        default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder createCacheIfNotExist​(String createCacheIfNotExist)
        Automatic create the Caffeine cache if none has been configured or exists in the registry. 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​(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

      • 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)
        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

      • expireAfterAccessTime

        default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder expireAfterAccessTime​(String 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 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)
        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

      • expireAfterWriteTime

        default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder expireAfterWriteTime​(String 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 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​(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

      • initialCapacity

        default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder initialCapacity​(String 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 will be converted to a <code>java.lang.Integer</code> type. 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

      • maximumSize

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

      • maximumSize

        default CaffeineCacheEndpointBuilderFactory.CaffeineCacheEndpointBuilder maximumSize​(String 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 will be converted to a <code>java.lang.Integer</code> type. Group: producer
        Parameters:
        maximumSize - the value to set
        Returns:
        the dsl builder