public class

DefaultWatcherManager

extends Object
implements WatcherManager
java.lang.Object
   ↳ com.atlassian.jira.issue.watchers.DefaultWatcherManager

Summary

Constants
String ASSOCIATION_TYPE
Public Constructors
DefaultWatcherManager(UserAssociationStore userAssociationStore, ApplicationProperties applicationProperties, IssueIndexManager indexManager, UserManager userManager, IssueFactory issueFactory, EventPublisher eventPublisher, IssueManager issueManager)
Public Methods
Collection<User> getCurrentWatchList(Issue issue, Locale userLocale)
Retrieve collection of users that are currently watching this issue (including the current user)
List<String> getCurrentWatcherUsernames(Issue issue)
Retrieve the list of usernames of users watching the given issue
List<String> getCurrentWatcherUsernames(GenericValue issue)
Retrieve the list of usernames of users watching the given issue
int getWatcherCount(Issue issue)
Returns the number of users watching this issue.
Collection<String> getWatcherUserKeys(Issue issue)
Retrieve list of users that are currently watching this issue (including the current user).
List<ApplicationUser> getWatchers(Issue issue, Locale userLocale)
Retrieve list of users that are currently watching this issue (including the current user).
boolean isWatching(ApplicationUser user, Issue issue)
Determine whether the current user is already watching the issue or not
boolean isWatching(User user, GenericValue issue)
Determine whether the current user is already watching the issue or not
boolean isWatching(User user, Issue issue)
Determine whether the current user is already watching the issue or not
boolean isWatchingEnabled()
void removeAllWatchesForUser(User user)
Remove all watches for a given user
void removeAllWatchesForUser(ApplicationUser user)
Remove all watches for a given user
void startWatching(User user, GenericValue issueGV)
Enable watching of a particular issue for the user supplied.
void startWatching(ApplicationUser user, Collection<Issue> issues)
Enable watching of a list of issues for the user supplied.
void startWatching(ApplicationUser user, Issue issue)
Enable watching of a particular issue for the user supplied.
void startWatching(User user, Issue issue)
Enable watching of a particular issue for the user supplied.
void stopWatching(ApplicationUser user, Collection<Issue> issues)
Disable watching of a list of issues for the user supplied.
void stopWatching(User user, GenericValue issueGV)
Disable watching of a particular issue for the user supplied.
void stopWatching(ApplicationUser user, Issue issue)
Disable watching of a particular issue for the user supplied.
void stopWatching(User user, Issue issue)
Disable watching of a particular issue for the user supplied.
void stopWatching(String username, GenericValue issueGV)
Disable watching of a particular issue for the user supplied.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.issue.watchers.WatcherManager

Constants

public static final String ASSOCIATION_TYPE

Constant Value: "WatchIssue"

Public Constructors

public DefaultWatcherManager (UserAssociationStore userAssociationStore, ApplicationProperties applicationProperties, IssueIndexManager indexManager, UserManager userManager, IssueFactory issueFactory, EventPublisher eventPublisher, IssueManager issueManager)

Public Methods

public Collection<User> getCurrentWatchList (Issue issue, Locale userLocale)

Retrieve collection of users that are currently watching this issue (including the current user)

Parameters
issue issue being watched
userLocale the locale of the user making this call, this is used for sorting the list values.
Returns
  • A collection of Users

public List<String> getCurrentWatcherUsernames (Issue issue)

Retrieve the list of usernames of users watching the given issue

Parameters
issue issue being watched
Returns
  • the list of usernames of users watching the given issue
Throws
DataAccessException

public List<String> getCurrentWatcherUsernames (GenericValue issue)

Retrieve the list of usernames of users watching the given issue

Parameters
issue issue being watched
Returns
  • the list of usernames of users watching the given issue
Throws
DataAccessException

public int getWatcherCount (Issue issue)

Returns the number of users watching this issue.

Parameters
issue issue being watched
Returns
  • the number of users watching this issue.

public Collection<String> getWatcherUserKeys (Issue issue)

Retrieve list of users that are currently watching this issue (including the current user).

Parameters
issue issue being watched
Returns
  • list of users that are currently watching this issue (including the current user)

public List<ApplicationUser> getWatchers (Issue issue, Locale userLocale)

Retrieve list of users that are currently watching this issue (including the current user).

Parameters
issue issue being watched
userLocale the locale of the user making this call, this is used for sorting the list values.
Returns
  • list of users that are currently watching this issue (including the current user)

public boolean isWatching (ApplicationUser user, Issue issue)

Determine whether the current user is already watching the issue or not

Parameters
user user
issue issue being watched
Returns
  • True if a user is watching the issue specified.

public boolean isWatching (User user, GenericValue issue)

Determine whether the current user is already watching the issue or not

Parameters
user user
issue issue being watched
Returns
  • True if a user is watching the issue specified.

public boolean isWatching (User user, Issue issue)

Determine whether the current user is already watching the issue or not

Parameters
user user
issue issue being watched
Returns
  • True if a user is watching the issue specified.

public boolean isWatchingEnabled ()

public void removeAllWatchesForUser (User user)

Remove all watches for a given user

Parameters
user The user that has most probably been deleted

public void removeAllWatchesForUser (ApplicationUser user)

Remove all watches for a given user

Parameters
user The user that has most probably been deleted

public void startWatching (User user, GenericValue issueGV)

Enable watching of a particular issue for the user supplied.

This means the user will receive updates for any modifications to the issue. Note, that this will not check if a user has the BROWSE_ISSUE permission. Notifications will however only be sent to users who have the appropriate permissions. Adding a permission check here would complicate updating permission schemes a lot, as it would have to update issue's watchers lists.

Parameters
user user that starts watching the given issue
issueGV issue being watched

public void startWatching (ApplicationUser user, Collection<Issue> issues)

Enable watching of a list of issues for the user supplied.

This means the user will receive updates for any modifications to the issues. Note, that this will not check if a user has the BROWSE_ISSUE permission. Notifications will however only be sent to users who have the appropriate permissions. Adding a permission check here would complicate updating permission schemes a lot, as it would have to update issues' watchers lists.

This bulk method is more performant than calling the single version multiple times, as it indexes the issues in bulk rather than one at a time.

Parameters
user user that starts watching the given issues
issues the list of issues to watch

public void startWatching (ApplicationUser user, Issue issue)

Enable watching of a particular issue for the user supplied.

This means the user will receive updates for any modifications to the issue. Note, that this will not check if a user has the BROWSE_ISSUE permission. Notifications will however only be sent to users who have the appropriate permissions. Adding a permission check here would complicate updating permission schemes a lot, as it would have to update issue's watchers lists.

Parameters
user user that starts watching the given issue
issue issue being watched

public void startWatching (User user, Issue issue)

Enable watching of a particular issue for the user supplied.

This means the user will receive updates for any modifications to the issue. Note, that this will not check if a user has the BROWSE_ISSUE permission. Notifications will however only be sent to users who have the appropriate permissions. Adding a permission check here would complicate updating permission schemes a lot, as it would have to update issue's watchers lists.

Parameters
user user that starts watching the given issue
issue issue being watched

public void stopWatching (ApplicationUser user, Collection<Issue> issues)

Disable watching of a list of issues for the user supplied.

This bulk method is more performant than calling the single version multiple times, as it indexes the issues in bulk rather than one at a time.

Parameters
user user that stops watching the given issues
issues list of issues being watched

public void stopWatching (User user, GenericValue issueGV)

Disable watching of a particular issue for the user supplied.

Parameters
user user that stops watching the given issue
issueGV issue being watched

public void stopWatching (ApplicationUser user, Issue issue)

Disable watching of a particular issue for the user supplied.

Parameters
user user that stops watching the given issue
issue issue being watched

public void stopWatching (User user, Issue issue)

Disable watching of a particular issue for the user supplied.

Parameters
user user that stops watching the given issue
issue issue being watched

public void stopWatching (String username, GenericValue issueGV)

Disable watching of a particular issue for the user supplied.

Note: Use this method in case when user no longer exists in JIRA, e.g. JIRA uses external user management and user was removed externally.

Parameters
username username of the user that stops watching the given issue
issueGV issue being watched