hudson.tasks
Class UserAvatarResolver

java.lang.Object
  hudson.tasks.UserAvatarResolver

All Implemented Interfaces:

ExtensionPoint

public abstract class UserAvatarResolver
extends Object
implements ExtensionPoint

Infers avatar image URLs for users

This is an extension point of Jenkins. Plugins that contribute a new implementation of this class should put Extension on your implementation class, like this:

 @Extension
 class MyUserAvatarResolver extends UserAvatarResolver {
   ...
 }
 

Since:

1.434

Author:

Erik Ramfelt

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

UserAvatarResolver()

Method Summary

static ExtensionList<UserAvatarResolver>	all() Returns all the registered UserAvatarResolver descriptors.
abstract String	findAvatarFor(User u, int width, int height) Finds an avatar image URL string for a user.
static String	resolve(User u, String avatarSize) Resolve an avatar image URL string for the user

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAvatarResolver

public UserAvatarResolver()

Method Detail

findAvatarFor

public abstract String findAvatarFor(User u,
                                     int width,
                                     int height)

Finds an avatar image URL string for a user.

This method is called when a web page is going to show an avatar for a User.

When multiple resolvers are installed, they are consulted in order and the search will be over when an avatar is found by someone.

Since UserAvatarResolver is singleton, this method can be invoked concurrently from multiple threads.

Parameters:

u - the user

width - the preferred width of the avatar

height - the preferred height of the avatar.

Returns:

null if the inference failed.

resolve

public static String resolve(User u,
                             String avatarSize)

Resolve an avatar image URL string for the user

Parameters:

u - user

avatarSize - the preferred image size, "[width]x[height]"

Returns:

a URL string for a user Avatar image.

all

public static ExtensionList<UserAvatarResolver> all()

Returns all the registered UserAvatarResolver descriptors.