com.atlassian.jira.avatar.plugin

Class JiraUserAvatarProvider

java.lang.Object

com.atlassian.jira.avatar.plugin.JiraUserAvatarProvider

All Implemented Interfaces:

com.atlassian.plugins.avatar.AvatarProvider<ApplicationUser,Long>

public class JiraUserAvatarProvider
extends Object
implements com.atlassian.plugins.avatar.AvatarProvider<ApplicationUser,Long>

A provider for JIRA's internal User Avatar hosting and optional Gravatar support.

Constructor Summary

Constructors

Constructor and Description
JiraUserAvatarProvider(BaseUrl baseUrl, EncodingConfiguration encodingConfiguration, GravatarSettings gravatarSettings, AvatarManager avatarManager, UserManager userManager, UserPropertyManager userPropertyManager)
JiraUserAvatarProvider(VelocityRequestContextFactory velocityRequestContextFactory, GravatarSettings gravatarSettings, AvatarManager avatarManager, UserManager userManager, UserPropertyManager userPropertyManager, EncodingConfiguration encodingConfiguration) Injectable constructor, to be deleted when BaseUrl becomes an API component.

Method Summary

Modifier and Type	Method and Description
protected Long	configuredAvatarIdFor(ApplicationUser user) Returns the avatar id that is configured for the given User.
com.atlassian.plugins.avatar.Avatar	getAvatar(com.atlassian.plugins.avatar.AvatarOwner<ApplicationUser> avatarOwner, com.google.common.base.Function<com.atlassian.plugins.avatar.AvatarOwner<ApplicationUser>,com.atlassian.plugins.avatar.Avatar> fallbackFunction, int size)
com.atlassian.plugins.avatar.Avatar	getAvatar(com.atlassian.plugins.avatar.AvatarOwner<ApplicationUser> applicationUserAvatarOwner, int size)
com.atlassian.plugins.avatar.Avatar	getAvatar(String email, int size) Gets the avatar for the user with the given userKey.
com.atlassian.plugins.avatar.Avatar	getAvatarById(Long id, int size)
boolean	isGravatarEnabled() Returns true if Gravatar support is enabled.
boolean	isUsingExternalAvatar(ApplicationUser avatarUser)

Methods inherited from class java.lang.Object

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

Constructor Detail

JiraUserAvatarProvider

public JiraUserAvatarProvider(VelocityRequestContextFactory velocityRequestContextFactory,
                              GravatarSettings gravatarSettings,
                              AvatarManager avatarManager,
                              UserManager userManager,
                              UserPropertyManager userPropertyManager,
                              EncodingConfiguration encodingConfiguration)

Injectable constructor, to be deleted when BaseUrl becomes an API component.

JiraUserAvatarProvider

public JiraUserAvatarProvider(BaseUrl baseUrl,
                              EncodingConfiguration encodingConfiguration,
                              GravatarSettings gravatarSettings,
                              AvatarManager avatarManager,
                              UserManager userManager,
                              UserPropertyManager userPropertyManager)

Method Detail

getAvatar

public com.atlassian.plugins.avatar.Avatar getAvatar(String email,
                                                     int size)

Gets the avatar for the user with the given userKey.

Specified by:

getAvatar in interface com.atlassian.plugins.avatar.AvatarProvider<ApplicationUser,Long>

getAvatar

public com.atlassian.plugins.avatar.Avatar getAvatar(com.atlassian.plugins.avatar.AvatarOwner<ApplicationUser> applicationUserAvatarOwner,
                                                     int size)

Specified by:

getAvatar in interface com.atlassian.plugins.avatar.AvatarProvider<ApplicationUser,Long>

getAvatarById

public com.atlassian.plugins.avatar.Avatar getAvatarById(Long id,
                                                         int size)

Specified by:

getAvatarById in interface com.atlassian.plugins.avatar.AvatarProvider<ApplicationUser,Long>

getAvatar

public com.atlassian.plugins.avatar.Avatar getAvatar(com.atlassian.plugins.avatar.AvatarOwner<ApplicationUser> avatarOwner,
                                                     com.google.common.base.Function<com.atlassian.plugins.avatar.AvatarOwner<ApplicationUser>,com.atlassian.plugins.avatar.Avatar> fallbackFunction,
                                                     int size)

Specified by:

getAvatar in interface com.atlassian.plugins.avatar.AvatarProvider<ApplicationUser,Long>

isGravatarEnabled

public boolean isGravatarEnabled()

Returns true if Gravatar support is enabled.

Returns:

a boolean indicating whether Gravatar support is on

isUsingExternalAvatar

public boolean isUsingExternalAvatar(ApplicationUser avatarUser)

configuredAvatarIdFor

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:

AvatarManager.getDefaultAvatarId(com.atlassian.jira.avatar.Avatar.Type), AvatarManager.getAnonymousAvatarId()