com.atlassian.confluence.util

Class HeartBeatUtil

java.lang.Object

com.atlassian.confluence.util.HeartBeatUtil

public class HeartBeatUtil
extends Object

Use this within a try() construct. E.g.: try(HeartBeat ignored = HeartBeatUtil.scheduleConditionally(..)) { ... } This will ensure that the heartbeat is terminated correctly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HeartBeatUtil.HeartBeat Represents a heartbeat that will terminate when HeartBeatUtil.HeartBeat.close() is called.

Constructor Summary

Constructors

Constructor and Description
HeartBeatUtil()

Method Summary

Modifier and Type	Method and Description
static HeartBeatUtil.HeartBeat	scheduleConditionally(String taskId, com.atlassian.progress.ProgressUpdater progressUpdater, com.atlassian.progress.ProgressAwareTaskService progressAwareTaskService, FeatureFlagServiceClient featureFlagServiceClient, FeatureFlag featureFlag, boolean enabledByDefault) Schedules a "HeartBeat" which will make sure the task with id provided keeps it's own ProgressUpdater fresh.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeartBeatUtil

public HeartBeatUtil()

Method Detail

scheduleConditionally

public static HeartBeatUtil.HeartBeat scheduleConditionally(String taskId,
                                                            com.atlassian.progress.ProgressUpdater progressUpdater,
                                                            com.atlassian.progress.ProgressAwareTaskService progressAwareTaskService,
                                                            FeatureFlagServiceClient featureFlagServiceClient,
                                                            FeatureFlag featureFlag,
                                                            boolean enabledByDefault)

Schedules a "HeartBeat" which will make sure the task with id provided keeps it's own ProgressUpdater fresh. This is needed because otherwise AMQ will kill of the non-updating task after 5 minutes of inactivity.

Scheduling a heartbeat is subject to a FeatureFlag evaluation. Make sure to turn the FeatureFlag "ON" in order to have the heartbeat scheduled.

Parameters:

taskId - - id of a task to schedule a heartbeat for

progressUpdater - - updater of the task which should be posted from time to time

Returns:

Optional of ScheduledFuture which should be used to cancell this heartbeat

See Also:

FD-223, FF page