org.alfresco.jlan.server.filesys.cache.hazelcast

Class RemoteStateTask<T>

java.lang.Object

org.alfresco.jlan.server.filesys.cache.hazelcast.RemoteStateTask<T>

All Implemented Interfaces:

com.hazelcast.core.HazelcastInstanceAware, Serializable, Callable<T>

Direct Known Subclasses:

AddFileByteLockTask, AddOpLockTask, ChangeOpLockTypeTask, CheckFileByteLockTask, FileDataUpdateTask, GrantFileAccessTask, ReleaseFileAccessTask, RemoveFileByteLockTask, RemoveOpLockTask, RenameStateTask, UpdateStateTask

public abstract class RemoteStateTask<T>
extends Object
implements Callable<T>, com.hazelcast.core.HazelcastInstanceAware, Serializable

Remote File State Cache Task Class

Base class for remote file state cache tasks.

Author:

gkspencer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	TaskDebug
static int	TaskLockState
static int	TaskNoUpdate
static int	TaskTiming

Constructor Summary

Constructors

Constructor and Description
RemoteStateTask() Default constructor
RemoteStateTask(String mapName, String key, boolean lockState, boolean noUpdate, boolean debug, boolean timingDebug) Class constructor
RemoteStateTask(String mapName, String key, int options) Class constructor

Method Summary

Modifier and Type	Method and Description
T	call() Run the remote task
com.hazelcast.core.HazelcastInstance	getHazelcastInstance() Get the Hazelcast instance
String	getKey() Return the file state key
String	getMapName() Return the clustered map name
String	getTaskName() Get the task name
boolean	hasDebug() Check if debug output is enabled for this remote task
boolean	hasOption(int option) Check if the specifed task option is enabled
boolean	hasTimingDebug() Check if the timing debug output is enabled for this remote task
protected abstract T	runRemoteTaskAgainstState(com.hazelcast.core.IMap<String,ClusterFileState> stateCache, ClusterFileState fState) Run a remote task against a file state
void	setHazelcastInstance(com.hazelcast.core.HazelcastInstance hcInstance) Set the Hazelcast instance

Methods inherited from class java.lang.Object

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

Field Detail

TaskDebug

public static final int TaskDebug

See Also:

Constant Field Values

TaskLockState

public static final int TaskLockState

See Also:

Constant Field Values

TaskNoUpdate

public static final int TaskNoUpdate

See Also:

Constant Field Values

TaskTiming

public static final int TaskTiming

See Also:

Constant Field Values

Constructor Detail

RemoteStateTask

public RemoteStateTask()

Default constructor

RemoteStateTask

public RemoteStateTask(String mapName,
                       String key,
                       int options)

Class constructor

Parameters:

mapName - String

key - String

options - int

RemoteStateTask

public RemoteStateTask(String mapName,
                       String key,
                       boolean lockState,
                       boolean noUpdate,
                       boolean debug,
                       boolean timingDebug)

Class constructor

Parameters:

mapName - String

key - String

lockState - boolean

noUpdate - boolean

debug - boolean

timingDebug - boolean

Method Detail

getHazelcastInstance

public com.hazelcast.core.HazelcastInstance getHazelcastInstance()

Get the Hazelcast instance

Returns:

HazelcastInstance

setHazelcastInstance

public void setHazelcastInstance(com.hazelcast.core.HazelcastInstance hcInstance)

Set the Hazelcast instance

Specified by:

setHazelcastInstance in interface com.hazelcast.core.HazelcastInstanceAware

Parameters:

hcInstance - HazelcastInstance

getMapName

public final String getMapName()

Return the clustered map name

Returns:

String

getKey

public final String getKey()

Return the file state key

Returns:

String

hasOption

public final boolean hasOption(int option)

Check if the specifed task option is enabled

Parameters:

option - int

Returns:

boolean

hasDebug

public final boolean hasDebug()

Check if debug output is enabled for this remote task

Returns:

boolean

hasTimingDebug

public final boolean hasTimingDebug()

Check if the timing debug output is enabled for this remote task

Returns:

boolean

getTaskName

public final String getTaskName()

Get the task name

Returns:

String

call

public T call()
       throws Exception

Run the remote task

Specified by:

call in interface Callable<T>

Throws:

Exception

runRemoteTaskAgainstState

protected abstract T runRemoteTaskAgainstState(com.hazelcast.core.IMap<String,ClusterFileState> stateCache,
                                               ClusterFileState fState)
                                        throws Exception

Run a remote task against a file state

Parameters:

stateCache - IMap

fState - ClusterFileState

Returns:

T

Throws:

Exception