Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AbstractSimpleLock - Class in net.javacrumbs.shedlock.core
- AbstractSimpleLock(LockConfiguration) - Constructor for class net.javacrumbs.shedlock.core.AbstractSimpleLock
- AbstractStorageAccessor - Class in net.javacrumbs.shedlock.support
- AbstractStorageAccessor() - Constructor for class net.javacrumbs.shedlock.support.AbstractStorageAccessor
- assertLocked() - Static method in class net.javacrumbs.shedlock.core.LockAssert
-
Throws an exception if the lock is not present.
C
- call() - Method in interface net.javacrumbs.shedlock.core.LockingTaskExecutor.Task
- call() - Method in interface net.javacrumbs.shedlock.core.LockingTaskExecutor.TaskWithResult
- clearCache() - Method in class net.javacrumbs.shedlock.support.StorageBasedLockProvider
-
Clears cache of existing lock records.
- ClockProvider - Class in net.javacrumbs.shedlock.core
-
Enables to change Clock for all ShedLock classes
- ClockProvider() - Constructor for class net.javacrumbs.shedlock.core.ClockProvider
D
- DefaultLockingTaskExecutor - Class in net.javacrumbs.shedlock.core
-
Default
LockingTaskExecutor
implementation. - DefaultLockingTaskExecutor(LockProvider) - Constructor for class net.javacrumbs.shedlock.core.DefaultLockingTaskExecutor
- DefaultLockManager - Class in net.javacrumbs.shedlock.core
-
Default implementation
LockManager
implementation. - DefaultLockManager(LockingTaskExecutor, LockConfigurationExtractor) - Constructor for class net.javacrumbs.shedlock.core.DefaultLockManager
- DefaultLockManager(LockProvider, LockConfigurationExtractor) - Constructor for class net.javacrumbs.shedlock.core.DefaultLockManager
- doExtend(LockConfiguration) - Method in class net.javacrumbs.shedlock.core.AbstractSimpleLock
- doLock(LockConfiguration) - Method in class net.javacrumbs.shedlock.support.StorageBasedLockProvider
-
Sets lockUntil according to LockConfiguration if current lockUntil <= now
- doUnlock() - Method in class net.javacrumbs.shedlock.core.AbstractSimpleLock
E
- executeWithLock(Runnable) - Method in class net.javacrumbs.shedlock.core.DefaultLockManager
- executeWithLock(Runnable) - Method in interface net.javacrumbs.shedlock.core.LockManager
- executeWithLock(Runnable, LockConfiguration) - Method in class net.javacrumbs.shedlock.core.DefaultLockingTaskExecutor
- executeWithLock(Runnable, LockConfiguration) - Method in interface net.javacrumbs.shedlock.core.LockingTaskExecutor
-
Executes task if it's not already running.
- executeWithLock(LockingTaskExecutor.Task, LockConfiguration) - Method in class net.javacrumbs.shedlock.core.DefaultLockingTaskExecutor
- executeWithLock(LockingTaskExecutor.Task, LockConfiguration) - Method in interface net.javacrumbs.shedlock.core.LockingTaskExecutor
- executeWithLock(LockingTaskExecutor.TaskWithResult<T>, LockConfiguration) - Method in class net.javacrumbs.shedlock.core.DefaultLockingTaskExecutor
- executeWithLock(LockingTaskExecutor.TaskWithResult<T>, LockConfiguration) - Method in interface net.javacrumbs.shedlock.core.LockingTaskExecutor
-
Executes task.
- extend(Duration, Duration) - Method in class net.javacrumbs.shedlock.core.AbstractSimpleLock
- extend(Duration, Duration) - Method in interface net.javacrumbs.shedlock.core.SimpleLock
-
Extends the lock.
- extend(Instant, Instant) - Method in class net.javacrumbs.shedlock.core.AbstractSimpleLock
-
Deprecated.
- extend(Instant, Instant) - Method in interface net.javacrumbs.shedlock.core.SimpleLock
-
Deprecated.
- extend(LockConfiguration) - Method in interface net.javacrumbs.shedlock.support.StorageAccessor
- extendActiveLock(Duration, Duration) - Static method in class net.javacrumbs.shedlock.core.LockExtender
-
Extends active lock.
- ExtensibleLockProvider - Interface in net.javacrumbs.shedlock.core
-
Marker interface for a LockProvider that supports lock extension.
G
- getHostname() - Method in class net.javacrumbs.shedlock.support.AbstractStorageAccessor
- getHostname() - Static method in class net.javacrumbs.shedlock.support.Utils
- getLockAtLeastFor() - Method in class net.javacrumbs.shedlock.core.LockConfiguration
- getLockAtLeastUntil() - Method in class net.javacrumbs.shedlock.core.LockConfiguration
- getLockAtMostFor() - Method in class net.javacrumbs.shedlock.core.LockConfiguration
- getLockAtMostUntil() - Method in class net.javacrumbs.shedlock.core.LockConfiguration
- getLockConfiguration(Runnable) - Method in interface net.javacrumbs.shedlock.core.LockConfigurationExtractor
- getName() - Method in class net.javacrumbs.shedlock.core.LockConfiguration
- getResult() - Method in class net.javacrumbs.shedlock.core.LockingTaskExecutor.TaskResult
- getUnlockTime() - Method in class net.javacrumbs.shedlock.core.LockConfiguration
-
Returns either now or lockAtLeastUntil whichever is later.
I
- insertRecord(LockConfiguration) - Method in interface net.javacrumbs.shedlock.support.StorageAccessor
-
Inserts a record, if it does not already exists.
K
- KeepAliveLockProvider - Class in net.javacrumbs.shedlock.support
-
LockProvider that keeps the lock `alive`.
- KeepAliveLockProvider(ExtensibleLockProvider, ScheduledExecutorService) - Constructor for class net.javacrumbs.shedlock.support.KeepAliveLockProvider
L
- lock(LockConfiguration) - Method in interface net.javacrumbs.shedlock.core.LockProvider
- lock(LockConfiguration) - Method in class net.javacrumbs.shedlock.support.KeepAliveLockProvider
- lock(LockConfiguration) - Method in class net.javacrumbs.shedlock.support.StorageBasedLockProvider
- LockableRunnable - Class in net.javacrumbs.shedlock.core
-
Executes wrapped runnable using
LockManager.executeWithLock(Runnable)
- LockableRunnable(Runnable, LockManager) - Constructor for class net.javacrumbs.shedlock.core.LockableRunnable
- LockAssert - Class in net.javacrumbs.shedlock.core
-
Asserts lock presence.
- LockAssert.TestHelper - Class in net.javacrumbs.shedlock.core
- lockAtLeastFor() - Element in annotation type net.javacrumbs.shedlock.core.SchedulerLock
-
Deprecated.The lock will be held at least for X millis.
- lockAtLeastForString() - Element in annotation type net.javacrumbs.shedlock.core.SchedulerLock
-
Deprecated.Lock at least for as string.
- lockAtMostFor() - Element in annotation type net.javacrumbs.shedlock.core.SchedulerLock
-
Deprecated.How long (in ms) the lock should be kept in case the machine which obtained the lock died before releasing it.
- lockAtMostForString() - Element in annotation type net.javacrumbs.shedlock.core.SchedulerLock
-
Deprecated.Lock at most for as string.
- LockCanNotBeExtendedException() - Constructor for exception net.javacrumbs.shedlock.core.LockExtender.LockCanNotBeExtendedException
- lockConfiguration - Variable in class net.javacrumbs.shedlock.core.AbstractSimpleLock
- LockConfiguration - Class in net.javacrumbs.shedlock.core
-
Lock configuration.
- LockConfiguration(String, Duration, Duration) - Constructor for class net.javacrumbs.shedlock.core.LockConfiguration
-
Deprecated.
- LockConfiguration(String, Instant) - Constructor for class net.javacrumbs.shedlock.core.LockConfiguration
-
Deprecated.
- LockConfiguration(String, Instant, Instant) - Constructor for class net.javacrumbs.shedlock.core.LockConfiguration
-
Deprecated.
- LockConfiguration(Instant, String, Duration, Duration) - Constructor for class net.javacrumbs.shedlock.core.LockConfiguration
-
Creates LockConfiguration.
- LockConfigurationExtractor - Interface in net.javacrumbs.shedlock.core
-
Extracts lock parameters from the task.
- LockException - Exception in net.javacrumbs.shedlock.support
- LockException(String) - Constructor for exception net.javacrumbs.shedlock.support.LockException
- LockException(String, Throwable) - Constructor for exception net.javacrumbs.shedlock.support.LockException
- LockExtender - Class in net.javacrumbs.shedlock.core
- LockExtender.LockCanNotBeExtendedException - Exception in net.javacrumbs.shedlock.core
- LockExtender.LockExtensionException - Exception in net.javacrumbs.shedlock.core
- LockExtender.NoActiveLockException - Exception in net.javacrumbs.shedlock.core
- LockExtensionException(String) - Constructor for exception net.javacrumbs.shedlock.core.LockExtender.LockExtensionException
- LockingTaskExecutor - Interface in net.javacrumbs.shedlock.core
- LockingTaskExecutor.Task - Interface in net.javacrumbs.shedlock.core
- LockingTaskExecutor.TaskResult<T> - Class in net.javacrumbs.shedlock.core
- LockingTaskExecutor.TaskWithResult<T> - Interface in net.javacrumbs.shedlock.core
- LockManager - Interface in net.javacrumbs.shedlock.core
-
Executes task if not locked.
- LockProvider - Interface in net.javacrumbs.shedlock.core
-
Provides lock implementation.
- logger - Variable in class net.javacrumbs.shedlock.support.AbstractStorageAccessor
M
- makeAllAssertsPass(boolean) - Static method in class net.javacrumbs.shedlock.core.LockAssert.TestHelper
-
If pass is set to true, all LockAssert.assertLocked calls in current thread will pass.
N
- name() - Element in annotation type net.javacrumbs.shedlock.core.SchedulerLock
-
Deprecated.Lock name.
- net.javacrumbs.shedlock.core - package net.javacrumbs.shedlock.core
- net.javacrumbs.shedlock.support - package net.javacrumbs.shedlock.support
- net.javacrumbs.shedlock.support.annotation - package net.javacrumbs.shedlock.support.annotation
- NoActiveLockException() - Constructor for exception net.javacrumbs.shedlock.core.LockExtender.NoActiveLockException
- NonNull - Annotation Type in net.javacrumbs.shedlock.support.annotation
-
A common Spring annotation to declare that annotated elements cannot be
null
. - now() - Static method in class net.javacrumbs.shedlock.core.ClockProvider
- Nullable - Annotation Type in net.javacrumbs.shedlock.support.annotation
-
A common annotation to declare that annotated elements can be
null
under some circumstance.
R
- run() - Method in class net.javacrumbs.shedlock.core.LockableRunnable
S
- SchedulerLock - Annotation Type in net.javacrumbs.shedlock.core
-
Deprecated.This annotation has been replaced by 'net.javacrumbs.shedlock.spring.annotation.SchedulerLock' I am really sorry to do such a step, but this annotation is in wrong module and stands in way of non-spring integrations. This class will not be removed before 2022.
- setClock(Clock) - Static method in class net.javacrumbs.shedlock.core.ClockProvider
- SimpleLock - Interface in net.javacrumbs.shedlock.core
- StorageAccessor - Interface in net.javacrumbs.shedlock.support
- StorageBasedLockProvider - Class in net.javacrumbs.shedlock.support
-
Distributed lock using abstract storage
- StorageBasedLockProvider(StorageAccessor) - Constructor for class net.javacrumbs.shedlock.support.StorageBasedLockProvider
T
- TestHelper() - Constructor for class net.javacrumbs.shedlock.core.LockAssert.TestHelper
- toIsoString(Instant) - Static method in class net.javacrumbs.shedlock.support.Utils
- toString() - Method in class net.javacrumbs.shedlock.core.LockConfiguration
U
- unlock() - Method in class net.javacrumbs.shedlock.core.AbstractSimpleLock
- unlock() - Method in interface net.javacrumbs.shedlock.core.SimpleLock
-
Unlocks the lock.
- unlock(LockConfiguration) - Method in interface net.javacrumbs.shedlock.support.StorageAccessor
- updateRecord(LockConfiguration) - Method in interface net.javacrumbs.shedlock.support.StorageAccessor
-
Tries to update the lock record.
- Utils - Class in net.javacrumbs.shedlock.support
W
- wasExecuted() - Method in class net.javacrumbs.shedlock.core.LockingTaskExecutor.TaskResult
All Classes and Interfaces|All Packages|Serialized Form
LockConfiguration(Instant, String, Duration, Duration)