com.atlassian.crowd.manager.avatar

Class WebServiceAvatarProvider

java.lang.Object

com.atlassian.crowd.manager.avatar.WebServiceAvatarProvider

All Implemented Interfaces:

AvatarProvider

public class WebServiceAvatarProvider
extends Object
implements AvatarProvider

A provider of avatars from public web services using the Gravatar API.

Field Summary

Fields inherited from interface com.atlassian.crowd.manager.avatar.AvatarProvider

NULL_PROVIDER

Constructor Summary

Constructors

Constructor and Description
WebServiceAvatarProvider(PropertyManager propertyManager, URI base)

Method Summary

Modifier and Type	Method and Description
URI	getHostedUserAvatarUrl(long applicationId, String username, int sizeHint) Gets a URL for a Crowd-hosted avatar, identified by name, and specific to an application.
URI	getUserAvatar(User user, int sizeHint) Gets a URL for an avatar based on the information in this User, if one is available.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebServiceAvatarProvider

public WebServiceAvatarProvider(PropertyManager propertyManager,
                                URI base)

Method Detail

getUserAvatar

@Nullable
public URI getUserAvatar(User user,
                                   int sizeHint)

Description copied from interface: AvatarProvider

Gets a URL for an avatar based on the information in this User, if one is available. This may consider the email address or some other property, as opposed to an avatar provided by a remote directory. This may point back to the same Crowd server or to another service. The URI should be evaluated relative to Crowd's base URL.

Specified by:

getUserAvatar in interface AvatarProvider

Parameters:

user - the user to fetch an avatar for, as returned from a find method

sizeHint - a hint in pixels for how large the image should be

getHostedUserAvatarUrl

public URI getHostedUserAvatarUrl(long applicationId,
                                  String username,
                                  int sizeHint)

Description copied from interface: AvatarProvider

Gets a URL for a Crowd-hosted avatar, identified by name, and specific to an application. The avatar will be based on that application's directory mappings and may come from the underlying directory, rather than being derived from the details of a User object.

Specified by:

getHostedUserAvatarUrl in interface AvatarProvider