com.atlassian.bamboo.user.gravatar
Interface GravatarService

All Known Implementing Classes:
GravatarServiceImpl

public interface GravatarService

A gravatar is a dynamic image resource that is requested from the gravatar.com server. This class calculates the gravatar url and fetches gravatar images. See http://en.gravatar.com/site/implement/url .

This class is thread-safe, Gravatar objects can be shared.

Currently this service is set to only allow images for general audiences and the Default image is hardcoded.


Method Summary
 java.lang.String getDefaultGravatarUrl(int size)
          Returns the url for the default gravatar.
 java.lang.String getGravatarUrl(java.lang.String email)
          Returns A gravatar for the given emails with the default size of 25 pixels.
 java.lang.String getGravatarUrl(java.lang.String email, int size)
           
 boolean isGravatarSupportEnabled()
           
 void setGravatarSupported(boolean enabled)
          Updates whether or not gravatars are enabled for this Bamboo instance
 

Method Detail

getGravatarUrl

@Nullable
java.lang.String getGravatarUrl(@Nullable
                                         java.lang.String email,
                                         int size)
Parameters:
email - to get gravatar url for
size - Specify a gravatar size between 1 and 512 pixels.
Returns:
url to the users image on the gravatar server

getGravatarUrl

@Nullable
java.lang.String getGravatarUrl(@Nullable
                                         java.lang.String email)
Returns A gravatar for the given emails with the default size of 25 pixels.

Parameters:
email - to get gravatar url for
Returns:
url to the users image on the gravatar server

getDefaultGravatarUrl

@Nullable
java.lang.String getDefaultGravatarUrl(int size)
Returns the url for the default gravatar.

Parameters:
size - a gravatar size between 1 and 512 pixels.
Returns:
the url for the default gravatar.

setGravatarSupported

void setGravatarSupported(boolean enabled)
Updates whether or not gravatars are enabled for this Bamboo instance

Parameters:
enabled - whether its enabled or not

isGravatarSupportEnabled

boolean isGravatarSupportEnabled()
Returns:
true if gravatar support enabled.


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.