org.fcrepo.http.api

Class DefaultPathLockManager

java.lang.Object

org.fcrepo.http.api.DefaultPathLockManager

All Implemented Interfaces:

PathLockManager

@Component
public class DefaultPathLockManager
extends Object
implements PathLockManager

A class that serves as a pool lockable paths to guarantee synchronized accesses to the resources at those paths. Because there may be an extremely high number of paths in the repository, this implementation is complicated by a need to ensure that for a given path, only one set of locks exists and only until all the locks have been acquired and released. Because this is very complex code, extensive logging is produced at the TRACE level.

Author:

Mike Durbin

Nested Class Summary

Nested classes/interfaces inherited from interface org.fcrepo.http.api.PathLockManager

PathLockManager.AcquiredLock

Constructor Summary

Constructors

Constructor and Description
DefaultPathLockManager()

Method Summary

Modifier and Type	Method and Description
PathLockManager.AcquiredLock	lockForDelete(String path) Locks the necessary resources affected in order to safely delete a resource at the given path.
PathLockManager.AcquiredLock	lockForRead(String path) Locks the necessary resources affected in order to safely view a resource at the given path.
PathLockManager.AcquiredLock	lockForWrite(String path, FedoraSession session, NodeService nodeService) Locks the necessary resources affected in order to safely write to a resource at the given path.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPathLockManager

public DefaultPathLockManager()

Method Detail

lockForRead

public PathLockManager.AcquiredLock lockForRead(String path)

Description copied from interface: PathLockManager

Locks the necessary resources affected in order to safely view a resource at the given path. A successful return from this method should guarantee that until release() is invoked on the returned Lock that no changes are made to the resource that would affect its display.

Specified by:

lockForRead in interface PathLockManager

Parameters:

path - the path to a resource to be viewed

Returns:

an acquired Lock on the relevant resources

lockForWrite

public PathLockManager.AcquiredLock lockForWrite(String path,
                                                 FedoraSession session,
                                                 NodeService nodeService)

Description copied from interface: PathLockManager

Locks the necessary resources affected in order to safely write to a resource at the given path. A successful return from this method should guarantee that until release() is invoked on the returned Lock that no other callers may be granted locks necessary to add, modify or delete the resource at the provided path.

Specified by:

lockForWrite in interface PathLockManager

Parameters:

path - the path to a resource to be created (may involve implicitly created resources at parent paths)

session - the current session

nodeService - the repository NodeService implementation

Returns:

an acquired Lock on the relevant resources

lockForDelete

public PathLockManager.AcquiredLock lockForDelete(String path)

Description copied from interface: PathLockManager

Locks the necessary resources affected in order to safely delete a resource at the given path. A successful return from this method should guarantee that until release() is invoked on the returned Lock that no other callers may be granted locks necessary to add, modify or delete the resource at the provided path or any child path (because deletes cascade).

Specified by:

lockForDelete in interface PathLockManager

Parameters:

path - the path to a resource to be deleted (may imply the deletion of all descendant resources)

Returns:

an acquired Lock on the relevant resources