Package org.jenkinsci.plugins.oic.avatar

Class ServeFromURLAvatarHandler

java.lang.Object

hudson.model.AbstractDescribableImpl<AvatarHandler>

org.jenkinsci.plugins.oic.avatar.AvatarHandler

org.jenkinsci.plugins.oic.avatar.ServeFromURLAvatarHandler

All Implemented Interfaces:

ExtensionPoint, Describable<AvatarHandler>, Serializable

public class ServeFromURLAvatarHandler
extends AvatarHandler

Records the URL advertised by the provider as-is, so that each user's browser fetches the image directly from the provider.

As the image is fetched by the browser rather than by the controller, the URL must be reachable from every user's browser, and the provider's domain ends up in the img-src Content Security Policy directive.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServeFromURLAvatarHandler.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
ServeFromURLAvatarHandler()

Method Summary

Modifier and Type	Method	Description
void	handleAvatar(OicSecurityRealm realm, User user, String avatarUrl)	Record, refresh or clear the avatar for user.

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Describable

getDescriptor

Constructor Details

ServeFromURLAvatarHandler

@DataBoundConstructor
public ServeFromURLAvatarHandler()

Method Details

handleAvatar

public void handleAvatar(@NonNull
 OicSecurityRealm realm,
 @NonNull
 User user,
 @CheckForNull
 String avatarUrl)
                  throws IOException

Description copied from class: AvatarHandler

Record, refresh or clear the avatar for user.

Called on the login request thread, so implementations must return promptly: anything needing network IO must be handled asynchronously.

Specified by:

handleAvatar in class AvatarHandler

Parameters:

avatarUrl - the value of the provider's avatar claim, or null if it was not present.

Throws:

IOException