org.apache.slide.store
Class StandardStore

java.lang.Object
  |
  +--org.apache.slide.common.AbstractServiceBase
        |
        +--org.apache.slide.common.AbstractSimpleService
              |
              +--org.apache.slide.store.AbstractStore
                    |
                    +--org.apache.slide.store.StandardStore

All Implemented Interfaces:

ContentStore, LockStore, NodeStore, RevisionDescriptorsStore, RevisionDescriptorStore, SecurityStore, Service, Store, javax.transaction.xa.XAResource

public class StandardStore

extends AbstractStore

Abstract implementation of a store. Handles all caching operations.

Version:

$Revision: 1.16 $

Author:

Remy Maucherat

Field Summary

protected ObjectCache	descriptorCache Revision descriptor cache.
protected ObjectCache	descriptorsCache Revision descriptors cache.
protected ObjectCache	locksCache Locks cache.
protected ObjectCache	objectsCache Nodes cache.
protected ObjectCache	permissionsCache Permissions cache.

Fields inherited from class org.apache.slide.store.AbstractStore

contentStore, defaultStore, defaultStoreInstance, lockStore, nodeStore, resourceManagers, revisionDescriptorsStore, revisionDescriptorStore, securityStore

Fields inherited from class org.apache.slide.common.AbstractSimpleService

currentContext, rollbackOnly, status, transactionTimeout, TX_IDLE, TX_PREPARED, TX_SUSPENDED

Fields inherited from class org.apache.slide.common.AbstractServiceBase

LOG_CHANNEL, namespace, scope

Fields inherited from interface javax.transaction.xa.XAResource

TMENDRSCAN, TMFAIL, TMJOIN, TMNOFLAGS, TMONEPHASE, TMRESUME, TMSTARTRSCAN, TMSUCCESS, TMSUSPEND, XA_OK, XA_RDONLY

Constructor Summary

StandardStore()
Constructor.

Method Summary

void	createObject(Uri uri, ObjectNode object) Create a new object in the Descriptors Store.
void	createRevisionContent(Uri uri, NodeRevisionDescriptor revisionDescriptor, NodeRevisionContent revisionContent) Create a new revision
void	createRevisionDescriptor(Uri uri, NodeRevisionDescriptor revisionDescriptor) Create new revision descriptor.
void	createRevisionDescriptors(Uri uri, NodeRevisionDescriptors revisionDescriptors) Create new revision descriptors.
protected void	delist(Service service, boolean success) Delist (suspend) the resource manager in the current transaction.
java.util.Enumeration	enumerateLocks(Uri uri) Returns the list of locks put on a subject.
java.util.Enumeration	enumeratePermissions(Uri uri) Read an object permissions.
void	grantPermission(Uri uri, NodePermission permission) Store an object permissions in the Descriptors Store.
void	initialize(NamespaceAccessToken token) Initializes descriptors store.
void	killLock(Uri uri, NodeLock lock) Kills a lock.
void	putLock(Uri uri, NodeLock lock) Puts a lock on a subject.
void	removeLock(Uri uri, NodeLock lock) Removes (cancels) a lock.
void	removeObject(Uri uri, ObjectNode object) Remove an object from the Descriptors Store.
void	removeRevisionContent(Uri uri, NodeRevisionDescriptor revisionDescriptor) Remove revision.
void	removeRevisionDescriptor(Uri uri, NodeRevisionNumber number) Remove revision descriptor.
void	removeRevisionDescriptors(Uri uri) Remove revision descriptors.
void	renewLock(Uri uri, NodeLock lock) Renews a lock.
protected void	resetCaches() Reset the caches.
ObjectNode	retrieveObject(Uri uri) Retrive an object from the Descriptors Store.
NodeRevisionContent	retrieveRevisionContent(Uri uri, NodeRevisionDescriptor revisionDescriptor) Retrive revision content.
NodeRevisionDescriptor	retrieveRevisionDescriptor(Uri uri, NodeRevisionNumber revisionNumber) Retrieve revision descriptor.
NodeRevisionDescriptors	retrieveRevisionDescriptors(Uri uri) Retrieve a revision descriptors.
void	revokePermission(Uri uri, NodePermission permission) Store an object permissions in the Descriptors Store.
void	revokePermissions(Uri uri) Revoke all the permissions on the object.
void	storeObject(Uri uri, ObjectNode object) Store an object in the Descriptors Store.
void	storeRevisionContent(Uri uri, NodeRevisionDescriptor revisionDescriptor, NodeRevisionContent revisionContent) Modify the latest revision of an object.
void	storeRevisionDescriptor(Uri uri, NodeRevisionDescriptor revisionDescriptor) Update revision descriptor.
void	storeRevisionDescriptors(Uri uri, NodeRevisionDescriptors revisionDescriptors) Update revision descriptors.
java.lang.String	toString() Return the name of this store

Methods inherited from class org.apache.slide.store.AbstractStore

addResourceManager, commit, connect, delist, delist, disconnect, end, enlist, enlist, forget, getDefaultStoreInstance, getName, isConnected, isForceStoreEnlistment, prepare, reset, rollback, setContentStore, setLockStore, setName, setNamespace, setNodeStore, setParameters, setRevisionDescriptorsStore, setRevisionDescriptorStore, setRollbackOnly, setScope, setSecurityStore, start

Methods inherited from class org.apache.slide.common.AbstractSimpleService

getTransactionTimeout, isSameRM, recover, setTransactionTimeout

Methods inherited from class org.apache.slide.common.AbstractServiceBase

cacheResults, connectIfNeeded, getLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.slide.common.Service

cacheResults, connectIfNeeded, getLogger

Methods inherited from interface javax.transaction.xa.XAResource

getTransactionTimeout, isSameRM, recover, setTransactionTimeout

Field Detail

objectsCache

protected ObjectCache objectsCache

Nodes cache.

permissionsCache

protected ObjectCache permissionsCache

Permissions cache.

locksCache

protected ObjectCache locksCache

Locks cache.

descriptorsCache

protected ObjectCache descriptorsCache

Revision descriptors cache.

descriptorCache

protected ObjectCache descriptorCache

Revision descriptor cache.

Constructor Detail

StandardStore

public StandardStore()

Constructor. Handles caches initialization.

Method Detail

initialize

public void initialize(NamespaceAccessToken token)
                throws ServiceInitializationFailedException

Initializes descriptors store.

Overrides:

initialize in class AbstractStore

Throws:

ServiceInitializationFailedException - Throws an exception if the descriptors store has already been initialized before

retrieveObject

public ObjectNode retrieveObject(Uri uri)
                          throws ServiceAccessException,
                                 ObjectNotFoundException

Retrive an object from the Descriptors Store.

Overrides:

retrieveObject in class AbstractStore

Parameters:

uri - Uri of the object we want to retrieve

Throws:

ServiceAccessException - Error accessing the Descriptors Store

ObjectNotFoundException - The object to retrieve was not found

storeObject

public void storeObject(Uri uri,
                        ObjectNode object)
                 throws ServiceAccessException,
                        ObjectNotFoundException

Store an object in the Descriptors Store.

Overrides:

storeObject in class AbstractStore

Parameters:

object - Object to update

Throws:

ServiceAccessException - Error accessing the Descriptors Store

ObjectNotFoundException - The object to update was not found

createObject

public void createObject(Uri uri,
                         ObjectNode object)
                  throws ServiceAccessException,
                         ObjectAlreadyExistsException

Create a new object in the Descriptors Store.

Overrides:

createObject in class AbstractStore

Parameters:

object - SlideObject

uri - Uri of the object we want to create

Throws:

ServiceAccessException - Error accessing the Descriptors Store

ObjectAlreadyExistsException - An object already exists at this Uri

removeObject

public void removeObject(Uri uri,
                         ObjectNode object)
                  throws ServiceAccessException,
                         ObjectNotFoundException

Remove an object from the Descriptors Store.

Overrides:

removeObject in class AbstractStore

Parameters:

object - Object to remove

Throws:

ServiceAccessException - Error accessing the Descriptors Store

ObjectNotFoundException - The object to remove was not found

grantPermission

public void grantPermission(Uri uri,
                            NodePermission permission)
                     throws ServiceAccessException

Store an object permissions in the Descriptors Store.

Overrides:

grantPermission in class AbstractStore

Parameters:

permission - Permission we want to create

Throws:

ServiceAccessException - Error accessing the Descriptors Store

revokePermission

public void revokePermission(Uri uri,
                             NodePermission permission)
                      throws ServiceAccessException

Store an object permissions in the Descriptors Store.

Overrides:

revokePermission in class AbstractStore

Parameters:

permission - Permission we want to create

Throws:

ServiceAccessException - Error accessing the Descriptors Store

revokePermissions

public void revokePermissions(Uri uri)
                       throws ServiceAccessException

Revoke all the permissions on the object.

Overrides:

revokePermissions in class AbstractStore

Parameters:

permission - Permission we want to create

Throws:

ServiceAccessException - Error accessing the Descriptors Store

enumeratePermissions

public java.util.Enumeration enumeratePermissions(Uri uri)
                                           throws ServiceAccessException

Read an object permissions.

Overrides:

enumeratePermissions in class AbstractStore

Parameters:

permission - Permission we want to create

Throws:

ServiceAccessException - Error accessing the Descriptors Store

putLock

public void putLock(Uri uri,
                    NodeLock lock)
             throws ServiceAccessException

Puts a lock on a subject.

Overrides:

putLock in class AbstractStore

Parameters:

lock - Lock token

Throws:

ServiceAccessException - Service access error

renewLock

public void renewLock(Uri uri,
                      NodeLock lock)
               throws ServiceAccessException,
                      LockTokenNotFoundException

Renews a lock.

Overrides:

renewLock in class AbstractStore

Parameters:

lock - Token to renew

Throws:

ServiceAccessException - Service access error

LockTokenNotFoundException - Lock token was not found

removeLock

public void removeLock(Uri uri,
                       NodeLock lock)
                throws ServiceAccessException,
                       LockTokenNotFoundException

Removes (cancels) a lock.

Overrides:

removeLock in class AbstractStore

Parameters:

lock - Token to remove

Throws:

ServiceAccessException - Service access error

LockTokenNotFoundException - Lock token was not found

killLock

public void killLock(Uri uri,
                     NodeLock lock)
              throws ServiceAccessException,
                     LockTokenNotFoundException

Kills a lock.

Overrides:

killLock in class AbstractStore

Parameters:

lock - Token to remove

Throws:

ServiceAccessException - Service access error

LockTokenNotFoundException - Lock token was not found

enumerateLocks

public java.util.Enumeration enumerateLocks(Uri uri)
                                     throws ServiceAccessException

Returns the list of locks put on a subject.

Overrides:

enumerateLocks in class AbstractStore

Parameters:

subject - Subject

Returns:

Enumeration List of locks which have been put on the subject

Throws:

ServiceAccessException - Service access error

retrieveRevisionDescriptors

public NodeRevisionDescriptors retrieveRevisionDescriptors(Uri uri)
                                                    throws ServiceAccessException,
                                                           RevisionDescriptorNotFoundException

Retrieve a revision descriptors.

Overrides:

retrieveRevisionDescriptors in class AbstractStore

Parameters:

uri - Uri

Throws:

ServiceAccessException - Service access error

RevisionDescriptorNotFoundException - Revision descriptor was not found

createRevisionDescriptors

public void createRevisionDescriptors(Uri uri,
                                      NodeRevisionDescriptors revisionDescriptors)
                               throws ServiceAccessException

Create new revision descriptors.

Overrides:

createRevisionDescriptors in class AbstractStore

Parameters:

uri - Uri

revisionDescriptors - Node revision descriptors

Throws:

ServiceAccessException - Service access error

storeRevisionDescriptors

public void storeRevisionDescriptors(Uri uri,
                                     NodeRevisionDescriptors revisionDescriptors)
                              throws ServiceAccessException,
                                     RevisionDescriptorNotFoundException

Update revision descriptors.

Overrides:

storeRevisionDescriptors in class AbstractStore

Parameters:

uri - Uri

revisionDescriptors - Node revision descriptors

Throws:

ServiceAccessException - Service access error

RevisionDescriptorNotFoundException - Revision descriptor was not found

removeRevisionDescriptors

public void removeRevisionDescriptors(Uri uri)
                               throws ServiceAccessException

Remove revision descriptors.

Overrides:

removeRevisionDescriptors in class AbstractStore

Parameters:

uri - Uri

Throws:

ServiceAccessException - Service access error

retrieveRevisionDescriptor

public NodeRevisionDescriptor retrieveRevisionDescriptor(Uri uri,
                                                         NodeRevisionNumber revisionNumber)
                                                  throws ServiceAccessException,
                                                         RevisionDescriptorNotFoundException

Retrieve revision descriptor.

Overrides:

retrieveRevisionDescriptor in class AbstractStore

Parameters:

Uri - uri

revisionNumber - Node revision number

createRevisionDescriptor

public void createRevisionDescriptor(Uri uri,
                                     NodeRevisionDescriptor revisionDescriptor)
                              throws ServiceAccessException

Create new revision descriptor.

Overrides:

createRevisionDescriptor in class AbstractStore

Parameters:

uri - Uri

revisionDescriptor - Node revision descriptor

Throws:

ServiceAccessException - Service access error

storeRevisionDescriptor

public void storeRevisionDescriptor(Uri uri,
                                    NodeRevisionDescriptor revisionDescriptor)
                             throws ServiceAccessException,
                                    RevisionDescriptorNotFoundException

Update revision descriptor.

Overrides:

storeRevisionDescriptor in class AbstractStore

Parameters:

uri - Uri

revisionDescriptors - Node revision descriptor

Throws:

ServiceAccessException - Service access error

RevisionDescriptorNotFoundException - Revision descriptor was not found

removeRevisionDescriptor

public void removeRevisionDescriptor(Uri uri,
                                     NodeRevisionNumber number)
                              throws ServiceAccessException

Remove revision descriptor.

Overrides:

removeRevisionDescriptor in class AbstractStore

Parameters:

uri - Uri

revisionNumber - Revision number

Throws:

ServiceAccessException - Service access error

retrieveRevisionContent

public NodeRevisionContent retrieveRevisionContent(Uri uri,
                                                   NodeRevisionDescriptor revisionDescriptor)
                                            throws ServiceAccessException,
                                                   RevisionNotFoundException

Retrive revision content.

Overrides:

retrieveRevisionContent in class AbstractStore

Parameters:

uri - Uri

revisionNumber - Node revision number

createRevisionContent

public void createRevisionContent(Uri uri,
                                  NodeRevisionDescriptor revisionDescriptor,
                                  NodeRevisionContent revisionContent)
                           throws ServiceAccessException,
                                  RevisionAlreadyExistException

Create a new revision

Overrides:

createRevisionContent in class AbstractStore

Parameters:

uri - Uri

revisionDescriptor - Node revision descriptor

revisionContent - Node revision content

storeRevisionContent

public void storeRevisionContent(Uri uri,
                                 NodeRevisionDescriptor revisionDescriptor,
                                 NodeRevisionContent revisionContent)
                          throws ServiceAccessException,
                                 RevisionNotFoundException

Modify the latest revision of an object.

Overrides:

storeRevisionContent in class AbstractStore

Parameters:

uri - Uri

revisionDescriptor - Node revision descriptor

revisionContent - Node revision content

removeRevisionContent

public void removeRevisionContent(Uri uri,
                                  NodeRevisionDescriptor revisionDescriptor)
                           throws ServiceAccessException

Remove revision.

Overrides:

removeRevisionContent in class AbstractStore

Parameters:

uri - Uri

revisionNumber - Node revision number

toString

public java.lang.String toString()

Return the name of this store

Overrides:

toString in class java.lang.Object

delist

protected void delist(Service service,
                      boolean success)
               throws ServiceAccessException

Delist (suspend) the resource manager in the current transaction.

Overrides:

delist in class AbstractStore

resetCaches

protected void resetCaches()

Reset the caches.