org.springframework.extensions.surf.persister

Class AbstractStoreObjectPersister

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

All Implemented Interfaces:

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

Direct Known Subclasses:

PathStoreObjectPersister, StoreObjectPersister

public abstract class AbstractStoreObjectPersister
extends ReadOnlyStoreObjectPersister

Provides a base implementation of a persister on-top of a Web Script 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 stores are based on file-path semantics, this persister must make assumptions on how to map ids to to file-paths in order to allow for lazy referencing and lazy loading of objects.

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:

muzquiano, kevinr

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	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
AbstractStoreObjectPersister()

Method Summary

Methods

Modifier and Type	Method and Description
protected ContentCache<ModelObject>	createCache() Creates a new cache.
protected String	generatePath(String objectTypeId, String objectId) Generates a persistence path for a given object id and object type id.
Map<String,ModelObject>	getAllObjects(ModelPersistenceContext context, String objectTypeId) Returns a map of all of the objects referenced by this persister.
Map<String,ModelObject>	getAllObjectsByFilter(ModelPersistenceContext context, String objectTypeId, String objectIdFilter) Returns a map of all of the objects referenced by this persister filtered by the given ID filter.
protected Map<String,ModelObject>	getObjectsFromPaths(ModelPersistenceContext context, String objectTypeId, String[] docPaths)
String	getPathPrefix(String objectTypeId, String objectId) Gets the path prefix for the given token replacements.
long	getTimestamp(ModelPersistenceContext context, String objectTypeId, String objectId) Returns the timestamp of the given object in the underlying store
boolean	hasObject(ModelPersistenceContext context, String objectTypeId, String objectId) Checks whether an object with the given path is persisted
ModelObject	newObject(ModelPersistenceContext context, String objectTypeId, String objectId) Creates a new object
protected ModelObject	newObject(ModelPersistenceContext context, String objectTypeId, String objectId, boolean addToCache)
boolean	removeObject(ModelPersistenceContext context, String objectTypeId, String objectId) Removes an object from persisted storage

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

cacheGet, cacheRemove, createObject, getCache, getObject, getObjectByPath, getObjectId, getObjectTypeId, getPathPrefix, hasReadOnlyStore, init, isModelObject, loadObjectAndDependants, reset, saveObject, saveObjects, setPathPrefix, setStore, toString

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

cachePut, cacheRemove, invalidateCache, 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

XML_EXT

protected static final String XML_EXT

See Also:

Constant Field Values

Constructor Detail

AbstractStoreObjectPersister

public AbstractStoreObjectPersister()

Method Detail

generatePath

protected String generatePath(String objectTypeId,
                  String objectId)

Description copied from class: ReadOnlyStoreObjectPersister

Generates a persistence path for a given object id and object type id. Default way to convert an object id into a storage path is to add the .xml extension to the object id.

This method should never return a null value.

Overrides:

generatePath in class ReadOnlyStoreObjectPersister

Parameters:

objectTypeId - the object type id

objectId - the object id

Returns:

the storage path for this id

getPathPrefix

public String getPathPrefix(String objectTypeId,
                   String objectId)

Gets the path prefix for the given token replacements.

Parameters:

objectTypeId - the object type id

objectId - the object id

Returns:

the path prefix or null if not provided

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 ReadOnlyStoreObjectPersister

Parameters:

context - ModelPersistenceContext

objectTypeId - String

objectId - String

Returns:

whether the object was removed

Throws:

ModelObjectPersisterException

hasObject

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

Description copied from interface: ModelObjectPersister

Checks whether an object with the given path is persisted

Specified by:

hasObject in interface ModelObjectPersister

Overrides:

hasObject in class ReadOnlyStoreObjectPersister

Parameters:

context - ModelPersistenceContext

objectTypeId - String

objectId - String

Returns:

whether the object is persisted

Throws:

ModelObjectPersisterException

newObject

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

Description copied from interface: ModelObjectPersister

Creates a new object

Specified by:

newObject in interface ModelObjectPersister

Overrides:

newObject in class ReadOnlyStoreObjectPersister

Parameters:

context - ModelPersistenceContext

objectTypeId - String

objectId - String

Returns:

the object

Throws:

ModelObjectPersisterException

newObject

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

Throws:

ModelObjectPersisterException

getTimestamp

public long getTimestamp(ModelPersistenceContext context,
                String objectTypeId,
                String objectId)
                  throws ModelObjectPersisterException

Description copied from interface: ModelObjectPersister

Returns the timestamp of the given object in the underlying store

Specified by:

getTimestamp in interface ModelObjectPersister

Overrides:

getTimestamp in class ReadOnlyStoreObjectPersister

Parameters:

context - ModelPersistenceContext

objectTypeId - String

objectId - String

Returns:

long

Throws:

ModelObjectPersisterException

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 ReadOnlyStoreObjectPersister

Parameters:

context - ModelPersistenceContext

objectTypeId - String

Returns:

Map of object IDs to ModelObject instances

Throws:

ModelObjectPersisterException

getAllObjectsByFilter

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

Description copied from interface: ModelObjectPersister

Returns a map of all of the objects referenced by this persister filtered by the given ID filter.

In general, this is an expensive call but less expensive than getAllObjects(). Each object descriptor referenced by the persister found using the filter is loaded into the model object cache.

Specified by:

getAllObjectsByFilter in interface ModelObjectPersister

Overrides:

getAllObjectsByFilter in class ReadOnlyStoreObjectPersister

Parameters:

context - ModelPersistenceContext

objectTypeId - String

objectIdFilter - String

Returns:

Map of object IDs to ModelObject instances

Throws:

ModelObjectPersisterException

getObjectsFromPaths

protected Map<String,ModelObject> getObjectsFromPaths(ModelPersistenceContext context,
                                          String objectTypeId,
                                          String[] docPaths)
                                               throws ModelObjectPersisterException

Parameters:

context - ModelPersistenceContext

objectTypeId - object type id

docPaths - Array of document paths

Returns:

map of IDs to model objects

Throws:

ModelObjectPersisterException

createCache

protected ContentCache<ModelObject> createCache()

Description copied from class: AbstractCachedObjectPersister

Creates a new cache.

Overrides:

createCache in class ReadOnlyStoreObjectPersister

Returns:

the cache