net.javacrumbs.shedlock.provider.redis.spring

Class RedisLockProvider

java.lang.Object

net.javacrumbs.shedlock.provider.redis.spring.RedisLockProvider

All Implemented Interfaces:

LockProvider

public class RedisLockProvider
extends Object
implements LockProvider

Uses Redis's `SET resource-name anystring NX PX max-lock-ms-time` as locking mechanism. See https://redis.io/commands/set

Constructor Summary

Constructors

Constructor and Description
RedisLockProvider(org.springframework.data.redis.connection.RedisConnectionFactory redisConn)
RedisLockProvider(org.springframework.data.redis.connection.RedisConnectionFactory redisConn, String environment) Creates RedisLockProvider

Method Summary

Modifier and Type	Method and Description
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

RedisLockProvider

public RedisLockProvider(org.springframework.data.redis.connection.RedisConnectionFactory redisConn)

RedisLockProvider

public RedisLockProvider(org.springframework.data.redis.connection.RedisConnectionFactory redisConn,
                         String environment)

Creates RedisLockProvider

Parameters:

redisConn - RedisConnectionFactory

environment - environment is part of the key and thus makes sure there is not key conflict between multiple ShedLock instances running on the same Redis

Method Detail

lock

public Optional<SimpleLock> lock(LockConfiguration lockConfiguration)

Specified by:

lock in interface LockProvider