Package com.cloudbees.jenkins.plugins.bitbucket.avatars

Class AvatarCache

java.lang.Object

com.cloudbees.jenkins.plugins.bitbucket.avatars.AvatarCache

All Implemented Interfaces:

ExtensionPoint, Action, ModelObject, RootAction, UnprotectedRootAction

@Extension
public class AvatarCache
extends Object
implements UnprotectedRootAction

An avatar cache that will serve URLs that have been recently registered through buildUrl(String, String).

Since:

2.2.0

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
AvatarCache()	Constructor.

Method Summary

Modifier and Type	Method	Description
static String	buildUrl(AvatarCacheSource source, String size)	Builds the URL for the cached avatar image of the required size.
static String	buildUrl(String url, String size)	Builds the URL for the cached avatar image of the required size.
org.kohsuke.stapler.HttpResponse	doDynamic(org.kohsuke.stapler.StaplerRequest req, String requestedSize)	Serves the cached image.
String	getDisplayName()
String	getIconFileName()
String	getUrlName()

Methods inherited from class java.lang.Object

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

Constructor Detail

AvatarCache

public AvatarCache()

Constructor.

Method Detail

buildUrl

public static String buildUrl(@NonNull
                              String url,
                              @NonNull
                              String size)

Builds the URL for the cached avatar image of the required size.

Parameters:

url - the URL of the source avatar image.

size - the size of the image.

Returns:

the URL of the cached image.

Throws:

IllegalStateException - if called outside of a request handling thread.

buildUrl

public static String buildUrl(@NonNull
                              AvatarCacheSource source,
                              @NonNull
                              String size)

Builds the URL for the cached avatar image of the required size.

Parameters:

source - source avatar image definition.

size - the size of the image.

Returns:

the URL of the cached image.

Throws:

IllegalStateException - if called outside of a request handling thread.

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

doDynamic

public org.kohsuke.stapler.HttpResponse doDynamic(org.kohsuke.stapler.StaplerRequest req,
                                                  @QueryParameter
                                                  String requestedSize)

Serves the cached image.

Parameters:

req - the request.

requestedSize - the requested size (defaults to 48x48 if unspecified).

Returns:

the response.