Package org.jenkinsci.plugins.oic.avatar

Class AvatarHandler

java.lang.Object

hudson.model.AbstractDescribableImpl<AvatarHandler>

org.jenkinsci.plugins.oic.avatar.AvatarHandler

All Implemented Interfaces:

ExtensionPoint, Describable<AvatarHandler>, Serializable

Direct Known Subclasses:

NoAvatarHandler, ServeFromURLAvatarHandler

public abstract class AvatarHandler
extends AbstractDescribableImpl<AvatarHandler>
implements ExtensionPoint, Serializable

Strategy for how a user's avatar, as advertised by the OpenID Connect provider, is made available to Jenkins pages. Selected by the administrator in the security realm configuration.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
AvatarHandler()

Method Summary

Modifier and Type	Method	Description
abstract 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

AvatarHandler

public AvatarHandler()

Method Details

handleAvatar

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

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.

Parameters:

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

Throws:

IOException