org.apache.camel.builder.endpoint.dsl

Interface JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

JCacheEndpointBuilderFactory.JCacheEndpointBuilder

Enclosing interface:

JCacheEndpointBuilderFactory

public static interface JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the JCache component.

Method Summary

Modifier and Type	Method and Description
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	action(String action) To configure using a cache operation by default.
default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointProducerBuilder	advanced()
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	cacheConfiguration(Object cacheConfiguration) A Configuration for the Cache.
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	cacheConfiguration(String cacheConfiguration) A Configuration for the Cache.
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	cacheConfigurationProperties(Map cacheConfigurationProperties) The Properties for the javax.cache.spi.CachingProvider to create the CacheManager.
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	cacheConfigurationProperties(String cacheConfigurationProperties) The Properties for the javax.cache.spi.CachingProvider to create the CacheManager.
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	cachingProvider(String cachingProvider) The fully qualified class name of the javax.cache.spi.CachingProvider.
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	configurationUri(String configurationUri) An implementation specific URI for the CacheManager.
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	managementEnabled(boolean managementEnabled) Whether management gathering is enabled.
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	managementEnabled(String managementEnabled) Whether management gathering is enabled.
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	readThrough(boolean readThrough) If read-through caching should be used.
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	readThrough(String readThrough) If read-through caching should be used.
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	statisticsEnabled(boolean statisticsEnabled) Whether statistics gathering is enabled.
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	statisticsEnabled(String statisticsEnabled) Whether statistics gathering is enabled.
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	storeByValue(boolean storeByValue) If cache should use store-by-value or store-by-reference semantics.
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	storeByValue(String storeByValue) If cache should use store-by-value or store-by-reference semantics.
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	writeThrough(boolean writeThrough) If write-through caching should be used.
default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder	writeThrough(String writeThrough) If write-through caching should be used.

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 JCacheEndpointBuilderFactory.AdvancedJCacheEndpointProducerBuilder advanced()

cacheConfiguration

default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder cacheConfiguration(Object cacheConfiguration)

A Configuration for the Cache. The option is a: <code>javax.cache.configuration.Configuration</code> type. Group: common

Parameters:

cacheConfiguration - the value to set

Returns:

the dsl builder

cacheConfiguration

default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder cacheConfiguration(String cacheConfiguration)

A Configuration for the Cache. The option will be converted to a <code>javax.cache.configuration.Configuration</code> type. Group: common

Parameters:

cacheConfiguration - the value to set

Returns:

the dsl builder

cacheConfigurationProperties

default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder cacheConfigurationProperties(Map cacheConfigurationProperties)

The Properties for the javax.cache.spi.CachingProvider to create the CacheManager. The option is a: <code>java.util.Map</code> type. Group: common

Parameters:

cacheConfigurationProperties - the value to set

Returns:

the dsl builder

cacheConfigurationProperties

default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder cacheConfigurationProperties(String cacheConfigurationProperties)

The Properties for the javax.cache.spi.CachingProvider to create the CacheManager. The option will be converted to a <code>java.util.Map</code> type. Group: common

Parameters:

cacheConfigurationProperties - the value to set

Returns:

the dsl builder

cachingProvider

default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder cachingProvider(String cachingProvider)

The fully qualified class name of the javax.cache.spi.CachingProvider. The option is a: <code>java.lang.String</code> type. Group: common

Parameters:

cachingProvider - the value to set

Returns:

the dsl builder

configurationUri

default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder configurationUri(String configurationUri)

An implementation specific URI for the CacheManager. The option is a: <code>java.lang.String</code> type. Group: common

Parameters:

configurationUri - the value to set

Returns:

the dsl builder

managementEnabled

default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder managementEnabled(boolean managementEnabled)

Whether management gathering is enabled. The option is a: <code>boolean</code> type. Default: false Group: common

Parameters:

managementEnabled - the value to set

Returns:

the dsl builder

managementEnabled

default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder managementEnabled(String managementEnabled)

Whether management gathering is enabled. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Parameters:

managementEnabled - the value to set

Returns:

the dsl builder

readThrough

default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder readThrough(boolean readThrough)

If read-through caching should be used. The option is a: <code>boolean</code> type. Default: false Group: common

Parameters:

readThrough - the value to set

Returns:

the dsl builder

readThrough

default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder readThrough(String readThrough)

If read-through caching should be used. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Parameters:

readThrough - the value to set

Returns:

the dsl builder

statisticsEnabled

default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder statisticsEnabled(boolean statisticsEnabled)

Whether statistics gathering is enabled. The option is a: <code>boolean</code> type. Default: false Group: common

Parameters:

statisticsEnabled - the value to set

Returns:

the dsl builder

statisticsEnabled

default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder statisticsEnabled(String statisticsEnabled)

Whether statistics gathering is enabled. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Parameters:

statisticsEnabled - the value to set

Returns:

the dsl builder

storeByValue

default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder storeByValue(boolean storeByValue)

If cache should use store-by-value or store-by-reference semantics. The option is a: <code>boolean</code> type. Default: true Group: common

Parameters:

storeByValue - the value to set

Returns:

the dsl builder

storeByValue

default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder storeByValue(String storeByValue)

If cache should use store-by-value or store-by-reference semantics. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Parameters:

storeByValue - the value to set

Returns:

the dsl builder

writeThrough

default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder writeThrough(boolean writeThrough)

If write-through caching should be used. The option is a: <code>boolean</code> type. Default: false Group: common

Parameters:

writeThrough - the value to set

Returns:

the dsl builder

writeThrough

default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder writeThrough(String writeThrough)

If write-through caching should be used. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Parameters:

writeThrough - the value to set

Returns:

the dsl builder

action

default JCacheEndpointBuilderFactory.JCacheEndpointProducerBuilder action(String action)

To configure using a cache operation by default. If an operation 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

lazyStartProducer

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