org.openspaces.core.space.cache

Class LocalCacheSpaceFactoryBean

java.lang.Object

org.openspaces.core.space.cache.AbstractLocalCacheSpaceFactoryBean

org.openspaces.core.space.cache.LocalCacheSpaceFactoryBean

All Implemented Interfaces:

ServiceDetailsProvider, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean, org.springframework.beans.factory.InitializingBean

public class LocalCacheSpaceFactoryBean
extends AbstractLocalCacheSpaceFactoryBean

In some cases, the memory capacity of an individual application is not capable of holding all the information in the local application memory. When this happens, the desired solution will be to hold only a portion of the information in the application's memory and the rest in a separate process(s). This mode is also known as two-level cache. In this mode, the cache is divided into two components, local cache and master cache. The local cache always resides in the physical address space of the application and the master cache runs in a different process. The master cache is used to share data among the different embedded local caches running within other application instances.

In this mode, when a read/get operation is called, a matching object is first looked up in the local embedded cache. If the object is not found in the local cache, it will be searched for in the master cache. If it is not found in the master cache, it will reload the data from the data source. Updates on the central cache will be propagated into all local embedded cache instances in either pull or push mode, using unicast or multicast protocol.

Author:

kimchy

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOCAL_CACHE_UPDATE_MODE_PULL
static String	LOCAL_CACHE_UPDATE_MODE_PUSH

Constructor Summary

Constructors

Constructor and Description
LocalCacheSpaceFactoryBean()

Method Summary

Modifier and Type	Method and Description
void	addProperty(String name, String value)
void	afterPropertiesSet() Constructs a new local cache IJSpace based on the master local cache set using setSpace(IJSpace) and a set of properties driving the actual local cache type from the configuration.
void	destroy() Closes the local cache space
protected String	getBeanName()
Object	getObject() Returns an IJSpace that is the local cache wrapping the master proxy set using setSpace(com.j_spaces.core.IJSpace).
Class<? extends IJSpace>	getObjectType() Returns the type of the factory object.
ServiceDetails[]	getServicesDetails() Retruns one or more service details that the service exposes.
void	setBatchSize(int batchSize)
void	setBatchTimeout(long batchTimeout)
void	setBeanName(String beanName) Spring callback that sets the bean name.
void	setMaxDisconnectionDuration(long maxDisconnectionDuration)
void	setMaxTimeToLive(long maxTimeToLive)
void	setProperties(Properties properties) Sets additional properties for the local cache.
void	setSize(int size) Sets the local cache size.
void	setSpace(IJSpace space) Sets the master space that a local cache will be built on top.
void	setUpdateMode(int localCacheUpdateMode) If set to SpaceURL.UPDATE_MODE_PULL (1) each update triggers an invalidation event at every cache instance.
void	setUpdateMode(LocalCacheSpaceConfigurer.UpdateMode localCacheUpdateMode)
void	setUpdateModeName(String localCacheUpdateModeName) Allows to set the local cache update mode using a descriptive name instead of integer constants using localCacheUpdateMode.

Methods inherited from class org.openspaces.core.space.cache.AbstractLocalCacheSpaceFactoryBean

isSingleton

Methods inherited from class java.lang.Object

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

Field Detail

LOCAL_CACHE_UPDATE_MODE_PUSH

public static final String LOCAL_CACHE_UPDATE_MODE_PUSH

See Also:

Constant Field Values

LOCAL_CACHE_UPDATE_MODE_PULL

public static final String LOCAL_CACHE_UPDATE_MODE_PULL

See Also:

Constant Field Values

Constructor Detail

LocalCacheSpaceFactoryBean

public LocalCacheSpaceFactoryBean()

Method Detail

getObject

public Object getObject()

Returns an IJSpace that is the local cache wrapping the master proxy set using setSpace(com.j_spaces.core.IJSpace).

getObjectType

public Class<? extends IJSpace> getObjectType()

Returns the type of the factory object.

afterPropertiesSet

public void afterPropertiesSet()

Constructs a new local cache IJSpace based on the master local cache set using setSpace(IJSpace) and a set of properties driving the actual local cache type from the configuration. Additional properties are applied based on setProperties(java.util.Properties).

destroy

public void destroy()

Closes the local cache space

getServicesDetails

public ServiceDetails[] getServicesDetails()

Description copied from interface: ServiceDetailsProvider

Retruns one or more service details that the service exposes.

setBeanName

public void setBeanName(String beanName)

Spring callback that sets the bean name.

getBeanName

protected String getBeanName()

setSpace

public void setSpace(IJSpace space)

Sets the master space that a local cache will be built on top.

setProperties

public void setProperties(Properties properties)

Sets additional properties for the local cache.

addProperty

public void addProperty(String name,
                        String value)

setBatchSize

public void setBatchSize(int batchSize)

setBatchTimeout

public void setBatchTimeout(long batchTimeout)

setMaxDisconnectionDuration

public void setMaxDisconnectionDuration(long maxDisconnectionDuration)

setUpdateMode

public void setUpdateMode(int localCacheUpdateMode)

If set to SpaceURL.UPDATE_MODE_PULL (1) each update triggers an invalidation event at every cache instance. The invalidate event marks the object in the local cache instances as invalid. Therefore, an attempt to read this object triggers a reload process in the master space. This configuration is useful in cases where objects are updated frequently, but the updated value is required by the application less frequently.

If set to SpaceURL.UPDATE_MODE_PUSH (2) the master pushes the updates to the local cache, which holds a reference to the same updated object.

See Also:

setUpdateModeName(String)

setUpdateMode

public void setUpdateMode(LocalCacheSpaceConfigurer.UpdateMode localCacheUpdateMode)

setUpdateModeName

public void setUpdateModeName(String localCacheUpdateModeName)

Allows to set the local cache update mode using a descriptive name instead of integer constants using localCacheUpdateMode. Accepts either push or pull.

See Also:

(int)

setMaxTimeToLive

public void setMaxTimeToLive(long maxTimeToLive)

setSize

public void setSize(int size)

Sets the local cache size.