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

Class ClusterBase

java.lang.Object

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

All Implemented Interfaces:

ClusterInterface

public abstract class ClusterBase
extends Object
implements ClusterInterface

Cluster Interface Base Class

Author:

gkspencer

Field Summary

Fields

Modifier and Type	Field and Description
static String	DefaultClusterName
static long	DefaultLowPriorityQueueInterval

Constructor Summary

Constructors

Constructor and Description
ClusterBase(ClusterFileStateCache stateCache, String clusterName, ThreadRequestPool threadPool) Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
String	getClusterName() Return the cluster name
ClusterNode	getLocalNode() Return the local node details
ClusterNodeList	getNodeList() Return the list of nodes
NotifyChangeHandler	getNotifyChangeHandler() Return the change notification handler, if configured for the filesystem
OpLockManager	getOpLockManager() Return the oplock manager
ClusterFileStateCache	getStateCache() Return the associated cluster state cache
ThreadRequestPool	getThreadPool() Return the thread pool
boolean	hasDebug() Check if debug output is enabled
boolean	hasSendNotExistStates() Check if none existent file/folder states should be sent to the cluster
abstract void	requestOplockBreak(ClusterNode clNode, ClusterFileState clState) Request an oplock break
void	setLocalNode(ClusterNode localNode) Set the local cluster node
void	setNodeList(ClusterNodeList nodeList) Set the cluster node list
void	setNotifyChangeHandler(NotifyChangeHandler notifyHandler) Set the change notification handler
void	setOpLockManager(OpLockManager oplockMgr) Set the oplock manager
void	setSendNotExistStates(boolean notExist) Set the send none existent file/folder states to the cluster
abstract void	shutdownCluster() Shutdown the cluster
abstract void	startCluster() Start the cluster

Methods inherited from class java.lang.Object

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

Field Detail

DefaultClusterName

public static final String DefaultClusterName

See Also:

Constant Field Values

DefaultLowPriorityQueueInterval

public static final long DefaultLowPriorityQueueInterval

See Also:

Constant Field Values

Constructor Detail

ClusterBase

public ClusterBase(ClusterFileStateCache stateCache,
           String clusterName,
           ThreadRequestPool threadPool)

Class constructor

Parameters:

stateCache - ClusterFileStateCache

clusterName - String

threadPool - ThreadRequestPool

Method Detail

startCluster

public abstract void startCluster()
                           throws Exception

Start the cluster

Specified by:

startCluster in interface ClusterInterface

Throws:

Exception

shutdownCluster

public abstract void shutdownCluster()
                              throws Exception

Shutdown the cluster

Specified by:

shutdownCluster in interface ClusterInterface

Throws:

Exception

getClusterName

public final String getClusterName()

Return the cluster name

Specified by:

getClusterName in interface ClusterInterface

Returns:

String

getNodeList

public final ClusterNodeList getNodeList()

Return the list of nodes

Specified by:

getNodeList in interface ClusterInterface

Returns:

ClusterNodeList

getLocalNode

public final ClusterNode getLocalNode()

Return the local node details

Specified by:

getLocalNode in interface ClusterInterface

Returns:

ClusterNode

getStateCache

public final ClusterFileStateCache getStateCache()

Return the associated cluster state cache

Specified by:

getStateCache in interface ClusterInterface

Returns:

ClusterFileStateCache

getThreadPool

public final ThreadRequestPool getThreadPool()

Return the thread pool

Specified by:

getThreadPool in interface ClusterInterface

Returns:

ThreadRequestPool

hasDebug

public final boolean hasDebug()

Check if debug output is enabled

Specified by:

hasDebug in interface ClusterInterface

Returns:

boolean

hasSendNotExistStates

public final boolean hasSendNotExistStates()

Check if none existent file/folder states should be sent to the cluster

Specified by:

hasSendNotExistStates in interface ClusterInterface

Returns:

boolean

getOpLockManager

public final OpLockManager getOpLockManager()

Return the oplock manager

Specified by:

getOpLockManager in interface ClusterInterface

Returns:

OpLockManager

getNotifyChangeHandler

public final NotifyChangeHandler getNotifyChangeHandler()

Return the change notification handler, if configured for the filesystem

Specified by:

getNotifyChangeHandler in interface ClusterInterface

Returns:

NotifyChangeHandler

setSendNotExistStates

public final void setSendNotExistStates(boolean notExist)

Set the send none existent file/folder states to the cluster

Specified by:

setSendNotExistStates in interface ClusterInterface

Parameters:

notExist - boolean

setOpLockManager

public final void setOpLockManager(OpLockManager oplockMgr)

Set the oplock manager

Specified by:

setOpLockManager in interface ClusterInterface

Parameters:

oplockMgr - OpLockManager

setNotifyChangeHandler

public final void setNotifyChangeHandler(NotifyChangeHandler notifyHandler)

Set the change notification handler

Specified by:

setNotifyChangeHandler in interface ClusterInterface

Parameters:

notifyHandler - NotifyChangeHandler

setNodeList

public final void setNodeList(ClusterNodeList nodeList)

Set the cluster node list

Specified by:

setNodeList in interface ClusterInterface

Parameters:

nodeList - ClusterNodeList

setLocalNode

public final void setLocalNode(ClusterNode localNode)

Set the local cluster node

Specified by:

setLocalNode in interface ClusterInterface

Parameters:

localNode - ClusterNode

requestOplockBreak

public abstract void requestOplockBreak(ClusterNode clNode,
                      ClusterFileState clState)
                                 throws IOException

Request an oplock break

Parameters:

clNode - ClusterNode

clState - ClusterFileState

Throws:

IOException