org.alfresco.jlan.server.filesys.cache

Class FileStateLockManager

java.lang.Object

org.alfresco.jlan.server.filesys.cache.FileStateLockManager

All Implemented Interfaces:

Runnable, LockManager, OpLockManager

public class FileStateLockManager
extends Object
implements LockManager, OpLockManager, Runnable

File State Lock Manager Class

Lock manager implementation for byte range locking and oplocks that uses the file state cache to track locks/oplocks.

Author:

gkspencer

Constructor Summary

Constructors

Constructor and Description
FileStateLockManager(FileStateCache stateCache) Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelOplockTimer(String path) Cancel an oplock break timer
void	changeOpLockType(OpLockDetails oplock, int newTyp) Change an oplock type
int	checkExpiredOplockBreaks() Check for expired oplock break requests
FileLock	createLockObject(SrvSession sess, TreeConnection tree, NetworkFile file, long offset, long len, int pid) Create a file lock object.
OpLockDetails	getOpLockDetails(String path) Return the oplock details for a path, or null if there is no oplock on the path
boolean	grantOpLock(String path, OpLockDetails oplock, NetworkFile netFile) Grant an oplock, store the oplock details
int	hasOpLock(String path) Check if there is an oplock for the specified path, return the oplock type.
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	releaseOpLock(String path) Release an oplock
void	requestOpLockBreak(String path, OpLockDetails oplock, SMBSrvSession sess, SMBSrvPacket pkt) Request an oplock break on the specified oplock
void	run() Run the oplock break expiry
void	shutdownRequest() Request the oplock break expiry thread to shutdown
void	startLockManager(String threadName, ThreadRequestPool threadPool) Start the lock manager
void	unlockFile(SrvSession sess, TreeConnection tree, NetworkFile file, FileLock lock) Unlock a byte range within a file, or the whole file

Methods inherited from class java.lang.Object

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

Constructor Detail

FileStateLockManager

public FileStateLockManager(FileStateCache stateCache)

Class constructor

Parameters:

stateCache - FileStateCache

Method Detail

lockFile

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

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

Specified by:

lockFile in interface LockManager

Parameters:

sess - SrvSession

tree - TreeConnection

file - NetworkFile

lock - FileLock

Throws:

LockConflictException

IOException

unlockFile

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

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

Specified by:

unlockFile in interface LockManager

Parameters:

sess - SrvSession

tree - TreeConnection

file - NetworkFile

lock - FileLock

Throws:

NotLockedException

IOException

createLockObject

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

Create a file lock object.

Specified by:

createLockObject in interface LockManager

Parameters:

sess - SrvSession

tree - TreeConnection

file - NetworkFile

offset - long

len - long

pid - int

Returns:

FileLock

releaseLocksForFile

public 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.

Specified by:

releaseLocksForFile in interface LockManager

Parameters:

sess - SrvSession

tree - TreeConnection

file - NetworkFile

hasOpLock

public int hasOpLock(String path)

Check if there is an oplock for the specified path, return the oplock type.

Specified by:

hasOpLock in interface OpLockManager

Parameters:

path - String

Returns:

int

getOpLockDetails

public OpLockDetails getOpLockDetails(String path)

Return the oplock details for a path, or null if there is no oplock on the path

Specified by:

getOpLockDetails in interface OpLockManager

Parameters:

path - String

Returns:

OpLockDetails

grantOpLock

public boolean grantOpLock(String path,
                  OpLockDetails oplock,
                  NetworkFile netFile)
                    throws ExistingOpLockException

Grant an oplock, store the oplock details

Specified by:

grantOpLock in interface OpLockManager

Parameters:

path - String

oplock - OpLockDetails

netFile - NetworkFile

Returns:

boolean

Throws:

ExistingOpLockException - If the file already has an oplock

requestOpLockBreak

public void requestOpLockBreak(String path,
                      OpLockDetails oplock,
                      SMBSrvSession sess,
                      SMBSrvPacket pkt)
                        throws IOException,
                               DeferFailedException

Request an oplock break on the specified oplock

Specified by:

requestOpLockBreak in interface OpLockManager

Parameters:

path - String

oplock - OpLockDetails

sess - SMBSrvSession

pkt - SMBSrvPacket

Throws:

IOException

DeferFailedException

releaseOpLock

public void releaseOpLock(String path)

Release an oplock

Specified by:

releaseOpLock in interface OpLockManager

Parameters:

path - String

changeOpLockType

public void changeOpLockType(OpLockDetails oplock,
                    int newTyp)

Change an oplock type

Specified by:

changeOpLockType in interface OpLockManager

Parameters:

oplock - OpLockDetails

newTyp - int

cancelOplockTimer

public void cancelOplockTimer(String path)

Cancel an oplock break timer

Specified by:

cancelOplockTimer in interface OpLockManager

Parameters:

path - String

checkExpiredOplockBreaks

public int checkExpiredOplockBreaks()

Check for expired oplock break requests

Specified by:

checkExpiredOplockBreaks in interface OpLockManager

Returns:

int

run

public void run()

Run the oplock break expiry

Specified by:

run in interface Runnable

shutdownRequest

public final void shutdownRequest()

Request the oplock break expiry thread to shutdown

startLockManager

public final void startLockManager(String threadName,
                    ThreadRequestPool threadPool)

Start the lock manager

Parameters:

threadName - String

threadPool - ThreadRequestPool