com.atlassian.confluence.core

Class DefaultHeartbeatManager

java.lang.Object

com.atlassian.confluence.core.DefaultHeartbeatManager

All Implemented Interfaces:

HeartbeatManager

public class DefaultHeartbeatManager
extends Object
implements HeartbeatManager

Field Summary

Fields

Modifier and Type	Field and Description
static long	TIMEOUT_MS

Constructor Summary

Constructors

Constructor and Description
DefaultHeartbeatManager(com.atlassian.beehive.ClusterLockService clusterLockService, com.atlassian.vcache.VCacheFactory cacheFactory)

Method Summary

Modifier and Type	Method and Description
long	getHeartbeatInterval() Fetches the time at which activities will expire
List<com.atlassian.user.User>	getUsersForActivity(Object activityKey) Deprecated. since 5.10. This method is not cluster-safe and should no longer be used. Use getUsersForActivity(String) instead.
List<com.atlassian.user.User>	getUsersForActivity(String activityKey) Fetches a list of users who are participating in a specified activity
void	startActivity(Object activityKey, com.atlassian.user.User user) Deprecated. since 5.10. This method is not cluster-safe and should no longer be used. Use startActivity(String, User) instead
void	startActivity(String activityKey, com.atlassian.user.User user) Adds a user as an active participant to the specified activity
void	stopActivity(Object activityKey, com.atlassian.user.User user) Deprecated. since 5.10. This method is not cluster-safe and should no longer be used. Use stopActivity(String, User) instead
void	stopActivity(String activityKey, com.atlassian.user.User user) Remove a user from the active participants from the specified activity

Methods inherited from class java.lang.Object

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

Field Detail

TIMEOUT_MS

public static final long TIMEOUT_MS

See Also:

Constant Field Values

Constructor Detail

DefaultHeartbeatManager

public DefaultHeartbeatManager(com.atlassian.beehive.ClusterLockService clusterLockService,
                               com.atlassian.vcache.VCacheFactory cacheFactory)

Since:

5.10

Method Detail

getHeartbeatInterval

public long getHeartbeatInterval()

Description copied from interface: HeartbeatManager

Fetches the time at which activities will expire

Specified by:

getHeartbeatInterval in interface HeartbeatManager

Returns:

The activity timeout in milliseconds

getUsersForActivity

@Deprecated
public List<com.atlassian.user.User> getUsersForActivity(Object activityKey)

Deprecated. since 5.10. This method is not cluster-safe and should no longer be used. Use getUsersForActivity(String) instead.

Specified by:

getUsersForActivity in interface HeartbeatManager

getUsersForActivity

public List<com.atlassian.user.User> getUsersForActivity(String activityKey)

Description copied from interface: HeartbeatManager

Fetches a list of users who are participating in a specified activity

Specified by:

getUsersForActivity in interface HeartbeatManager

Parameters:

activityKey - The key used to identify the activity

Returns:

A list of users who are actively engaging in the specified activity

startActivity

@Deprecated
public void startActivity(Object activityKey,
                                      com.atlassian.user.User user)

Deprecated. since 5.10. This method is not cluster-safe and should no longer be used. Use startActivity(String, User) instead

Specified by:

startActivity in interface HeartbeatManager

startActivity

public void startActivity(String activityKey,
                          com.atlassian.user.User user)

Description copied from interface: HeartbeatManager

Adds a user as an active participant to the specified activity

Specified by:

startActivity in interface HeartbeatManager

Parameters:

activityKey - The key used to identify the activity

user - The user who is participating in the activity

stopActivity

@Deprecated
public void stopActivity(Object activityKey,
                                     com.atlassian.user.User user)

Deprecated. since 5.10. This method is not cluster-safe and should no longer be used. Use stopActivity(String, User) instead

Specified by:

stopActivity in interface HeartbeatManager

stopActivity

public void stopActivity(String activityKey,
                         com.atlassian.user.User user)

Description copied from interface: HeartbeatManager

Remove a user from the active participants from the specified activity

Specified by:

stopActivity in interface HeartbeatManager

Parameters:

activityKey - The key used to identify the activity

user - The user who is participating in the activity