org.apache.camel.component.cache

Class CacheEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.cache.CacheEndpoint

All Implemented Interfaces:

CamelContextAware, Endpoint, IsSingleton, Service, ShutdownableService, HasId, StatefulService, SuspendableService

@UriEndpoint(scheme="cache",
             title="EHCache",
             syntax="cache:cacheName",
             consumerClass=CacheConsumer.class,
             label="cache")
public class CacheEndpoint
extends DefaultEndpoint

The cache component enables you to perform caching operations using EHCache as the Cache Implementation. The cache itself is created on demand or if a cache of that name already exists then it is simply utilized with its original settings. This component supports producer and event based consumer endpoints. The Cache consumer is an event based consumer and can be used to listen and respond to specific cache activities. If you need to perform selections from a pre-existing cache, use the processors defined for the cache component.

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
CacheEndpoint()
CacheEndpoint(String endpointUri, Component component, CacheConfiguration config, CacheManagerFactory cacheManagerFactory)

Method Summary

Modifier and Type	Method and Description
Exchange	createCacheExchange(String operation, String key, Object value)
Consumer	createConsumer(Processor processor) Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor
Producer	createProducer() Creates a new producer which is used send messages into the endpoint
CacheManagerFactory	getCacheManagerFactory()
CacheConfiguration	getConfig()
String	getKey()
String	getOperation()
net.sf.ehcache.Ehcache	initializeCache() Returns Cache instance or create new one if not exists.
boolean	isSingleton() Whether this class supports being singleton or not.
void	setCacheManagerFactory(CacheManagerFactory cacheManagerFactory) To use a custom CacheManagerFactory for creating the CacheManager to be used by this endpoint.
void	setConfig(CacheConfiguration config)
void	setKey(String key) The default key to use.
void	setOperation(String operation) The default cache operation to use.
void	stop() Stops the service

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, doStart, doStop, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start

Constructor Detail

CacheEndpoint

public CacheEndpoint()

CacheEndpoint

public CacheEndpoint(String endpointUri,
                     Component component,
                     CacheConfiguration config,
                     CacheManagerFactory cacheManagerFactory)

Method Detail

createConsumer

public Consumer createConsumer(Processor processor)
                        throws Exception

Description copied from interface: Endpoint

Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor

Parameters:

processor - the given processor

Returns:

a newly created consumer

Throws:

Exception - can be thrown

createProducer

public Producer createProducer()
                        throws Exception

Description copied from interface: Endpoint

Creates a new producer which is used send messages into the endpoint

Returns:

a newly created producer

Throws:

Exception - can be thrown

isSingleton

public boolean isSingleton()

Description copied from interface: IsSingleton

Whether this class supports being singleton or not.

Returns:

true to be a single shared instance, false to create new instances.

getConfig

public CacheConfiguration getConfig()

setConfig

public void setConfig(CacheConfiguration config)

getCacheManagerFactory

public CacheManagerFactory getCacheManagerFactory()

setCacheManagerFactory

public void setCacheManagerFactory(CacheManagerFactory cacheManagerFactory)

To use a custom CacheManagerFactory for creating the CacheManager to be used by this endpoint.

By default the CacheManagerFactory configured on the component is used.

createCacheExchange

public Exchange createCacheExchange(String operation,
                                    String key,
                                    Object value)

initializeCache

public net.sf.ehcache.Ehcache initializeCache()

Returns Cache instance or create new one if not exists.

Returns:

Cache

stop

public void stop()

Description copied from interface: Service

Stops the service

Specified by:

stop in interface Service

Overrides:

stop in class ServiceSupport

getOperation

public String getOperation()

setOperation

public void setOperation(String operation)

The default cache operation to use. If an operation in the message header, then the operation from the header takes precedence.

getKey

public String getKey()

setKey

public void setKey(String key)

The default key to use. If a key is provided in the message header, then the key from the header takes precedence.