com.mulesoft.mule.runtime.cache.internal

Class AbstractCachingStrategy

java.lang.Object

org.mule.runtime.api.component.AbstractComponent

com.mulesoft.mule.runtime.cache.internal.AbstractCachingStrategy

All Implemented Interfaces:

CachingStrategy, org.mule.runtime.api.component.Component, org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Lifecycle, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

Direct Known Subclasses:

ObjectStoreCachingStrategy

public abstract class AbstractCachingStrategy
extends org.mule.runtime.api.component.AbstractComponent
implements CachingStrategy, org.mule.runtime.api.lifecycle.Lifecycle

Provides a CachingStrategy template. Implementations must provide a way to store an retrieve cached objects. Object's keys are generated using a MuleEventKeyGenerator and the responses are generated using a ResponseGenerator. Cached object can be copied using a MuleEventCopier. The caching strategy will only cache the CoreEvent that have a non consumable message's payload.

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.api.component.Component

org.mule.runtime.api.component.Component.Annotations

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger
protected org.mule.runtime.core.api.MuleContext	muleContext

Fields inherited from class org.mule.runtime.api.component.AbstractComponent

ANNOTATION_NAME, LOCATION_KEY, ROOT_CONTAINER_NAME_KEY

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.component.Component

ANNOTATIONS_PROPERTY_NAME, NS_MULE_DOCUMENTATION, NS_MULE_PARSER_METADATA

Constructor Summary

Constructors

Constructor and Description
AbstractCachingStrategy()

Method Summary

Modifier and Type	Method and Description
MuleEventKeyGenerator	getKeyGenerator()
protected Lock	getLock(Serializable key)
org.mule.runtime.api.lock.LockFactory	getLockFactory()
protected org.mule.runtime.api.scheduler.Scheduler	getLockScheduler()
MuleEventCopier	getMuleEventCopier()
String	getName()
ResponseGenerator	getResponseGenerator()
void	initialise()
boolean	isSynchronizedAccess()
org.mule.runtime.core.api.event.CoreEvent	process(org.mule.runtime.core.api.event.CoreEvent event, org.mule.runtime.core.api.processor.Processor messageProcessor) Processes a CoreEvent using a caching schema.
protected abstract org.mule.runtime.core.api.event.CoreEvent	retrieve(String key)
void	setKeyGenerator(MuleEventKeyGenerator keyGenerator)
void	setLockFactory(org.mule.runtime.api.lock.LockFactory lockFactory)
void	setMuleContext(org.mule.runtime.core.api.MuleContext muleContext)
void	setMuleEventCopier(MuleEventCopier muleEventCopier)
void	setName(String name)
void	setResponseGenerator(ResponseGenerator responseGenerator)
void	setSchedulerService(org.mule.runtime.api.scheduler.SchedulerService schedulerService)
void	setSynchronizedAccess(boolean synchronizedAccess)
void	start()
void	stop()
protected abstract void	store(String key, org.mule.runtime.core.api.event.CoreEvent value)
org.mule.runtime.core.api.processor.ReactiveProcessor	transformProcessor(org.mule.runtime.core.api.processor.Processor processor) Obtain the publisher function for caching strategy given a processor

Methods inherited from class org.mule.runtime.api.component.AbstractComponent

getAnnotation, getAnnotations, getDslSource, getIdentifier, getLocation, getRepresentation, getRootContainerLocation, initRootContainerName, setAnnotations

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.mule.runtime.api.lifecycle.Disposable

dispose

Field Detail

logger

protected org.slf4j.Logger logger

muleContext

protected org.mule.runtime.core.api.MuleContext muleContext

Constructor Detail

AbstractCachingStrategy

public AbstractCachingStrategy()

Method Detail

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

start

public void start()
           throws org.mule.runtime.api.exception.MuleException

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

Throws:

org.mule.runtime.api.exception.MuleException

stop

public void stop()
          throws org.mule.runtime.api.exception.MuleException

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Throws:

org.mule.runtime.api.exception.MuleException

process

public org.mule.runtime.core.api.event.CoreEvent process(org.mule.runtime.core.api.event.CoreEvent event,
                                                         org.mule.runtime.core.api.processor.Processor messageProcessor)
                                                  throws org.mule.runtime.api.exception.MuleException

Description copied from interface: CachingStrategy

Processes a CoreEvent using a caching schema. Uses a message processor to process the request when it is not found in the cache or when it must be processed without using the cache.

Different calls to this method using the same request does not implies that the same instance will be returned. Each implementation could choose to create new instances every time.

Specified by:

process in interface CachingStrategy

Parameters:

event - the event to process

messageProcessor - the message processor that will be executed when the response for the event is not in the cache.

Returns:

a response for the request that could be obtained using the cache.

Throws:

org.mule.runtime.api.exception.MuleException

transformProcessor

public org.mule.runtime.core.api.processor.ReactiveProcessor transformProcessor(org.mule.runtime.core.api.processor.Processor processor)

Description copied from interface: CachingStrategy

Obtain the publisher function for caching strategy given a processor

Specified by:

transformProcessor in interface CachingStrategy

Parameters:

processor - the processor that will be executed when the response for the event is not in the cache.

Returns:

publisher function

getLock

protected Lock getLock(Serializable key)

store

protected abstract void store(String key,
                              org.mule.runtime.core.api.event.CoreEvent value)

retrieve

protected abstract org.mule.runtime.core.api.event.CoreEvent retrieve(String key)

getKeyGenerator

public MuleEventKeyGenerator getKeyGenerator()

setKeyGenerator

public void setKeyGenerator(MuleEventKeyGenerator keyGenerator)

getResponseGenerator

public ResponseGenerator getResponseGenerator()

setResponseGenerator

public void setResponseGenerator(ResponseGenerator responseGenerator)

getName

public String getName()

setName

public void setName(String name)

getMuleEventCopier

public MuleEventCopier getMuleEventCopier()

setMuleEventCopier

public void setMuleEventCopier(MuleEventCopier muleEventCopier)

setSynchronizedAccess

public void setSynchronizedAccess(boolean synchronizedAccess)

isSynchronizedAccess

public boolean isSynchronizedAccess()

getLockFactory

public org.mule.runtime.api.lock.LockFactory getLockFactory()

setLockFactory

@Inject
public void setLockFactory(org.mule.runtime.api.lock.LockFactory lockFactory)

setSchedulerService

public void setSchedulerService(org.mule.runtime.api.scheduler.SchedulerService schedulerService)

setMuleContext

@Inject
public void setMuleContext(org.mule.runtime.core.api.MuleContext muleContext)

getLockScheduler

protected org.mule.runtime.api.scheduler.Scheduler getLockScheduler()