net.javacrumbs.shedlock.provider.hazelcast

Class HazelcastLockProvider

java.lang.Object

net.javacrumbs.shedlock.provider.hazelcast.HazelcastLockProvider

All Implemented Interfaces:

LockProvider

public class HazelcastLockProvider
extends java.lang.Object
implements LockProvider

HazelcastLockProvider.

Implementation of LockProvider using Hazelcast for store and share locks informations and mechanisms between a cluster members

Below, the mechanims : - The Lock, an instance of HazelcastLock, is obtained / created when : -- the lock is not not already locked by other process (lock - referenced by its name - is not present in the Hazelcast locks store OR unlockable) -- the lock is expired : Instant.now() > HazelcastLock.timeToLive where unlockTime have by default the same value of HazelcastLock.lockAtMostUntil and can have the value of HazelcastLock.lockAtLeastUntil if unlock action is used --- expired object is removed -- the lock is owned by not available member of Hazelcast cluster member --- no owner objectis removed - Unlock action : -- removes lock object when HazelcastLock.lockAtLeastUntil is not come -- override value of HazelcastLock.timeToLive with HazelcastLock.lockAtLeastUntil (its default value is the same of HazelcastLock.lockAtLeastUntil

Constructor Summary

Constructors

Constructor and Description
HazelcastLockProvider(com.hazelcast.core.HazelcastInstance hazelcastInstance) Instantiate the provider.
HazelcastLockProvider(com.hazelcast.core.HazelcastInstance hazelcastInstance, java.lang.String lockStoreKey) Instantiate the provider.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<SimpleLock>	lock(LockConfiguration lockConfiguration)

Methods inherited from class java.lang.Object

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

Constructor Detail

HazelcastLockProvider

public HazelcastLockProvider(com.hazelcast.core.HazelcastInstance hazelcastInstance)

Instantiate the provider.

Parameters:

hazelcastInstance - The Hazelcast engine used by the application.

HazelcastLockProvider

public HazelcastLockProvider(com.hazelcast.core.HazelcastInstance hazelcastInstance,
                             java.lang.String lockStoreKey)

Instantiate the provider.

Parameters:

hazelcastInstance - The Hazelcast engine used by the application

lockStoreKey - The key where the locks store is associate hazelcastInstance (by default LOCK_STORE_KEY_DEFAULT).

Method Detail

lock

public java.util.Optional<SimpleLock> lock(LockConfiguration lockConfiguration)

Specified by:

lock in interface LockProvider