org.alfresco.jlan.server.filesys.cache.cluster

Class ClusterFileStateCache

java.lang.Object

org.alfresco.jlan.server.filesys.cache.FileStateCache

org.alfresco.jlan.server.filesys.cache.cluster.ClusterFileStateCache

Direct Known Subclasses:

HazelCastClusterFileStateCache

public abstract class ClusterFileStateCache
extends FileStateCache

Cluster File State Cache Class

Field Summary

Fields inherited from class org.alfresco.jlan.server.filesys.cache.FileStateCache

DefaultExpireCheckInterval, DefaultFileStateExpireInterval, MinimumExpireCheckInterval, MinimumFileStateExpireInterval

Constructor Summary

Constructors

Constructor and Description
ClusterFileStateCache() Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addNodeToPurgeList(ClusterNode clNode) Add a node to the state cache purge list, as it has left the cluster
abstract boolean	canReadFile(ClusterFileState clState, long offset, long len, int pid) Check if the file is readable for the specified section of the file and process id
abstract boolean	canWriteFile(ClusterFileState clState, long offset, long len, int pid) Check if the file is writeable for the specified section of the file and process id
void	clusterRunning() Cluster connection is running
ClusterInterface	getCluster() Return the associated cluster view
abstract PerNodeState	getPerNodeState(ClusterFileState fState, boolean createState) Return the per node state for a file state, and optionally create a new per node state
abstract PerNodeState	getPerNodeState(java.lang.String path, boolean createState) Return the per node state for a file state, and optionally create a new per node state
boolean	isClusteredCache() Determine if the cache is a clustered cache
protected void	setCluster(ClusterInterface cluster) Set the associated cluster
void	setDriverDetails(DiskSharedDevice diskDev) Set the filesystem driver and driver context details, if required by the cache
void	stateCacheShuttingDown() Cache shutting down
void	stateCacheStarted() Cache started
abstract void	updateFileState(ClusterFileState clState, int updateMask) Update a file state, notify the cluster of the updates

Methods inherited from class org.alfresco.jlan.server.filesys.cache.FileStateCache

addLock, addOpLock, addStateCacheListener, addStateListener, changeOpLockType, clearOpLock, createFileLockObject, dumpCache, findFileState, findFileState, findFileState, getCheckInterval, getFileStateExpireInterval, getFileStateProxy, getOpLock, getStateCacheListener, getStateListener, grantFileAccess, hasActiveLocks, hasDebug, hasDebugExpiredStates, hasDumpOnShutdown, hasStateCacheListener, hasStateListener, initializeCache, isCaseSensitive, numberOfStates, releaseFileAccess, removeAllFileStates, removeExpiredFileStates, removeFileState, removeLock, removeStateCacheListener, removeStateListener, renameFileState, requestOplockBreak, setCaseSensitive, setCheckInterval, setDataUpdateCompleted, setDataUpdateInProgress, setDebug, setDebugExpiredStates, setDumpOnShutdown, setFileStateExpireInterval

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterFileStateCache

public ClusterFileStateCache()

Class constructor

Method Detail

isClusteredCache

public boolean isClusteredCache()

Determine if the cache is a clustered cache

Overrides:

isClusteredCache in class FileStateCache

Returns:

boolean

getPerNodeState

public abstract PerNodeState getPerNodeState(ClusterFileState fState,
                           boolean createState)

Return the per node state for a file state, and optionally create a new per node state

Parameters:

fState - ClusterFileState

createState - boolean

Returns:

PerNodeState

getPerNodeState

public abstract PerNodeState getPerNodeState(java.lang.String path,
                           boolean createState)

Return the per node state for a file state, and optionally create a new per node state

Parameters:

path - String

createState - boolean

Returns:

PerNodeState

canReadFile

public abstract boolean canReadFile(ClusterFileState clState,
                  long offset,
                  long len,
                  int pid)

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

Parameters:

clState - ClusterFileState

offset - long

len - long

pid - int

Returns:

boolean

canWriteFile

public abstract boolean canWriteFile(ClusterFileState clState,
                   long offset,
                   long len,
                   int pid)

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

Parameters:

clState - ClusterFileState

offset - long

len - long

pid - int

Returns:

boolean

updateFileState

public abstract void updateFileState(ClusterFileState clState,
                   int updateMask)

Update a file state, notify the cluster of the updates

Parameters:

clState - ClusterFileState

updateMask - int

setDriverDetails

public void setDriverDetails(DiskSharedDevice diskDev)

Set the filesystem driver and driver context details, if required by the cache

Overrides:

setDriverDetails in class FileStateCache

Parameters:

diskDev - DiskSharedDevice

getCluster

public final ClusterInterface getCluster()

Return the associated cluster view

Returns:

ClusterInterface

setCluster

protected final void setCluster(ClusterInterface cluster)

Set the associated cluster

Parameters:

cluster - ClusterInterface

stateCacheStarted

public void stateCacheStarted()

Cache started

Overrides:

stateCacheStarted in class FileStateCache

stateCacheShuttingDown

public void stateCacheShuttingDown()

Cache shutting down

Overrides:

stateCacheShuttingDown in class FileStateCache

addNodeToPurgeList

protected final void addNodeToPurgeList(ClusterNode clNode)

Add a node to the state cache purge list, as it has left the cluster

Parameters:

clNode - ClusterNode

clusterRunning

public final void clusterRunning()

Cluster connection is running