public class

AvatarServiceImpl

extends Object
implements AvatarService
java.lang.Object
   ↳ com.atlassian.jira.avatar.AvatarServiceImpl

Class Overview

Implementation of the AvatarService.

Summary

Public Constructors
AvatarServiceImpl(UserManager userManager, AvatarManager avatarManager, UserPropertyManager userPropertyManager, VelocityRequestContextFactory velocityRequestContextFactory, ApplicationProperties applicationProperties, GravatarSettings gravatarSettings)
Public Methods
boolean canSetCustomUserAvatar(User remoteUser, String username)
Returns a boolean indicating whether the calling user can edit the custom user avatar for the user with the given username.
boolean canSetCustomUserAvatar(ApplicationUser remoteUser, ApplicationUser user)
Returns a boolean indicating whether the calling user can edit the custom user avatar for the user with the given username.
Avatar getAvatar(ApplicationUser remoteUser, ApplicationUser avatarUser)
Returns the Avatar for the given user, if configured.
Avatar getAvatar(User remoteUser, String username)
Returns the Avatar for the given user, if configured.
URI getAvatarAbsoluteURL(User remoteUser, String username, Avatar.Size size)
This is the same as getAvatarURL(com.atlassian.crowd.embedded.api.User, String, com.atlassian.jira.avatar.Avatar.Size) but returns an absolute URL.
URI getAvatarAbsoluteURL(ApplicationUser remoteUser, ApplicationUser avatarUser, Avatar.Size size)
This is the same as getAvatarURL(com.atlassian.crowd.embedded.api.User, String, com.atlassian.jira.avatar.Avatar.Size) but returns an absolute URL.
Avatar getAvatarTagged(ApplicationUser remoteUser, ApplicationUser avatarUser)
URI getAvatarURL(ApplicationUser remoteUser, ApplicationUser avatarUser)
Returns the URL for the avatar of the user having the given username for displaying on a page that should be shown for the passed in remoteUser.
URI getAvatarURL(ApplicationUser remoteUser, ApplicationUser avatarUser, Avatar.Size size)
Returns the URL for the avatar of the user having the given username for displaying on a page that should be shown for the passed in remoteUser.
URI getAvatarURL(User remoteUser, String username, Avatar.Size size)
Returns the URL for the avatar of the user having the given username for displaying on a page that should be shown for the passed in remoteUser.
URI getAvatarURL(User remoteUser, String username)
Returns the URL for the avatar of the user having the given username for displaying on a page that should be shown for the passed in remoteUser.
URI getAvatarUrlNoPermCheck(String username, Avatar.Size size)
This is the same as getAvatarURL(com.atlassian.crowd.embedded.api.User, String, com.atlassian.jira.avatar.Avatar.Size) but does no permission checking.
URI getAvatarUrlNoPermCheck(ApplicationUser avatarUser, Avatar avatar, Avatar.Size size)
Builds a URI for a JIRA avatar with the requested size.
URI getAvatarUrlNoPermCheck(ApplicationUser avatarUser, Avatar.Size size)
This is the same as getAvatarURL(com.atlassian.crowd.embedded.api.User, String, com.atlassian.jira.avatar.Avatar.Size) but does no permission checking.
URI getProjectAvatarAbsoluteURL(Project project, Avatar.Size size)
Returns the URL for the avatar of the given project.
URI getProjectAvatarURL(Project project, Avatar.Size size)
Returns the URL for the avatar of the given project.
URI getProjectDefaultAvatarAbsoluteURL(Avatar.Size size)
Returns the URL for the default avatar of a project.
URI getProjectDefaultAvatarURL(Avatar.Size size)
Returns the URL for the default avatar of a project.
boolean hasCustomUserAvatar(User remoteUser, String username)
Returns true if the user has configured a custom avatar, false otherwise.
boolean hasCustomUserAvatar(ApplicationUser remoteUser, ApplicationUser user)
Returns true if the user has configured a custom avatar, false otherwise.
boolean isGravatarEnabled()
Returns true if Gravatar support is enabled.
boolean isUsingExternalAvatar(ApplicationUser remoteUser, ApplicationUser avatarUser)
Check whether a user currently has an external avatar (for example, a Gravatar).
void setCustomUserAvatar(User remoteUser, String username, Long avatarId)
Sets a custom avatar for a given user.
void setCustomUserAvatar(ApplicationUser remoteUser, ApplicationUser user, Long avatarId)
Sets a custom avatar for a given user.
Protected Methods
boolean canViewAvatar(ApplicationUser user, Avatar avatar)
Returns true if the passed in user has permission to view the passed in avatar.
Long configuredAvatarIdFor(ApplicationUser user)
Returns the avatar id that is configured for the given User.
static ApplicationUser fromStaleUser(User user)
Avatar getAnonymousAvatar()
Returns the anonymous avatar, if configured.
Avatar getDefaultAvatar()
Returns the default avatar, if configured.
void setConfiguredAvatarIdFor(ApplicationUser user, Long avatarId)
Sets the given avatar id as the configured avatar id for a user.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.avatar.AvatarService

Public Constructors

public AvatarServiceImpl (UserManager userManager, AvatarManager avatarManager, UserPropertyManager userPropertyManager, VelocityRequestContextFactory velocityRequestContextFactory, ApplicationProperties applicationProperties, GravatarSettings gravatarSettings)

Public Methods

public boolean canSetCustomUserAvatar (User remoteUser, String username)

Returns a boolean indicating whether the calling user can edit the custom user avatar for the user with the given username.

Parameters
remoteUser a User object for the currently logged in user
username the username of the user whose avatar we will configure
Returns
  • a indicating whether the calling user can edit the custom user avatar for another user

public boolean canSetCustomUserAvatar (ApplicationUser remoteUser, ApplicationUser user)

Returns a boolean indicating whether the calling user can edit the custom user avatar for the user with the given username.

Parameters
remoteUser a User object for the currently logged in user
user the user whose avatar we will configure
Returns
  • a indicating whether the calling user can edit the custom user avatar for another user

public Avatar getAvatar (ApplicationUser remoteUser, ApplicationUser avatarUser)

Returns the Avatar for the given user, if configured. If the user does not have a custom avatar, or if the calling user does not have permission to view the Avatar, this method returns the default avatar. If the user does not exist, this method returns the anonymous avatar.

If this method would return the default user avatar but none is configured, or if this method would return the anonymous avatar but none is configured, this method returns null.

Parameters
remoteUser the User that wants to view an Avatar
avatarUser the User that the avatar will be returned for (if null it will return a default avatar if it's set or null)
Returns
  • an Avatar, or null
Throws
AvatarsDisabledException

public Avatar getAvatar (User remoteUser, String username)

Returns the Avatar for the given user, if configured. If the user does not have a custom avatar, or if the calling user does not have permission to view the Avatar, this method returns the default avatar. If the user does not exist, this method returns the anonymous avatar.

If this method would return the default user avatar but none is configured, or if this method would return the anonymous avatar but none is configured, this method returns null.

Parameters
remoteUser the User that wants to view an Avatar
username a String containing a username (may have been deleted)
Returns
  • an Avatar, or null
Throws
AvatarsDisabledException

public URI getAvatarAbsoluteURL (User remoteUser, String username, Avatar.Size size)

This is the same as getAvatarURL(com.atlassian.crowd.embedded.api.User, String, com.atlassian.jira.avatar.Avatar.Size) but returns an absolute URL.

Throws
AvatarsDisabledException

public URI getAvatarAbsoluteURL (ApplicationUser remoteUser, ApplicationUser avatarUser, Avatar.Size size)

This is the same as getAvatarURL(com.atlassian.crowd.embedded.api.User, String, com.atlassian.jira.avatar.Avatar.Size) but returns an absolute URL.

Throws
AvatarsDisabledException

public Avatar getAvatarTagged (ApplicationUser remoteUser, ApplicationUser avatarUser)

Throws
AvatarsDisabledException

public URI getAvatarURL (ApplicationUser remoteUser, ApplicationUser avatarUser)

Returns the URL for the avatar of the user having the given username for displaying on a page that should be shown for the passed in remoteUser. This method returns a URL for an avatar with the default size.

If the user does not have a custom avatar, or if the calling user does not have permission to view the Avatar, this method returns the URL of the default avatar. If the user does not exist, this method returns the URL of the anonymous avatar.

Parameters
remoteUser a User object for the currently logged in user
avatarUser a User object to get the avatar for (if null, the default avatar is used)
Returns
  • a URL that can be used to display the avatar
Throws
AvatarsDisabledException

public URI getAvatarURL (ApplicationUser remoteUser, ApplicationUser avatarUser, Avatar.Size size)

Returns the URL for the avatar of the user having the given username for displaying on a page that should be shown for the passed in remoteUser.

If the user does not have a custom avatar, or if the calling user does not have permission to view the Avatar, this method returns the URL of the default avatar. If the user does not exist, this method returns the URL of the anonymous avatar.

Parameters
remoteUser a User object for the currently logged in user
avatarUser a User to get the avatar for (if null, the default avatar is used)
size the size of the avatar to be displayed (if null, the default size is used)
Returns
  • a URL that can be used to display the avatar
Throws
AvatarsDisabledException

public URI getAvatarURL (User remoteUser, String username, Avatar.Size size)

Returns the URL for the avatar of the user having the given username for displaying on a page that should be shown for the passed in remoteUser.

If the user does not have a custom avatar, or if the calling user does not have permission to view the Avatar, this method returns the URL of the default avatar. If the user does not exist, this method returns the URL of the anonymous avatar.

Parameters
remoteUser a User object for the currently logged in user
username a String containing a username (may have been deleted)
size the size of the avatar to be displayed (if null, the default size is used)
Returns
  • a URL that can be used to display the avatar
Throws
AvatarsDisabledException

public URI getAvatarURL (User remoteUser, String username)

Returns the URL for the avatar of the user having the given username for displaying on a page that should be shown for the passed in remoteUser. This method returns a URL for an avatar with the default size.

If the user does not have a custom avatar, or if the calling user does not have permission to view the Avatar, this method returns the URL of the default avatar. If the user does not exist, this method returns the URL of the anonymous avatar.

Parameters
remoteUser a User object for the currently logged in user
username a String containing a username (may have been deleted)
Returns
  • a URL that can be used to display the avatar
Throws
AvatarsDisabledException

public URI getAvatarUrlNoPermCheck (String username, Avatar.Size size)

This is the same as getAvatarURL(com.atlassian.crowd.embedded.api.User, String, com.atlassian.jira.avatar.Avatar.Size) but does no permission checking.

Parameters
username a String containing a username (may have been deleted)
size the size of the avatar to be displayed (if null, the default size is used)
Returns
  • a URL that can be used to display the avatar
Throws
AvatarsDisabledException

public URI getAvatarUrlNoPermCheck (ApplicationUser avatarUser, Avatar avatar, Avatar.Size size)

Builds a URI for a JIRA avatar with the requested size.

Parameters
avatarUser the ApplicationUser whose avatar we'd like to display
avatar the Avatar whose URI we want
size the size in which the avatar should be displayed
Returns
  • a URI that can be used to display the avatar

public URI getAvatarUrlNoPermCheck (ApplicationUser avatarUser, Avatar.Size size)

This is the same as getAvatarURL(com.atlassian.crowd.embedded.api.User, String, com.atlassian.jira.avatar.Avatar.Size) but does no permission checking.

Parameters
avatarUser a String containing a username (if null, the default avatar is used)
size the size of the avatar to be displayed (if null, the default size is used)
Returns
  • a URL that can be used to display the avatar
Throws
AvatarsDisabledException

public URI getProjectAvatarAbsoluteURL (Project project, Avatar.Size size)

Returns the URL for the avatar of the given project.

This will always return an absolute URL (eg. "http://example.com/jira/...").

Parameters
project the Project of which to get the avatar URL
size the size of the avatar to be displayed (if null, the default size is used)
Returns
  • a URL that can be used to display the avatar

public URI getProjectAvatarURL (Project project, Avatar.Size size)

Returns the URL for the avatar of the given project.

If running in the context of a web request, this will return a URL relative to the server root (ie "/jira/..."). Otherwise, it will return an absolute URL (eg. "http://example.com/jira/...").

Parameters
project the Project of which to get the avatar URL
size the size of the avatar to be displayed (if null, the default size is used)
Returns
  • a URL that can be used to display the avatar

public URI getProjectDefaultAvatarAbsoluteURL (Avatar.Size size)

Returns the URL for the default avatar of a project.

This will always return an absolute URL (eg. "http://example.com/jira/...").

Parameters
size the size of the avatar to be displayed (if null, the default size is used)
Returns
  • a URL that can be used to display the avatar

public URI getProjectDefaultAvatarURL (Avatar.Size size)

Returns the URL for the default avatar of a project.

If running in the context of a web request, this will return a URL relative to the server root (ie "/jira/..."). Otherwise, it will return an absolute URL (eg. "http://example.com/jira/...").

Parameters
size the size of the avatar to be displayed (if null, the default size is used)
Returns
  • a URL that can be used to display the avatar

public boolean hasCustomUserAvatar (User remoteUser, String username)

Returns true if the user has configured a custom avatar, false otherwise.

Parameters
remoteUser a User object for the currently logged in user
username the username of the user whose avatar we will check
Returns
  • a boolean indicating whether the given user has configued a custom avatar

public boolean hasCustomUserAvatar (ApplicationUser remoteUser, ApplicationUser user)

Returns true if the user has configured a custom avatar, false otherwise.

Parameters
remoteUser a User object for the currently logged in user
user the username of the user whose avatar we will check
Returns
  • a boolean indicating whether the given user has configued a custom avatar

public boolean isGravatarEnabled ()

Returns true if Gravatar support is enabled.

Returns
  • a boolean indicating whether Gravatar support is on

public boolean isUsingExternalAvatar (ApplicationUser remoteUser, ApplicationUser avatarUser)

Check whether a user currently has an external avatar (for example, a Gravatar). Use getAvatarURL(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.user.ApplicationUser) to get the avatar URL.

Returns
  • a boolean indicating whether the given currently user has an external avatar

public void setCustomUserAvatar (User remoteUser, String username, Long avatarId)

Sets a custom avatar for a given user.

Parameters
remoteUser a User object for the currently logged in user
username the username of the user whose avatar we will configure
avatarId the id of the avatar to configure for the user
Throws
AvatarsDisabledException
NoPermissionException

public void setCustomUserAvatar (ApplicationUser remoteUser, ApplicationUser user, Long avatarId)

Sets a custom avatar for a given user.

Parameters
remoteUser a User object for the currently logged in user
user the user whose avatar we will configure
avatarId the id of the avatar to configure for the user
Throws
AvatarsDisabledException
NoPermissionException

Protected Methods

protected boolean canViewAvatar (ApplicationUser user, Avatar avatar)

Returns true if the passed in user has permission to view the passed in avatar. By definition, any user can view the system avatars (e.g. avatars with no owner).

Parameters
user a User
avatar an Avatar
Returns
  • a boolean indicating whether the passed in user has permission to view the passed in avatar

protected Long configuredAvatarIdFor (ApplicationUser user)

Returns the avatar id that is configured for the given User. If the user has not configured an avatar, this method returns null.

Parameters
user the user whose avatar we want
Returns
  • an avatar id, or null
See Also

protected static ApplicationUser fromStaleUser (User user)

protected Avatar getAnonymousAvatar ()

Returns the anonymous avatar, if configured. Otherwise returns null.

Returns
  • the anonymous avatar, or null

protected Avatar getDefaultAvatar ()

Returns the default avatar, if configured. Otherwise returns null.

Returns
  • the default Avatar, or null

protected void setConfiguredAvatarIdFor (ApplicationUser user, Long avatarId)

Sets the given avatar id as the configured avatar id for a user.

Parameters
user the User whose avatar is being configured
avatarId the avatar id to configure