org.springframework.extensions.surf.persister

Class PathStoreObjectPersister

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

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, ClusterMessageAware, ModelObjectPersister, CachedPersister

public class PathStoreObjectPersister
extends AbstractStoreObjectPersister
implements ClusterMessageAware

Provides an implementation of a persister on top of a Web Script Remote style path based store.

Unlike the read-only implementation, this implementation does not assume the cache as the "master copy" of the data. Rather, the "master copy" is considered to be the store itself. Any put or remote based interactions with persisted content are delegated to the store itself. All get operations utilize the cache for performance benefits, with a configured timeout to reintegrogate last modified dates of actual store content.

Since remote stores are completely based on file-path semantics, this persister must make assumptions on how to map ids to to file-paths. The ID of an object is intrinsically linked to it's path within the store - the object type is not relevant - therefore all caching is based on storage path.

The id to file-path and file-path to id conversion methods are split out so that they can be adjusted in inheriting implementations.

In addition, path prefixes support token replacement for object type ids and object ids.

Author:

Kevin Roast

Field Summary

Fields

Modifier and Type	Field and Description
protected ReadWriteLock	cacheLock Lock object for cache construction
protected ClusterService	clusterService
protected Set<String>	noncachableObjectTypes Set of types that should not be cached by the persister.
protected ModelObjectCache	objectCache Default object cache
protected boolean	tenantObjectCache Settings to use a tenant partitioned object cache - based on \@domain in username field Default is true.

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
PathStoreObjectPersister()

Method Summary

Methods

Modifier and Type	Method and Description
protected ModelObject	cacheGet(ModelPersistenceContext context, String path) Returns an object from the cache
protected ModelObject	cacheGet(ModelPersistenceContext context, String objectTypeId, String objectId) Returns an object from the cache.
protected void	cachePut(ModelPersistenceContext context, ModelObject obj) Places an object into this persister's cache.
protected void	cachePut(ModelPersistenceContext context, String path, ModelObject obj) Places an object into this persister's cache.
protected void	cacheRemove(ModelPersistenceContext context, ModelObject obj) Removes an object from the cache
protected void	cacheRemove(ModelPersistenceContext context, String objectTypeId, String objectId) Removes an object from the cache
Map<String,ModelObject>	getAllObjects(ModelPersistenceContext context, String objectTypeId) Returns a map of all of the objects referenced by this persister.
protected ContentCache<ModelObject>	getCache(ModelPersistenceContext context, String bucket) Gets the cache for a particular model persistence context
String	getClusterMessageType() The unique message cluster Type ID that this bean deals with and posts using.
ModelObject	getObject(ModelPersistenceContext context, String objectTypeId, String objectId) Gets an object from persisted storage by id
protected ModelObject	getObjectByPath(ModelPersistenceContext context, String path) Retrieves an object from the underlying store by path This performs an interrogation of the underlying document to determine its object type and object id.
protected String	getObjectId(org.dom4j.Document doc, String path) Determines the object id of a serialized model object contained in a document.
void	init(ModelPersistenceContext context) Initializes the persister by preloading the object cache
void	invalidateCache() Invalidates the cache
protected ModelObject	newObject(ModelPersistenceContext context, String objectTypeId, String objectId, boolean addToCache)
void	onClusterMessage(Map<String,Serializable> payload) Called by a ClusterService implementation when a message for this bean has been sent to this cluster node and is ready to be processed by the handler based on the bean message type as supplied in getClusterMessageType().
boolean	removeObject(ModelPersistenceContext context, String objectTypeId, String objectId) Removes an object from persisted storage
boolean	saveObject(ModelPersistenceContext context, ModelObject modelObject) Saves an object to persisted storage
boolean	saveObjects(ModelPersistenceContext context, List<ModelObject> modelObjects) Saves a collection of objects to persisted storage
void	setClusterService(ClusterService service) Called by a ClusterService implementation to set a ClusterService for this bean to use.
void	setNoncachableObjectTypes(Set<String> types) The Set of model object types that should never be cached by the persister
void	setTenantObjectCache(boolean tenantObjectCache)
protected void	updateClusterCachePath(String path) Add a cluster message for an invalid cache path for a model object in the cache.
protected boolean	useCacheForType(String objectTypeId) Return true if the cache should be used for the given object type ID.

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

Field Detail

objectCache

protected ModelObjectCache objectCache

Default object cache

noncachableObjectTypes

protected Set<String> noncachableObjectTypes

Set of types that should not be cached by the persister. Types that are loaded remotely from a central repository should not be cached if the web-tier is going to be clustered or in a web-farm

cacheLock

protected final ReadWriteLock cacheLock

Lock object for cache construction

tenantObjectCache

protected boolean tenantObjectCache

Settings to use a tenant partitioned object cache - based on \@domain in username field Default is true. Set to false if using email style usernames but not using tenant features

clusterService

protected ClusterService clusterService

Constructor Detail

PathStoreObjectPersister

public PathStoreObjectPersister()

Method Detail

init

public void init(ModelPersistenceContext context)

Description copied from interface: ModelObjectPersister

Initializes the persister by preloading the object cache

Specified by:

init in interface ModelObjectPersister

Overrides:

init in class ReadOnlyStoreObjectPersister

Parameters:

context - the persistence context

setNoncachableObjectTypes

public void setNoncachableObjectTypes(Set<String> types)

The Set of model object types that should never be cached by the persister

setTenantObjectCache

public void setTenantObjectCache(boolean tenantObjectCache)

Parameters:

tenantObjectCache - true to use a tenant partitioned object cache based on \@domain username

saveObject

public boolean saveObject(ModelPersistenceContext context,
                 ModelObject modelObject)
                   throws ModelObjectPersisterException

Description copied from interface: ModelObjectPersister

Saves an object to persisted storage

Specified by:

saveObject in interface ModelObjectPersister

Overrides:

saveObject in class ReadOnlyStoreObjectPersister

Parameters:

context - ModelPersistenceContext

modelObject - ModelObject

Returns:

whether the object was saved

Throws:

ModelObjectPersisterException

saveObjects

public boolean saveObjects(ModelPersistenceContext context,
                  List<ModelObject> modelObjects)
                    throws ModelObjectPersisterException

Description copied from interface: ModelObjectPersister

Saves a collection of objects to persisted storage

Specified by:

saveObjects in interface ModelObjectPersister

Overrides:

saveObjects in class ReadOnlyStoreObjectPersister

Parameters:

context - ModelPersistenceContext

modelObjects - List

Returns:

boolean

Throws:

ModelObjectPersisterException

getObject

public ModelObject getObject(ModelPersistenceContext context,
                    String objectTypeId,
                    String objectId)
                      throws ModelObjectPersisterException

Description copied from interface: ModelObjectPersister

Gets an object from persisted storage by id

Specified by:

getObject in interface ModelObjectPersister

Overrides:

getObject in class ReadOnlyStoreObjectPersister

Parameters:

context - ModelPersistenceContext

objectTypeId - String

objectId - String

Returns:

object instance

Throws:

ModelObjectPersisterException

removeObject

public boolean removeObject(ModelPersistenceContext context,
                   String objectTypeId,
                   String objectId)
                     throws ModelObjectPersisterException

Description copied from interface: ModelObjectPersister

Removes an object from persisted storage

Specified by:

removeObject in interface ModelObjectPersister

Overrides:

removeObject in class AbstractStoreObjectPersister

Parameters:

context - ModelPersistenceContext

objectTypeId - String

objectId - String

Returns:

whether the object was removed

Throws:

ModelObjectPersisterException

newObject

protected ModelObject newObject(ModelPersistenceContext context,
                    String objectTypeId,
                    String objectId,
                    boolean addToCache)
                         throws ModelObjectPersisterException

Overrides:

newObject in class AbstractStoreObjectPersister

Throws:

ModelObjectPersisterException

useCacheForType

protected boolean useCacheForType(String objectTypeId)

Return true if the cache should be used for the given object type ID. Takes the class wide useCache value into account, and then checks the noncachableObjectTypes member to see if caching has been specifically disabled.

Parameters:

objectTypeId - to check

Returns:

true if the cache should be used for the type, false otherwise

cachePut

protected void cachePut(ModelPersistenceContext context,
            String path,
            ModelObject obj)

Places an object into this persister's cache.

Parameters:

context - the context

path - the path

obj - the obj

cachePut

protected void cachePut(ModelPersistenceContext context,
            ModelObject obj)

Places an object into this persister's cache.

Overrides:

cachePut in class AbstractCachedObjectPersister

Parameters:

context - the context

obj - the obj

cacheRemove

protected void cacheRemove(ModelPersistenceContext context,
               ModelObject obj)

Removes an object from the cache

Overrides:

cacheRemove in class AbstractCachedObjectPersister

Parameters:

context - the context

obj - ModelObject

cacheRemove

protected void cacheRemove(ModelPersistenceContext context,
               String objectTypeId,
               String objectId)

Removes an object from the cache

Overrides:

cacheRemove in class ReadOnlyStoreObjectPersister

Parameters:

context - the context

objectTypeId - String

objectId - String

cacheGet

protected ModelObject cacheGet(ModelPersistenceContext context,
                   String path)

Returns an object from the cache

Parameters:

context - the context

path - the path

Returns:

the model object

cacheGet

protected ModelObject cacheGet(ModelPersistenceContext context,
                   String objectTypeId,
                   String objectId)

Returns an object from the cache. Always check the cache - even if not explicity enabled - as nested component definitions are always cached otherwise they would not be found on lookup.

Overrides:

cacheGet in class ReadOnlyStoreObjectPersister

Parameters:

context - the context

objectTypeId - String

objectId - String

Returns:

the model object

getAllObjects

public Map<String,ModelObject> getAllObjects(ModelPersistenceContext context,
                                    String objectTypeId)
                                      throws ModelObjectPersisterException

Description copied from interface: ModelObjectPersister

Returns a map of all of the objects referenced by this persister.

In general, this is a very expensive call and should be avoided. Each object descriptor referenced by the persister is loaded into the model object cache.

Specified by:

getAllObjects in interface ModelObjectPersister

Overrides:

getAllObjects in class AbstractStoreObjectPersister

Parameters:

context - ModelPersistenceContext

objectTypeId - String

Returns:

Map of object IDs to ModelObject instances

Throws:

ModelObjectPersisterException

getObjectByPath

protected ModelObject getObjectByPath(ModelPersistenceContext context,
                          String path)
                               throws ModelObjectPersisterException

Retrieves an object from the underlying store by path This performs an interrogation of the underlying document to determine its object type and object id.

Overrides:

getObjectByPath in class ReadOnlyStoreObjectPersister

Parameters:

context - ModelPersistenceContext

path - String

Returns:

ModelObject

Throws:

ModelObjectPersisterException

getObjectId

protected String getObjectId(org.dom4j.Document doc,
                 String path)

Determines the object id of a serialized model object contained in a document. If the property is available in the serialized document, it will be used. Otherwise, the id will be assumed to be the file name.

Overrides:

getObjectId in class ReadOnlyStoreObjectPersister

Parameters:

doc - document

path - the path

Returns:

object id (or null if it is not a model object)

getCache

protected ContentCache<ModelObject> getCache(ModelPersistenceContext context,
                                 String bucket)

Gets the cache for a particular model persistence context

Overrides:

getCache in class ReadOnlyStoreObjectPersister

Parameters:

context - ModelPersistenceContext

bucket - Cache bucket to pick (not used by PathStore)

Returns:

the cache

invalidateCache

public void invalidateCache()

Description copied from interface: CachedPersister

Invalidates the cache

Specified by:

invalidateCache in interface CachedPersister

Overrides:

invalidateCache in class AbstractCachedObjectPersister

See Also:

CachedPersister.invalidateCache()

setClusterService

public void setClusterService(ClusterService service)

Description copied from interface: ClusterMessageAware

Called by a ClusterService implementation to set a ClusterService for this bean to use. If this is never called (i.e. is null) then there is no ClusterService present and no messages should be posted by the implementor of this interface.

Specified by:

setClusterService in interface ClusterMessageAware

Parameters:

service - ClusterService to use to post cluster message payloads

getClusterMessageType

public String getClusterMessageType()

Description copied from interface: ClusterMessageAware

The unique message cluster Type ID that this bean deals with and posts using. This is part of the contract of the ClusterMessageAware interface and must be implemented by the bean.

Specified by:

getClusterMessageType in interface ClusterMessageAware

Returns:

unique cluster message Type ID for this bean.

onClusterMessage

public void onClusterMessage(Map<String,Serializable> payload)

Description copied from interface: ClusterMessageAware

Called by a ClusterService implementation when a message for this bean has been sent to this cluster node and is ready to be processed by the handler based on the bean message type as supplied in getClusterMessageType().

Specified by:

onClusterMessage in interface ClusterMessageAware

Parameters:

payload - Payload from the message

updateClusterCachePath

protected void updateClusterCachePath(String path)

Add a cluster message for an invalid cache path for a model object in the cache.

Parameters:

path - Object path