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

Constructor Summary

Constructors

Constructor and Description
DefaultHeartbeatManager(com.atlassian.vcache.VCacheFactory cacheFactory, UserAccessor userAccessor)

Method Summary

Modifier and Type	Method and Description
long	getHeartbeatInterval() Fetches the time at which activities will expire
List<com.atlassian.user.User>	getUsersForActivity(String activityKey) Fetches a list of users who are participating in a specified activity
void	startActivity(String activityKey, String username) Adds a username as an active participant to the specified activity
void	startActivity(String activityKey, com.atlassian.user.User user) Adds a username as an active participant to the specified activity
void	stopActivity(String activityKey, String username) Remove a username from the active participants from the specified activity
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

Constructor Detail

DefaultHeartbeatManager

public DefaultHeartbeatManager(com.atlassian.vcache.VCacheFactory cacheFactory,
                               UserAccessor userAccessor)

Since:

6.3.0

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

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

public void startActivity(String activityKey,
                          String username)

Description copied from interface: HeartbeatManager

Adds a username as an active participant to the specified activity

Specified by:

startActivity in interface HeartbeatManager

Parameters:

activityKey - The key used to identify the activity

username - The username of the user who is participating in the activity

startActivity

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

Description copied from interface: HeartbeatManager

Adds a username 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

public void stopActivity(String activityKey,
                         String username)

Description copied from interface: HeartbeatManager

Remove a username from the active participants from the specified activity

Specified by:

stopActivity in interface HeartbeatManager

Parameters:

activityKey - The key used to identify the activity

username - The username of the user who is participating in the activity

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