Interface MutexActor

All Known Implementing Classes:

FileChannelActor, InterProcessMutexActor, IntraProcessActor, NfsMutexActor

public interface MutexActor

Defines the package private semantics for electing leader mutex

Method Summary

Modifier and Type	Method	Description
boolean	acquire(Path targetFile)	Acquire a lock on target file
boolean	acquire(Mutex mutex)	Acquire lock on Mutex
Mutex	fetchActiveFieldValue()	Fetch active Mutex field value
MutexState	getState()	Return MutexState
MutexStrategy	getStrategy()	Fetch the composed MutexStrategy
boolean	release()	Release active lock
boolean	release(Path targetFile)	Release lock
boolean	release(Mutex mutex)	Release lock
void	setState(MutexState newState)	Set new state
void	waitForLock(Mutex mutex)

Method Details

getStrategy

MutexStrategy getStrategy()

Fetch the composed MutexStrategy

Returns:

MutexStrategy

fetchActiveFieldValue

Mutex fetchActiveFieldValue()

Fetch active Mutex field value

Returns:

Mutex

acquire

boolean acquire(Mutex mutex)
         throws MutexCheckedException

Acquire lock on Mutex

Parameters:

mutex -

Returns:

boolean

Throws:

MutexCheckedException

acquire

boolean acquire(Path targetFile)
         throws MutexCheckedException

Acquire a lock on target file

Parameters:

targetFile -

Returns:

boolean

Throws:

MutexCheckedException

waitForLock

void waitForLock(Mutex mutex)
          throws MutexCheckedException

Parameters:

mutex -

Throws:

MutexCheckedException

release

boolean release(Mutex mutex)
         throws MutexCheckedException

Release lock

Parameters:

mutex -

Returns:

boolean

Throws:

MutexCheckedException

release

boolean release(Path targetFile)
         throws MutexCheckedException

Release lock

Parameters:

targetFile -

Returns:

boolean

Throws:

MutexCheckedException

release

boolean release()
         throws MutexCheckedException

Release active lock

Returns:

boolean

Throws:

MutexCheckedException

getState

MutexState getState()

Return MutexState

Returns:

MutexState

setState

void setState(MutexState newState)

Set new state

Parameters:

newState -