org.alfresco.jlan.server.locking

Interface LockManager

All Known Implementing Classes:

FileStateLockManager, NIOLockManager

public interface LockManager

Lock Manager Interface

A lock manager implementation provides file locking support for a virtual filesystem.

Author:

gkspencer

Method Summary

Methods

Modifier and Type	Method and Description
FileLock	createLockObject(SrvSession sess, TreeConnection tree, NetworkFile file, long offset, long len, int pid) Create a lock object, allows the FileLock object to be extended
void	lockFile(SrvSession sess, TreeConnection tree, NetworkFile file, FileLock lock) Lock a byte range within a file, or the whole file.
void	releaseLocksForFile(SrvSession sess, TreeConnection tree, NetworkFile file) Release all locks that a session has on a file.
void	unlockFile(SrvSession sess, TreeConnection tree, NetworkFile file, FileLock lock) Unlock a byte range within a file, or the whole file

Method Detail

lockFile

void lockFile(SrvSession sess,
            TreeConnection tree,
            NetworkFile file,
            FileLock lock)
              throws LockConflictException,
                     IOException

Lock a byte range within a file, or the whole file.

Parameters:

sess - SrvSession

tree - TreeConnection

file - NetworkFile

lock - FileLock

Throws:

LockConflictException

IOException

unlockFile

void unlockFile(SrvSession sess,
              TreeConnection tree,
              NetworkFile file,
              FileLock lock)
                throws NotLockedException,
                       IOException

Unlock a byte range within a file, or the whole file

Parameters:

sess - SrvSession

tree - TreeConnection

file - NetworkFile

lock - FileLock

Throws:

NotLockedException

IOException

createLockObject

FileLock createLockObject(SrvSession sess,
                        TreeConnection tree,
                        NetworkFile file,
                        long offset,
                        long len,
                        int pid)

Create a lock object, allows the FileLock object to be extended

Parameters:

sess - SrvSession

tree - TreeConnection

file - NetworkFile

offset - long

len - long

pid - int

Returns:

FileLock

releaseLocksForFile

void releaseLocksForFile(SrvSession sess,
                       TreeConnection tree,
                       NetworkFile file)

Release all locks that a session has on a file. This method is called to perform cleanup if a file is closed that has active locks or if a session abnormally terminates.

Parameters:

sess - SrvSession

tree - TreeConnection

file - NetworkFile