com.atlassian.bamboo.user.gravatar
Class GravatarServiceImpl

java.lang.Object
  extended by com.atlassian.bamboo.user.gravatar.GravatarServiceImpl
All Implemented Interfaces:
GravatarService

public class GravatarServiceImpl
extends java.lang.Object
implements 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.


Constructor Summary
GravatarServiceImpl(AdministrationConfigurationManager administrationConfigurationManager)
           
 
Method Summary
 byte[] download(java.lang.String email, int size)
          Downloads the gravatar for the given URL using Java URL and returns a byte array containing the gravatar jpg, returns null if no gravatar was found.
 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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GravatarServiceImpl

public GravatarServiceImpl(AdministrationConfigurationManager administrationConfigurationManager)
Method Detail

getGravatarUrl

@Nullable
public java.lang.String getGravatarUrl(@Nullable
                                                java.lang.String email,
                                                int size)
Specified by:
getGravatarUrl in interface GravatarService
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
public java.lang.String getGravatarUrl(@Nullable
                                                java.lang.String email)
Returns A gravatar for the given emails with the default size of 25 pixels.

Specified by:
getGravatarUrl in interface GravatarService
Parameters:
email - to get gravatar url for
Returns:
url to the users image on the gravatar server

getDefaultGravatarUrl

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

Specified by:
getDefaultGravatarUrl in interface GravatarService
Parameters:
size - a gravatar size between 1 and 512 pixels.
Returns:
the url for the default gravatar.

download

public byte[] download(java.lang.String email,
                       int size)
                throws GravatarDownloadException
Downloads the gravatar for the given URL using Java URL and returns a byte array containing the gravatar jpg, returns null if no gravatar was found.

Parameters:
email - to get gravatar for
size - a gravatar size between 1 and 512 pixels.
Returns:
byte stream of gravatar image
Throws:
GravatarDownloadException - if something goes wrong...

setGravatarSupported

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

Specified by:
setGravatarSupported in interface GravatarService
Parameters:
enabled - whether its enabled or not

isGravatarSupportEnabled

public boolean isGravatarSupportEnabled()
Specified by:
isGravatarSupportEnabled in interface GravatarService
Returns:
true if gravatar support enabled.


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