Module dk.cloudcreate.essentials.components.foundation

Package dk.cloudcreate.essentials.components.foundation.fencedlock

Class DBFencedLock

java.lang.Object

dk.cloudcreate.essentials.components.foundation.fencedlock.DBFencedLock

All Implemented Interfaces:

FencedLock, AutoCloseable

public class DBFencedLock
extends Object
implements FencedLock

Constructor Summary

Constructors

Constructor	Description
DBFencedLock(DBFencedLockManager<? extends UnitOfWork,DBFencedLock> fencedLockManager, LockName lockName, Long currentToken, String lockedByBusInstanceId, OffsetDateTime lockAcquiredTimestamp, OffsetDateTime lockLastConfirmedTimestamp)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Long	getCurrentToken()	The current token value as of the FencedLock.getLockLastConfirmedTimestamp() for this Lock across all FencedLockManager instances Every time a lock is acquired or confirmed a new token is issued (i.e.
Duration	getDurationSinceLastConfirmation()
OffsetDateTime	getLockAcquiredTimestamp()	At what time did the JVM/FencedLockManager.getLockManagerInstanceId() that currently has acquired the lock acquire it (at first acquiring the FencedLock.getLockLastConfirmedTimestamp() is set to FencedLock.getLockAcquiredTimestamp())
String	getLockedByLockManagerInstanceId()	Which JVM/FencedLockManager.getLockManagerInstanceId() that has acquired this lock
OffsetDateTime	getLockLastConfirmedTimestamp()	At what time did the JVM/FencedLockManager.getLockManagerInstanceId(), that currently has acquired the lock, last confirm that it still has access to the lock
LockName	getName()	The name of the Lock
int	hashCode()
boolean	isLocked()	Is this lock locked?
boolean	isLockedByThisLockManagerInstance()	Is this Lock locked by this JVM node
DBFencedLock	markAsLocked(OffsetDateTime lockTime, String lockedByLockManagerInstanceId, long currentToken)
void	markAsReleased()
void	registerCallback(LockCallback lockCallback)
void	release()	Release/Unlock the lock.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface dk.cloudcreate.essentials.components.foundation.fencedlock.FencedLock

close

Constructor Detail

DBFencedLock

public DBFencedLock(DBFencedLockManager<? extends UnitOfWork,DBFencedLock> fencedLockManager,
                    LockName lockName,
                    Long currentToken,
                    String lockedByBusInstanceId,
                    OffsetDateTime lockAcquiredTimestamp,
                    OffsetDateTime lockLastConfirmedTimestamp)

Method Detail

getName

public LockName getName()

Description copied from interface: FencedLock

The name of the Lock

Specified by:

getName in interface FencedLock

Returns:

the lock name

getCurrentToken

public Long getCurrentToken()

Description copied from interface: FencedLock

The current token value as of the FencedLock.getLockLastConfirmedTimestamp() for this Lock across all FencedLockManager instances
Every time a lock is acquired or confirmed a new token is issued (i.e. it's ever-growing value)

Specified by:

getCurrentToken in interface FencedLock

getLockedByLockManagerInstanceId

public String getLockedByLockManagerInstanceId()

Description copied from interface: FencedLock

Which JVM/FencedLockManager.getLockManagerInstanceId() that has acquired this lock

Specified by:

getLockedByLockManagerInstanceId in interface FencedLock

getLockAcquiredTimestamp

public OffsetDateTime getLockAcquiredTimestamp()

Description copied from interface: FencedLock

At what time did the JVM/FencedLockManager.getLockManagerInstanceId() that currently has acquired the lock acquire it (at first acquiring the FencedLock.getLockLastConfirmedTimestamp() is set to FencedLock.getLockAcquiredTimestamp())

Specified by:

getLockAcquiredTimestamp in interface FencedLock

getLockLastConfirmedTimestamp

public OffsetDateTime getLockLastConfirmedTimestamp()

Description copied from interface: FencedLock

At what time did the JVM/FencedLockManager.getLockManagerInstanceId(), that currently has acquired the lock, last confirm that it still has access to the lock

Specified by:

getLockLastConfirmedTimestamp in interface FencedLock

isLocked

public boolean isLocked()

Description copied from interface: FencedLock

Is this lock locked?

Specified by:

isLocked in interface FencedLock

isLockedByThisLockManagerInstance

public boolean isLockedByThisLockManagerInstance()

Description copied from interface: FencedLock

Is this Lock locked by this JVM node

Specified by:

isLockedByThisLockManagerInstance in interface FencedLock

release

public void release()

Description copied from interface: FencedLock

Release/Unlock the lock. Only works if FencedLock.isLockedByThisLockManagerInstance() is true

Specified by:

release in interface FencedLock

registerCallback

public void registerCallback(LockCallback lockCallback)

Specified by:

registerCallback in interface FencedLock

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDurationSinceLastConfirmation

public Duration getDurationSinceLastConfirmation()

markAsReleased

public void markAsReleased()

markAsLocked

public DBFencedLock markAsLocked(OffsetDateTime lockTime,
                                 String lockedByLockManagerInstanceId,
                                 long currentToken)

toString

public String toString()

Overrides:

toString in class Object