org.alfresco.web.site

Class ClusterAwarePathStoreObjectPersister

java.lang.Object

org.springframework.extensions.surf.persister.AbstractObjectPersister

org.springframework.extensions.surf.persister.AbstractCachedObjectPersister

org.springframework.extensions.surf.persister.ReadOnlyStoreObjectPersister

org.springframework.extensions.surf.persister.AbstractStoreObjectPersister

org.springframework.extensions.surf.persister.PathStoreObjectPersister

org.alfresco.web.site.ClusterAwarePathStoreObjectPersister

All Implemented Interfaces:

com.hazelcast.core.MessageListener, java.util.EventListener, org.springframework.beans.factory.BeanNameAware, org.springframework.extensions.surf.ModelObjectPersister, org.springframework.extensions.surf.persister.CachedPersister

public class ClusterAwarePathStoreObjectPersister
extends org.springframework.extensions.surf.persister.PathStoreObjectPersister
implements com.hazelcast.core.MessageListener

Hazlecast cluster aware implementation of the PathStoreObjectPersister. Manages the local ModelObject cache by broadcasting and receiving messages relating to pertinent cache operations that affect other cluster nodes.

The current implementation uses a simple broadcast message that informs other cluster nodes to invalidate specific path objects (remove them) from the persister cache. This is enough to deal with addition (caching of nulls), removal and modification of model objects relating to site and user dashboards and the site configuration object.

See Also:

ClusterAwareRequestContext

Field Summary

Fields inherited from class org.springframework.extensions.surf.persister.PathStoreObjectPersister

cacheLock, noncachableObjectTypes, objectCache

Fields inherited from class org.springframework.extensions.surf.persister.AbstractStoreObjectPersister

XML_EXT

Fields inherited from class org.springframework.extensions.surf.persister.ReadOnlyStoreObjectPersister

pathPrefix, store

Fields inherited from class org.springframework.extensions.surf.persister.AbstractCachedObjectPersister

cacheDelay, cacheMaxSize, caches, GLOBAL_STORE_ID_SUFFIX, useCache

Fields inherited from class org.springframework.extensions.surf.persister.AbstractObjectPersister

MODELOBJECT_CLASSES

Constructor Summary

Constructors

Constructor and Description
ClusterAwarePathStoreObjectPersister()

Method Summary

Methods

Modifier and Type	Method and Description
void	init(org.springframework.extensions.surf.ModelPersistenceContext context) Override the persister init method to perform one time init of the Hazelcast cluster node.
protected org.springframework.extensions.surf.ModelObject	newObject(org.springframework.extensions.surf.ModelPersistenceContext context, java.lang.String objectTypeId, java.lang.String objectId, boolean addToCache)
void	onMessage(java.lang.String message) Hazelcast MessageListener implementation - called when a message is received from a cluster node
void	pushMessage(org.alfresco.web.site.ClusterAwarePathStoreObjectPersister.ClusterMessage message) Push message out to the cluster - multicast or direct TCP depending on Hazelcast config.
boolean	removeObject(org.springframework.extensions.surf.ModelPersistenceContext context, java.lang.String objectTypeId, java.lang.String objectId)
boolean	saveObject(org.springframework.extensions.surf.ModelPersistenceContext context, org.springframework.extensions.surf.ModelObject modelObject)
void	setHazelcastInstance(com.hazelcast.core.HazelcastInstance hazelcastInstance)
void	setHazelcastTopicName(java.lang.String hazelcastTopicName)

Methods inherited from class org.springframework.extensions.surf.persister.PathStoreObjectPersister

cacheGet, cacheGet, cachePut, cachePut, cacheRemove, cacheRemove, getAllObjects, getCache, getObject, getObjectByPath, getObjectId, invalidateCache, saveObjects, setNoncachableObjectTypes, useCacheForType

Methods inherited from class org.springframework.extensions.surf.persister.AbstractStoreObjectPersister

createCache, generatePath, getAllObjectsByFilter, getObjectsFromPaths, getPathPrefix, getTimestamp, hasObject, newObject

Methods inherited from class org.springframework.extensions.surf.persister.ReadOnlyStoreObjectPersister

createObject, getObjectTypeId, getPathPrefix, hasReadOnlyStore, isModelObject, loadObjectAndDependants, reset, setPathPrefix, setStore, toString

Methods inherited from class org.springframework.extensions.surf.persister.AbstractCachedObjectPersister

setCache, setCacheCheckDelay, setCacheMaxSize

Methods inherited from class org.springframework.extensions.surf.persister.AbstractObjectPersister

disable, getId, getPersisterService, getServiceRegistry, getWebFrameworkConfiguration, hasObject, isEnabled, removeObject, setBeanName, setPersisterService, setServiceRegistry, setWebFrameworkConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterAwarePathStoreObjectPersister

public ClusterAwarePathStoreObjectPersister()

Method Detail

setHazelcastInstance

public void setHazelcastInstance(com.hazelcast.core.HazelcastInstance hazelcastInstance)

Parameters:

hazelcastInstance - The HazelcastInstance cluster bean

setHazelcastTopicName

public void setHazelcastTopicName(java.lang.String hazelcastTopicName)

Parameters:

hazelcastTopicName - The topic name used for messaging between cluster nodes

init

public void init(org.springframework.extensions.surf.ModelPersistenceContext context)

Override the persister init method to perform one time init of the Hazelcast cluster node.

Specified by:

init in interface org.springframework.extensions.surf.ModelObjectPersister

Overrides:

init in class org.springframework.extensions.surf.persister.PathStoreObjectPersister

saveObject

public boolean saveObject(org.springframework.extensions.surf.ModelPersistenceContext context,
                 org.springframework.extensions.surf.ModelObject modelObject)
                   throws org.springframework.extensions.surf.exception.ModelObjectPersisterException

Specified by:

saveObject in interface org.springframework.extensions.surf.ModelObjectPersister

Overrides:

saveObject in class org.springframework.extensions.surf.persister.PathStoreObjectPersister

Throws:

org.springframework.extensions.surf.exception.ModelObjectPersisterException

removeObject

public boolean removeObject(org.springframework.extensions.surf.ModelPersistenceContext context,
                   java.lang.String objectTypeId,
                   java.lang.String objectId)
                     throws org.springframework.extensions.surf.exception.ModelObjectPersisterException

Specified by:

removeObject in interface org.springframework.extensions.surf.ModelObjectPersister

Overrides:

removeObject in class org.springframework.extensions.surf.persister.AbstractStoreObjectPersister

Throws:

org.springframework.extensions.surf.exception.ModelObjectPersisterException

newObject

protected org.springframework.extensions.surf.ModelObject newObject(org.springframework.extensions.surf.ModelPersistenceContext context,
                                                        java.lang.String objectTypeId,
                                                        java.lang.String objectId,
                                                        boolean addToCache)
                                                             throws org.springframework.extensions.surf.exception.ModelObjectPersisterException

Overrides:

newObject in class org.springframework.extensions.surf.persister.AbstractStoreObjectPersister

Throws:

org.springframework.extensions.surf.exception.ModelObjectPersisterException

pushMessage

public void pushMessage(org.alfresco.web.site.ClusterAwarePathStoreObjectPersister.ClusterMessage message)

Push message out to the cluster - multicast or direct TCP depending on Hazelcast config.

Parameters:

msg - The message to be sent

onMessage

public void onMessage(java.lang.String message)

Hazelcast MessageListener implementation - called when a message is received from a cluster node

Specified by:

onMessage in interface com.hazelcast.core.MessageListener

Parameters:

message - String message data