Class MutexOrchestrator

java.lang.Object

org.tasktide.mutex.orchestrator.MutexOrchestrator

public class MutexOrchestrator
extends Object

Implementing MutexActor lock by composing the NfsMutexActor, and FileChannelActor which collectively offer a Mutex which can be acquired and released.
Currently the algorithm only runs as a waiter/holds the executing thread.

Constructor Summary

Constructors

Constructor	Description
MutexOrchestrator()

Method Summary

Modifier and Type	Method	Description
static OrchestratorResult	acquireLock()	Acquire central MutexActor through NfsMutexActor lock then requesting FileChannel lock
static void	cleanUp(Mutex mutex)	Clear files
static void	configure()	Configures MutexOrchestrator if not already
static void	configureForTestCases(MutexActor nfsMutex, MutexActor fileChannelMutex)	Configures MutexOrchestrator with provided MutexActor
static void	confirmLeader(Mutex mutex)	Confirm active leadership or dropout
static Mutex	fetchActive()	Fetch active Mutex
static boolean	isInitialized()	Returns whether MutexOrchestrator is configured
static void	releaseLock()	Releases FileChannelActor before the central MutexActor on NfsMutexActor using the MutexFilesUtils jitter time configured through MutexConstants
static void	tryAcquireUntilSuccess()	Try acquire lock until successful

Methods inherited from class Object

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

Constructor Details

MutexOrchestrator

public MutexOrchestrator()

Method Details

isInitialized

public static boolean isInitialized()

Returns whether MutexOrchestrator is configured

Returns:

boolean

configure

public static void configure()

Configures MutexOrchestrator if not already

configureForTestCases

public static void configureForTestCases(MutexActor nfsMutex,
 MutexActor fileChannelMutex)

Configures MutexOrchestrator with provided MutexActor

Parameters:

nfsMutex -

fileChannelMutex -

acquireLock

public static OrchestratorResult acquireLock()
                                      throws MutexCheckedException

Acquire central MutexActor through NfsMutexActor lock then requesting FileChannel lock

Returns:

OrchestratorResult

Throws:

MutexCheckedException

tryAcquireUntilSuccess

public static void tryAcquireUntilSuccess()
                                   throws Exception

Try acquire lock until successful

Throws:

Exception

releaseLock

public static void releaseLock()
                        throws MutexCheckedException

Releases FileChannelActor before the central MutexActor on NfsMutexActor using the MutexFilesUtils jitter time configured through MutexConstants

Throws:

MutexCheckedException

fetchActive

public static Mutex fetchActive()

Fetch active Mutex

Returns:

Mutex

confirmLeader

public static void confirmLeader(Mutex mutex)
                          throws MutexCheckedException

Confirm active leadership or dropout

Parameters:

mutex -

Throws:

MutexCheckedException

cleanUp

public static void cleanUp(Mutex mutex)

Clear files

Parameters:

mutex -