org.springframework.extensions.surf.persister

Class AbstractObjectPersister

java.lang.Object

org.springframework.extensions.surf.persister.AbstractObjectPersister

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractCachedObjectPersister, MultiObjectPersister

public abstract class AbstractObjectPersister
extends Object
implements ModelObjectPersister, org.springframework.beans.factory.BeanNameAware

Abstract implementation of a model object persister.

Provided to enable ease-of-extension by developers for customer object persisters. This class serves as a foundation and really only provides essential helper functions.

Surf provides persister implementations that are largely file-based. Customizations may seek to incorporate persisters that interact with databases or Alfresco content models directly.

Author:

muzquiano, kevinr

See Also:

StoreObjectPersister

Field Summary

Fields

Modifier and Type	Field and Description
protected static Class<?>[]	MODELOBJECT_CLASSES

Constructor Summary

Constructors

Constructor and Description
AbstractObjectPersister()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	disable() Disables the persister
String	getId() Returns a unique id for this persister If this persister is wrapped around a ClassPath store, a LocalFileSystem store or a Repository store, this will return the value provided getBasePath() If this is wrapped around a RemoteStore, this will return the AVM Store ID to which this persister is bound
protected PersisterService	getPersisterService()
WebFrameworkServiceRegistry	getServiceRegistry() Deprecated. Please configure the Spring application context to set a PersisterService and WebFrameworkConfigElement explicitly
protected WebFrameworkConfigElement	getWebFrameworkConfiguration()
boolean	hasObject(ModelPersistenceContext context, ModelObject object) Checks whether the given object is persisted
void	init(ModelPersistenceContext context) Initializes the persister by preloading the object cache
boolean	isEnabled() Indicates whether this persisted is currently enabled.
boolean	removeObject(ModelPersistenceContext context, ModelObject object) Removes an object from persisted storage
void	reset() Resets the persister, clearing cache and starting anew.
void	setBeanName(String name)
void	setPersisterService(PersisterService persisterService)
void	setServiceRegistry(WebFrameworkServiceRegistry serviceRegistry) Deprecated. Please configure the Spring application context to set a PersisterService and WebFrameworkConfigElement explicitly
void	setWebFrameworkConfig(WebFrameworkConfigElement webFrameworkConfig)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.extensions.surf.ModelObjectPersister

getAllObjects, getAllObjectsByFilter, getObject, getTimestamp, hasObject, hasReadOnlyStore, newObject, removeObject, saveObject, saveObjects

Field Detail

MODELOBJECT_CLASSES

protected static final Class<?>[] MODELOBJECT_CLASSES

Constructor Detail

AbstractObjectPersister

public AbstractObjectPersister()

Method Detail

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

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

Parameters:

context - the persistence context

reset

public void reset()

Description copied from interface: ModelObjectPersister

Resets the persister, clearing cache and starting anew.

Specified by:

reset in interface ModelObjectPersister

removeObject

public boolean removeObject(ModelPersistenceContext context,
                   ModelObject object)
                     throws ModelObjectPersisterException

Description copied from interface: ModelObjectPersister

Removes an object from persisted storage

Specified by:

removeObject in interface ModelObjectPersister

Parameters:

context - ModelPersistenceContext

object - ModelObject

Returns:

whether the object was removed

Throws:

ModelObjectPersisterException

hasObject

public boolean hasObject(ModelPersistenceContext context,
                ModelObject object)
                  throws ModelObjectPersisterException

Description copied from interface: ModelObjectPersister

Checks whether the given object is persisted

Specified by:

hasObject in interface ModelObjectPersister

Parameters:

context - ModelPersistenceContext

object - ModelObject

Returns:

whether the object is persisted

Throws:

ModelObjectPersisterException

getId

public String getId()

Description copied from interface: ModelObjectPersister

Returns a unique id for this persister If this persister is wrapped around a ClassPath store, a LocalFileSystem store or a Repository store, this will return the value provided getBasePath() If this is wrapped around a RemoteStore, this will return the AVM Store ID to which this persister is bound

Specified by:

getId in interface ModelObjectPersister

Returns:

String

isEnabled

public boolean isEnabled()

Description copied from interface: ModelObjectPersister

Indicates whether this persisted is currently enabled. Disabled persisters continue to work but do not modify data.

Specified by:

isEnabled in interface ModelObjectPersister

Returns:

flag

disable

protected void disable()

Disables the persister

setPersisterService

public void setPersisterService(PersisterService persisterService)

setWebFrameworkConfig

public void setWebFrameworkConfig(WebFrameworkConfigElement webFrameworkConfig)

getWebFrameworkConfiguration

protected WebFrameworkConfigElement getWebFrameworkConfiguration()

getPersisterService

protected PersisterService getPersisterService()

setServiceRegistry

public void setServiceRegistry(WebFrameworkServiceRegistry serviceRegistry)

Deprecated. Please configure the Spring application context to set a PersisterService and WebFrameworkConfigElement explicitly

getServiceRegistry

public WebFrameworkServiceRegistry getServiceRegistry()

Deprecated. Please configure the Spring application context to set a PersisterService and WebFrameworkConfigElement explicitly