Package org.jenkinsci.plugins.oic.avatar

Class AvatarProperty

java.lang.Object

hudson.model.UserProperty

org.jenkinsci.plugins.oic.avatar.AvatarProperty

All Implemented Interfaces:

ExtensionPoint, Describable<UserProperty>, ReconfigurableDescribable<UserProperty>

@SuppressRestrictedWarnings(jenkins.security.csp.AvatarContributor.class)
public class AvatarProperty
extends UserProperty

Records the avatar of a user that logged in through OpenID Connect.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.UserProperty

user

Method Summary

Modifier and Type	Method	Description
static void	clear(User user)	Clear the AvatarProperty
boolean	equals(Object obj)
String	getAvatarUrl()	The URL the browser should load the avatar from
int	hashCode()
UserProperty	reconfigure(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject form)	The property is not user-editable, so a user configuration form submit must never be able to change or wipe it.

Methods inherited from class hudson.model.UserProperty

all, allByCategoryClass, getDescriptor, reconfigure, setUser

Methods inherited from class java.lang.Object

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

Method Details

getAvatarUrl

@CheckForNull
public String getAvatarUrl()

The URL the browser should load the avatar from

Returns:

the URL, or null if there is no avatar.

clear

public static void clear(User user)
                  throws IOException

Clear the AvatarProperty

Parameters:

user - the user to clear the property from.

Throws:

IOException

reconfigure

public UserProperty reconfigure(org.kohsuke.stapler.StaplerRequest2 req,
 net.sf.json.JSONObject form)
                         throws Descriptor.FormException

The property is not user-editable, so a user configuration form submit must never be able to change or wipe it. We therefore deliberately do not bind the submitted JSON and simply keep the existing instance.

Specified by:

reconfigure in interface ReconfigurableDescribable<UserProperty>

Overrides:

reconfigure in class UserProperty

Throws:

Descriptor.FormException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object