net.javacrumbs.shedlock.core

Annotation Type SchedulerLock

@Target(value={METHOD,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
public @interface SchedulerLock

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
long	lockAtLeastFor The lock will be held at least for X millis.
String	lockAtLeastForString Lock at least for as string.
long	lockAtMostFor How long (in ms) the lock should be kept in case the machine which obtained the lock died before releasing it.
String	lockAtMostForString Lock at most for as string.
String	name Lock name.

Element Detail

name

public abstract String name

Lock name.

Default:

""

lockAtMostFor

public abstract long lockAtMostFor

How long (in ms) the lock should be kept in case the machine which obtained the lock died before releasing it. This is just a fallback, under normal circumstances the lock is released as soon the tasks finishes. Negative value means default Ignored when using ZooKeeper and other lock providers which are able to detect dead node.

Default:

-1L

lockAtMostForString

public abstract String lockAtMostForString

Lock at most for as string. Can be either number in ms or formatted as described in Duration.parse(CharSequence)

Default:

""

lockAtLeastFor

public abstract long lockAtLeastFor

The lock will be held at least for X millis. Can be used if you really need to execute the task at most once in given period of time. If the duration of the task is shorter than clock difference between nodes, the task can be theoretically executed more than once (one node after another). By setting this parameter, you can make sure that the lock will be kept at least for given period of time.

Default:

-1L

lockAtLeastForString

public abstract String lockAtLeastForString

Lock at least for as string. Can be either number in ms or formatted as described in Duration.parse(CharSequence)

Default:

""