org.apache.camel.builder.endpoint.dsl

Interface JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

JCacheEndpointBuilderFactory.JCacheEndpointBuilder

Enclosing interface:

JCacheEndpointBuilderFactory

public static interface JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint consumers for the JCache component.

Method Summary

Modifier and Type	Method and Description
default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder	advanced()
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	bridgeErrorHandler(boolean bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	bridgeErrorHandler(String bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	cacheConfiguration(Object cacheConfiguration) A Configuration for the Cache.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	cacheConfiguration(String cacheConfiguration) A Configuration for the Cache.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	cacheConfigurationProperties(Map cacheConfigurationProperties) The Properties for the javax.cache.spi.CachingProvider to create the CacheManager.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	cacheConfigurationProperties(String cacheConfigurationProperties) The Properties for the javax.cache.spi.CachingProvider to create the CacheManager.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	cachingProvider(String cachingProvider) The fully qualified class name of the javax.cache.spi.CachingProvider.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	configurationUri(String configurationUri) An implementation specific URI for the CacheManager.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	filteredEvents(String filteredEvents) Events a consumer should filter (multiple events can be separated by comma).
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	managementEnabled(boolean managementEnabled) Whether management gathering is enabled.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	managementEnabled(String managementEnabled) Whether management gathering is enabled.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	oldValueRequired(boolean oldValueRequired) if the old value is required for events.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	oldValueRequired(String oldValueRequired) if the old value is required for events.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	readThrough(boolean readThrough) If read-through caching should be used.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	readThrough(String readThrough) If read-through caching should be used.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	statisticsEnabled(boolean statisticsEnabled) Whether statistics gathering is enabled.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	statisticsEnabled(String statisticsEnabled) Whether statistics gathering is enabled.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	storeByValue(boolean storeByValue) If cache should use store-by-value or store-by-reference semantics.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	storeByValue(String storeByValue) If cache should use store-by-value or store-by-reference semantics.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	synchronous(boolean synchronous) if the event listener should block the thread causing the event.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	synchronous(String synchronous) if the event listener should block the thread causing the event.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	writeThrough(boolean writeThrough) If write-through caching should be used.
default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder	writeThrough(String writeThrough) If write-through caching should be used.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

advanced

default JCacheEndpointBuilderFactory.AdvancedJCacheEndpointConsumerBuilder advanced()

cacheConfiguration

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

bridgeErrorHandler

default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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: <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

bridgeErrorHandler

default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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 <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

filteredEvents

default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder filteredEvents(String filteredEvents)

Events a consumer should filter (multiple events can be separated by comma). If using filteredEvents option, then eventFilters one will be ignored. The option is a: <code>java.lang.String</code> type. Group: consumer

Parameters:

filteredEvents - the value to set

Returns:

the dsl builder

oldValueRequired

default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder oldValueRequired(boolean oldValueRequired)

if the old value is required for events. The option is a: <code>boolean</code> type. Default: false Group: consumer

Parameters:

oldValueRequired - the value to set

Returns:

the dsl builder

oldValueRequired

default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder oldValueRequired(String oldValueRequired)

if the old value is required for events. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer

Parameters:

oldValueRequired - the value to set

Returns:

the dsl builder

synchronous

default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder synchronous(boolean synchronous)

if the event listener should block the thread causing the event. The option is a: <code>boolean</code> type. Default: false Group: consumer

Parameters:

synchronous - the value to set

Returns:

the dsl builder

synchronous

default JCacheEndpointBuilderFactory.JCacheEndpointConsumerBuilder synchronous(String synchronous)

if the event listener should block the thread causing the event. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer

Parameters:

synchronous - the value to set

Returns:

the dsl builder