org.alfresco.jlan.locking

Class FileLockList

java.lang.Object

org.alfresco.jlan.locking.FileLockList

All Implemented Interfaces:

java.io.Serializable

public class FileLockList
extends java.lang.Object
implements java.io.Serializable

File Lock List Class

Contains a list of the current locks on a file.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FileLockList() Construct an empty file lock list.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLock(FileLock lock) Add a lock to the list
boolean	allowsLock(FileLock lock) Check if the new lock should be allowed by comparing with the locks in the list.
boolean	canReadFile(FileLock lock) Check if the file is readable for the specified section of the file and process id
boolean	canReadFile(long offset, long len, int pid) Check if the file is readable for the specified section of the file and process id
boolean	canWriteFile(FileLock lock) Check if the file is writeable for the specified section of the file and process id
boolean	canWriteFile(long offset, long len, int pid) Check if the file is writeable for the specified section of the file and process id
FileLock	findLock(FileLock lock) Find the matching lock
FileLock	findLock(long offset, long len, int pid) Find the matching lock
FileLock	getLockAt(int idx) Return the specified lock details
int	numberOfLocks() Return the count of locks in the list.
void	removeAllLocks() Remove all locks from the list
FileLock	removeLock(FileLock lock) Remove a lock from the list
FileLock	removeLock(long offset, long len, int pid) Remove a lock from the list
FileLock	removeLockAt(int idx) Remove the lock at the specified index in the list

Methods inherited from class java.lang.Object

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

Constructor Detail

FileLockList

public FileLockList()

Construct an empty file lock list.

Method Detail

addLock

public final void addLock(FileLock lock)

Add a lock to the list

Parameters:

lock - Lock to be added to the list.

findLock

public final FileLock findLock(FileLock lock)

Find the matching lock

Parameters:

lock - FileLock

Returns:

FileLock

findLock

public final FileLock findLock(long offset,
                long len,
                int pid)

Find the matching lock

Parameters:

offset - long

len - long

pid - int

Returns:

FileLock

removeLock

public final FileLock removeLock(FileLock lock)

Remove a lock from the list

Parameters:

lock - FileLock

Returns:

FileLock

removeLock

public final FileLock removeLock(long offset,
                  long len,
                  int pid)

Remove a lock from the list

Parameters:

offset - Starting offset of the lock

len - Locked section length

pid - Owner process id

Returns:

FileLock

removeAllLocks

public final void removeAllLocks()

Remove all locks from the list

getLockAt

public final FileLock getLockAt(int idx)

Return the specified lock details

Parameters:

idx - Lock index

Returns:

FileLock

removeLockAt

public final FileLock removeLockAt(int idx)

Remove the lock at the specified index in the list

Parameters:

idx - Lock index

Returns:

FileLock

allowsLock

public final boolean allowsLock(FileLock lock)

Check if the new lock should be allowed by comparing with the locks in the list.

Parameters:

lock - FileLock

Returns:

boolean true if the lock can be granted, else false.

canReadFile

public final boolean canReadFile(FileLock lock)

Check if the file is readable for the specified section of the file and process id

Parameters:

lock - FileLock

Returns:

boolean

canReadFile

public final boolean canReadFile(long offset,
                  long len,
                  int pid)

Check if the file is readable for the specified section of the file and process id

Parameters:

offset - long

len - long

pid - int

Returns:

boolean

canWriteFile

public final boolean canWriteFile(FileLock lock)

Check if the file is writeable for the specified section of the file and process id

Parameters:

lock - FileLock

Returns:

boolean

canWriteFile

public final boolean canWriteFile(long offset,
                   long len,
                   int pid)

Check if the file is writeable for the specified section of the file and process id

Parameters:

offset - long

len - long

pid - int

Returns:

boolean

numberOfLocks

public final int numberOfLocks()

Return the count of locks in the list.

Returns:

int Number of locks in the list.