org.apache.camel.builder.component.dsl

Interface EhcacheComponentBuilderFactory.EhcacheComponentBuilder

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.ehcache.EhcacheComponent>

All Known Implementing Classes:

EhcacheComponentBuilderFactory.EhcacheComponentBuilderImpl

Enclosing interface:

EhcacheComponentBuilderFactory

public static interface EhcacheComponentBuilderFactory.EhcacheComponentBuilder
extends ComponentBuilder<org.apache.camel.component.ehcache.EhcacheComponent>

Builder for the Ehcache component.

Method Summary

Modifier and Type	Method and Description
default EhcacheComponentBuilderFactory.EhcacheComponentBuilder	action(String action) To configure the default cache action.
default EhcacheComponentBuilderFactory.EhcacheComponentBuilder	autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled.
default EhcacheComponentBuilderFactory.EhcacheComponentBuilder	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 EhcacheComponentBuilderFactory.EhcacheComponentBuilder	cacheManager(org.ehcache.CacheManager cacheManager) The cache manager.
default EhcacheComponentBuilderFactory.EhcacheComponentBuilder	cacheManagerConfiguration(org.ehcache.config.Configuration cacheManagerConfiguration) The cache manager configuration.
default EhcacheComponentBuilderFactory.EhcacheComponentBuilder	configuration(org.ehcache.config.CacheConfiguration configuration) The default cache configuration to be used to create caches.
default EhcacheComponentBuilderFactory.EhcacheComponentBuilder	configurations(Map<String,org.ehcache.config.CacheConfiguration> configurations) A map of cache configuration to be used to create caches.
default EhcacheComponentBuilderFactory.EhcacheComponentBuilder	configurationUri(String configurationUri) URI pointing to the Ehcache XML configuration file's location.
default EhcacheComponentBuilderFactory.EhcacheComponentBuilder	createCacheIfNotExist(boolean createCacheIfNotExist) Configure if a cache need to be created if it does exist or can't be pre-configured.
default EhcacheComponentBuilderFactory.EhcacheComponentBuilder	eventFiring(org.ehcache.event.EventFiring eventFiring) Set the delivery mode (synchronous, asynchronous).
default EhcacheComponentBuilderFactory.EhcacheComponentBuilder	eventOrdering(org.ehcache.event.EventOrdering eventOrdering) Set the delivery mode (ordered, unordered).
default EhcacheComponentBuilderFactory.EhcacheComponentBuilder	eventTypes(String eventTypes) Set the type of events to listen for (EVICTED,EXPIRED,REMOVED,CREATED,UPDATED).
default EhcacheComponentBuilderFactory.EhcacheComponentBuilder	key(Object key) To configure the default action key.
default EhcacheComponentBuilderFactory.EhcacheComponentBuilder	keyType(String keyType) The cache key type, default java.lang.Object.
default EhcacheComponentBuilderFactory.EhcacheComponentBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default EhcacheComponentBuilderFactory.EhcacheComponentBuilder	valueType(String valueType) The cache value type, default java.lang.Object.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

build, build, doSetProperty, register

Method Detail

cacheManager

default EhcacheComponentBuilderFactory.EhcacheComponentBuilder cacheManager(org.ehcache.CacheManager cacheManager)

The cache manager. The option is a: <code>org.ehcache.CacheManager</code> type. Group: common

Parameters:

cacheManager - the value to set

Returns:

the dsl builder

cacheManagerConfiguration

default EhcacheComponentBuilderFactory.EhcacheComponentBuilder cacheManagerConfiguration(org.ehcache.config.Configuration cacheManagerConfiguration)

The cache manager configuration. The option is a: <code>org.ehcache.config.Configuration</code> type. Group: common

Parameters:

cacheManagerConfiguration - the value to set

Returns:

the dsl builder

configurationUri

default EhcacheComponentBuilderFactory.EhcacheComponentBuilder configurationUri(String configurationUri)

URI pointing to the Ehcache XML configuration file's location. The option is a: <code>java.lang.String</code> type. Group: common

Parameters:

configurationUri - the value to set

Returns:

the dsl builder

createCacheIfNotExist

default EhcacheComponentBuilderFactory.EhcacheComponentBuilder 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: common

Parameters:

createCacheIfNotExist - the value to set

Returns:

the dsl builder

bridgeErrorHandler

default EhcacheComponentBuilderFactory.EhcacheComponentBuilder 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

eventFiring

default EhcacheComponentBuilderFactory.EhcacheComponentBuilder eventFiring(org.ehcache.event.EventFiring eventFiring)

Set the delivery mode (synchronous, asynchronous). The option is a: <code>org.ehcache.event.EventFiring</code> type. Default: ASYNCHRONOUS Group: consumer

Parameters:

eventFiring - the value to set

Returns:

the dsl builder

eventOrdering

default EhcacheComponentBuilderFactory.EhcacheComponentBuilder eventOrdering(org.ehcache.event.EventOrdering eventOrdering)

Set the delivery mode (ordered, unordered). The option is a: <code>org.ehcache.event.EventOrdering</code> type. Default: ORDERED Group: consumer

Parameters:

eventOrdering - the value to set

Returns:

the dsl builder

eventTypes

default EhcacheComponentBuilderFactory.EhcacheComponentBuilder eventTypes(String eventTypes)

Set the type of events to listen for (EVICTED,EXPIRED,REMOVED,CREATED,UPDATED). You can specify multiple entries separated by comma. The option is a: <code>java.lang.String</code> type. Group: consumer

Parameters:

eventTypes - the value to set

Returns:

the dsl builder

action

default EhcacheComponentBuilderFactory.EhcacheComponentBuilder 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

key

default EhcacheComponentBuilderFactory.EhcacheComponentBuilder 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

lazyStartProducer

default EhcacheComponentBuilderFactory.EhcacheComponentBuilder 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

autowiredEnabled

default EhcacheComponentBuilderFactory.EhcacheComponentBuilder 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

configuration

default EhcacheComponentBuilderFactory.EhcacheComponentBuilder configuration(org.ehcache.config.CacheConfiguration configuration)

The default cache configuration to be used to create caches. The option is a: <code>org.ehcache.config.CacheConfiguration</code> type. Group: advanced

Parameters:

configuration - the value to set

Returns:

the dsl builder

configurations

default EhcacheComponentBuilderFactory.EhcacheComponentBuilder configurations(Map<String,org.ehcache.config.CacheConfiguration> configurations)

A map of cache configuration to be used to create caches. The option is a: <code>java.util.Map&lt;java.lang.String, org.ehcache.config.CacheConfiguration&gt;</code> type. Group: advanced

Parameters:

configurations - the value to set

Returns:

the dsl builder

keyType

default EhcacheComponentBuilderFactory.EhcacheComponentBuilder keyType(String keyType)

The cache key type, default java.lang.Object. The option is a: <code>java.lang.String</code> type. Group: advanced

Parameters:

keyType - the value to set

Returns:

the dsl builder

valueType

default EhcacheComponentBuilderFactory.EhcacheComponentBuilder 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