Package org.apache.manifoldcf.core.lockmanager

Class FileLockManager

java.lang.Object

org.apache.manifoldcf.core.lockmanager.BaseLockManager

org.apache.manifoldcf.core.lockmanager.FileLockManager

All Implemented Interfaces:

ILockManager

public class FileLockManager
extends BaseLockManager

This is the file-based lock manager.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	FileLockManager.ByteArrayBuffer

Nested classes/interfaces inherited from class org.apache.manifoldcf.core.lockmanager.BaseLockManager

BaseLockManager.LockDescription

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	_rcsid
protected static int	BASE_SIZE
protected static java.lang.Integer	lockPoolInitialization
protected static LockPool	myFileLocks
protected java.io.File	synchDirectory
static java.lang.String	synchDirectoryProperty	Synchronization directory property - local to this implementation of ILockManager

Fields inherited from class org.apache.manifoldcf.core.lockmanager.BaseLockManager

activePrefix, anonymousServiceNamePrefix, anonymousServiceTypeCounter, globalData, globalFlags, localLocks, localSections, myLocks, mySections, serviceDataPrefix, serviceListPrefix, servicePrefix, serviceTypeLockPrefix, threadID, TYPE_READ, TYPE_WRITE, TYPE_WRITENONEX

Constructor Summary

Constructors

Constructor	Description
FileLockManager()
FileLockManager(java.io.File synchDirectory)

Method Summary

Modifier and Type	Method	Description
boolean	checkGlobalFlag(java.lang.String flagName)	Check the condition of a specified flag.
void	clearGlobalFlag(java.lang.String flagName)	Clear a flag.
protected static java.lang.String	getFlagResourceName(java.lang.String flagName)	Calculate the name of a flag resource.
protected LockPool	getGlobalLockPool()	Override this method to change the nature of global locks.
static java.io.File	getSynchDirectoryProperty()	Get the synch directory property.
protected java.lang.String	makeFilePath(java.lang.String key)	Create a file path given a key name.
byte[]	readData(java.lang.String resourceName)	Read data from a shared data resource.
void	setGlobalFlag(java.lang.String flagName)	Raise a flag.
void	writeData(java.lang.String resourceName, byte[] data)	Write data to a shared data resource.

Methods inherited from class org.apache.manifoldcf.core.lockmanager.BaseLockManager

buildServiceListEntry, buildServiceTypeLockName, checkServiceActive, cleanupInactiveService, clear, clearLocks, constructUniqueServiceName, countActiveServices, deleteServiceData, endServiceActivity, enter, enterCriticalSections, enterLocks, enterLocksNoWait, enterNonExWrite, enterNonExWriteCriticalSection, enterNonExWriteLock, enterNonExWriteLockNoWait, enterNonExWriteNoWait, enterNoWait, enterRead, enterReadCriticalSection, enterReadLock, enterReadLockNoWait, enterReadNoWait, enterWrite, enterWriteCriticalSection, enterWriteLock, enterWriteLockNoWait, enterWriteNoWait, getSharedConfiguration, getSortedUniqueLocks, leave, leaveCriticalSections, leaveLocks, leaveNonExWrite, leaveNonExWriteCriticalSection, leaveNonExWriteLock, leaveRead, leaveReadCriticalSection, leaveReadLock, leaveWrite, leaveWriteCriticalSection, leaveWriteLock, makeActiveServiceFlagName, makeRegisteredServiceFlagName, makeServiceCounterName, makeServiceDataName, readServiceCounter, readServiceData, readServiceName, registerServiceBeginServiceActivity, registerServiceBeginServiceActivity, retrieveServiceData, scanServiceData, timedWait, updateServiceData, writeServiceCounter, writeServiceData, writeServiceName

Methods inherited from class java.lang.Object

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

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:

Constant Field Values

synchDirectoryProperty

public static final java.lang.String synchDirectoryProperty

Synchronization directory property - local to this implementation of ILockManager

See Also:

Constant Field Values

lockPoolInitialization

protected static final java.lang.Integer lockPoolInitialization

myFileLocks

protected static LockPool myFileLocks

synchDirectory

protected java.io.File synchDirectory

BASE_SIZE

protected static final int BASE_SIZE

See Also:

Constant Field Values

Constructor Detail

FileLockManager

public FileLockManager(java.io.File synchDirectory)
                throws ManifoldCFException

Throws:

ManifoldCFException

FileLockManager

public FileLockManager()
                throws ManifoldCFException

Throws:

ManifoldCFException

Method Detail

getSynchDirectoryProperty

public static java.io.File getSynchDirectoryProperty()
                                              throws ManifoldCFException

Get the synch directory property.

Throws:

ManifoldCFException

getFlagResourceName

protected static java.lang.String getFlagResourceName(java.lang.String flagName)

Calculate the name of a flag resource.

Parameters:

flagName - is the name of the flag.

Returns:

the name for the flag resource.

setGlobalFlag

public void setGlobalFlag(java.lang.String flagName)
                   throws ManifoldCFException

Raise a flag. Use this method to assert a condition, or send a global signal. The flag will be reset when the entire system is restarted.

Specified by:

setGlobalFlag in interface ILockManager

Overrides:

setGlobalFlag in class BaseLockManager

Parameters:

flagName - is the name of the flag to set.

Throws:

ManifoldCFException

clearGlobalFlag

public void clearGlobalFlag(java.lang.String flagName)
                     throws ManifoldCFException

Clear a flag. Use this method to clear a condition, or retract a global signal.

Specified by:

clearGlobalFlag in interface ILockManager

Overrides:

clearGlobalFlag in class BaseLockManager

Parameters:

flagName - is the name of the flag to clear.

Throws:

ManifoldCFException

checkGlobalFlag

public boolean checkGlobalFlag(java.lang.String flagName)
                        throws ManifoldCFException

Check the condition of a specified flag.

Specified by:

checkGlobalFlag in interface ILockManager

Overrides:

checkGlobalFlag in class BaseLockManager

Parameters:

flagName - is the name of the flag to check.

Returns:

true if the flag is set, false otherwise.

Throws:

ManifoldCFException

readData

public byte[] readData(java.lang.String resourceName)
                throws ManifoldCFException

Read data from a shared data resource. Use this method to read any existing data, or get a null back if there is no such resource. Note well that this is not necessarily an atomic operation, and it must thus be protected by a lock.

Specified by:

readData in interface ILockManager

Overrides:

readData in class BaseLockManager

Parameters:

resourceName - is the global name of the resource.

Returns:

a byte array containing the data, or null.

Throws:

ManifoldCFException

writeData

public void writeData(java.lang.String resourceName,
                      byte[] data)
               throws ManifoldCFException

Write data to a shared data resource. Use this method to write a body of data into a shared resource. Note well that this is not necessarily an atomic operation, and it must thus be protected by a lock.

Specified by:

writeData in interface ILockManager

Overrides:

writeData in class BaseLockManager

Parameters:

resourceName - is the global name of the resource.

data - is the byte array containing the data. Pass null if you want to delete the resource completely.

Throws:

ManifoldCFException

getGlobalLockPool

protected LockPool getGlobalLockPool()

Override this method to change the nature of global locks.

Overrides:

getGlobalLockPool in class BaseLockManager

makeFilePath

protected java.lang.String makeFilePath(java.lang.String key)

Create a file path given a key name.

Parameters:

key - is the key name.

Returns:

the file path.