Class MutexConstants

java.lang.Object

org.tasktide.mutex.utils.MutexConstants

public class MutexConstants
extends Object

Holds constants for building Mutex

Constructor Summary

Constructors

Constructor	Description
MutexConstants()

Method Summary

Modifier and Type	Method	Description
static boolean	durationsConfigured()	Checks whether durations have been configured
static Path	getElectionDir()	Get election directory under locking directory
static Path	getElectionFile()	Get current Time-Node-Instance.lock file beside lock file
static Duration	getEndJitter()	Get end jitter
static Path	getHostDir()	Get host directory under locking directory
static Path	getHostFile()	Get current Time.Node_Instance.lock file
static Path	getLockDir()	Get directory holding lock file
static Path	getLockFile()	Get central lock file
static Duration	getRandomJitter()	Get a random millisecond duration to to stagger process calls
static Duration	getRetryInterval()	Get retry interval
static Duration	getStaleFileThreshold()	Get stale file threshold
static Duration	getStartJitter()	Get start jitter
static void	initializeDurations()	Initialize duration properties with hard coded defaults
static void	initializeDurations(long retry, long start, long end, long stale)	Initialize duration properties with provided values
static void	initializePaths()	Initialize paths for MutexActor
static void	initializePaths(Path lockingDir, Path lockingFile, Path electDir, Path electFile, Path hostingDir)	Initialize paths for MutexActor
static boolean	isConfigured()	Checks whether duration and path properties have been configured
static boolean	pathsConfigured()	Returns whether paths have been configured
static void	waitOverJitter()	Wait over jitter period

Methods inherited from class Object

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

Constructor Details

MutexConstants

public MutexConstants()

Method Details

initializeDurations

public static void initializeDurations()

Initialize duration properties with hard coded defaults

initializeDurations

public static void initializeDurations(long retry,
 long start,
 long end,
 long stale)

Initialize duration properties with provided values

Parameters:

retry -

start -

end -

stale -

getRetryInterval

public static Duration getRetryInterval()

Get retry interval

Returns:

Duration

getStartJitter

public static Duration getStartJitter()

Get start jitter

Returns:

Duration

getEndJitter

public static Duration getEndJitter()

Get end jitter

Returns:

Duration

getStaleFileThreshold

public static Duration getStaleFileThreshold()

Get stale file threshold

Returns:

Duration

getRandomJitter

public static Duration getRandomJitter()

Get a random millisecond duration to to stagger process calls

Returns:

Duration

initializePaths

public static void initializePaths()

Initialize paths for MutexActor

initializePaths

public static void initializePaths(Path lockingDir,
 Path lockingFile,
 Path electDir,
 Path electFile,
 Path hostingDir)

Initialize paths for MutexActor

Parameters:

lockingDir -

lockingFile -

electDir -

electFile -

hostingDir -

getLockDir

public static Path getLockDir()

Get directory holding lock file

Returns:

Path

getLockFile

public static Path getLockFile()

Get central lock file

Returns:

Path

getHostDir

public static Path getHostDir()

Get host directory under locking directory

Returns:

Path

getElectionDir

public static Path getElectionDir()

Get election directory under locking directory

Returns:

Path

getElectionFile

public static Path getElectionFile()

Get current Time-Node-Instance.lock file beside lock file

Returns:

Path

getHostFile

public static Path getHostFile()

Get current Time.Node_Instance.lock file

Returns:

Path

isConfigured

public static boolean isConfigured()

Checks whether duration and path properties have been configured

Returns:

boolean

pathsConfigured

public static boolean pathsConfigured()

Returns whether paths have been configured

Returns:

boolean

durationsConfigured

public static boolean durationsConfigured()

Checks whether durations have been configured

Returns:

boolean

waitOverJitter

public static void waitOverJitter()

Wait over jitter period