@Extension @Symbol(value="userSeed") public static final class UserSeedProperty.DescriptorImpl extends UserPropertyDescriptor
Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self
clazz
Constructor and Description |
---|
DescriptorImpl() |
Modifier and Type | Method and Description |
---|---|
org.kohsuke.stapler.HttpResponse |
doRenewSessionSeed(User u) |
String |
getDisplayName()
Human readable name of this kind of configurable object.
|
boolean |
isCurrentUser(User target) |
boolean |
isEnabled()
Whether or not the described property is enabled in the current context.
|
UserSeedProperty |
newInstance(User user)
Creates a default instance of
UserProperty to be associated
with User object that wasn't created from a persisted XML data. |
addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap
@NonNull public String getDisplayName()
Descriptor
Class.getSimpleName()
on Descriptor.clazz
, so for example MyThing
from some.pkg.MyThing.DescriptorImpl
.
Historically some implementations returned null as a way of hiding the descriptor from the UI,
but this is generally managed by an explicit method such as isEnabled
or isApplicable
.getDisplayName
in class Descriptor<UserProperty>
public UserSeedProperty newInstance(User user)
UserPropertyDescriptor
UserProperty
to be associated
with User
object that wasn't created from a persisted XML data.
See User
class javadoc for more details about the life cycle
of User
and when this method is invoked.
newInstance
in class UserPropertyDescriptor
@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) public boolean isCurrentUser(@NonNull User target)
public org.kohsuke.stapler.HttpResponse doRenewSessionSeed(@AncestorInPath @NonNull User u) throws IOException
IOException
public boolean isEnabled()
UserPropertyDescriptor
Returning false from this method essentially has the same effect of
making Hudson behaves as if this UserPropertyDescriptor
is
not a part of UserProperty.all()
.
This mechanism is useful if the availability of the property is contingent of some other settings.
isEnabled
in class UserPropertyDescriptor
Copyright © 2004–2021. All rights reserved.