org.minijax.avatar

Class AvatarService

java.lang.Object

org.minijax.avatar.AvatarService

@Provider
 @Singleton
public class AvatarService
extends Object

The AvatarUtils class provides utility methods for generating and uploading avatar images.

Field Summary

Fields

Modifier and Type	Field and Description
static double	RESIZE_FACTOR Per the recommendations of the Java/Sun team, we do a multi step image resize.

Constructor Summary

Constructors

Constructor and Description
AvatarService()

Method Summary

Modifier and Type	Method and Description
static BufferedImage	createThumbnail(BufferedImage image, Color bg, int target) Returns a thumbnail of the input image.
static BufferedImage	generateAvatarImage() Generates a new avatar image.
void	generateAvatarImage(NamedEntity owner) Uploads a generated profile picture for the user.
void	handleFileUpload(NamedEntity entity, InputStream file) Uploads a new profile picture.
boolean	tryGravatar(SecurityUser user) Tries to fetch a remote Gravatar image.
boolean	tryRemotePicture(NamedEntity user, String url, int imageType) Tries to fetch a remote profile picture and set it as the user's avatar.

Methods inherited from class java.lang.Object

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

Field Detail

RESIZE_FACTOR

public static final double RESIZE_FACTOR

Per the recommendations of the Java/Sun team, we do a multi step image resize. See more details in this blog post: http://today.java.net/pub/a/today/2007/04/03/perils-of-image-getscaledinstance.html We're using a relatively slow and expensive resize factor of 0.5. That means that we only resize the image to one half per resize. If resizing from 2048 (common DX size) to 200 (common thumbnail size), That means you will make 4 resizes (2048 to 1024 to 512 to 256 to 200).

See Also:

Constant Field Values

Constructor Detail

AvatarService

public AvatarService()

Method Detail

tryGravatar

public boolean tryGravatar(SecurityUser user)
                    throws IOException

Tries to fetch a remote Gravatar image. On success, downloads the image, creates thumbnails, uploads to S3, and updates the user object.

Parameters:

user - The user (email must be populated).

Returns:

True on success; false otherwise.

Throws:

IOException

tryRemotePicture

public boolean tryRemotePicture(NamedEntity user,
                                String url,
                                int imageType)
                         throws IOException

Tries to fetch a remote profile picture and set it as the user's avatar. Validates that the picture is actually a picture. Resizes and uploads the image to S3.

Parameters:

user - The user.

url - The profile picture URL.

imageType - The avatar image type (see ajibot.common.model.Avatar).

Throws:

IOException

createThumbnail

public static BufferedImage createThumbnail(BufferedImage image,
                                            Color bg,
                                            int target)

Returns a thumbnail of the input image. If the image is not square, the result will be the largest possible square inside the rectangle. I.e., it will crop the image.

Parameters:

image - The input image.

bg - The background color.

target - The target size.

generateAvatarImage

public static BufferedImage generateAvatarImage()

Generates a new avatar image.

generateAvatarImage

public void generateAvatarImage(NamedEntity owner)
                         throws IOException

Uploads a generated profile picture for the user.

Parameters:

owner - The owner entity (user, organization, etc).

Throws:

IOException

handleFileUpload

public void handleFileUpload(NamedEntity entity,
                             InputStream file)
                      throws IOException

Uploads a new profile picture. Validates that the picture is actually a picture. Resizes and uploads the image.

Parameters:

entity - The avatar entity (user, organization, device, etc).

file - The alleged picture file.

Throws:

IOException