Class HudsonPrivateSecurityRealm.Details.DescriptorImpl
- Enclosing class:
- HudsonPrivateSecurityRealm.Details
-
Nested Class Summary
Nested classes/interfaces inherited from class hudson.model.Descriptor
Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self
-
Field Summary
Fields inherited from class hudson.model.Descriptor
clazz
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionHuman readable name of this kind of configurable object.Define the category for this user property descriptor.boolean
Whether or not the described property is enabled in the current context.newInstance
(User user) Creates a default instance ofUserProperty
to be associated withUser
object that wasn't created from a persisted XML data.newInstance
(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject formData) Creates a configured instance from the submitted form.Methods inherited from class hudson.model.UserPropertyDescriptor
getDescription, getUserPropertyCategoryAsString
Methods inherited from class hudson.model.Descriptor
addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, configure, doHelp, 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, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap
-
Constructor Details
-
DescriptorImpl
public DescriptorImpl()
-
-
Method Details
-
getDisplayName
Description copied from class:Descriptor
Human readable name of this kind of configurable object. Should be overridden for most descriptors, if the display name is visible somehow. As a fallback it usesClass.getSimpleName()
onDescriptor.clazz
, so for exampleMyThing
fromsome.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 asisEnabled
orisApplicable
.- Overrides:
getDisplayName
in classDescriptor<UserProperty>
-
newInstance
public HudsonPrivateSecurityRealm.Details newInstance(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject formData) throws Descriptor.FormException Description copied from class:Descriptor
Creates a configured instance from the submitted form.Hudson only invokes this method when the user wants an instance of
T
. So there's no need to check that in the implementation.The default implementation of this method uses
Descriptor.bindJSON(org.kohsuke.stapler.StaplerRequest2, java.lang.Class<T>, net.sf.json.JSONObject)
which performs the databinding on the constructor ofDescriptor.clazz
.For some types of
Describable
, such asListViewColumn
, this method can be invoked with null request object for historical reason. Such design is considered broken, but due to the compatibility reasons we cannot fix it. Because of this, the default implementation gracefully handles null request, but the contract of the method still is "request is always non-null." Extension points that need to define the "default instance" semantics should define a descriptor subtype and add the no-arg newInstance method.- Overrides:
newInstance
in classDescriptor<UserProperty>
- Parameters:
req
- Always non-null (see note above.) This object includes represents the entire submission.formData
- The JSON object that captures the configuration data for thisDescriptor
. See the developer documentation. Always non-null.- Throws:
Descriptor.FormException
- Signals a problem in the submitted form.
-
isEnabled
public boolean isEnabled()Description copied from class:UserPropertyDescriptor
Whether or not the described property is enabled in the current context. Defaults to true. Over-ride in sub-classes as required.Returning false from this method essentially has the same effect of making Hudson behaves as if this
UserPropertyDescriptor
is not a part ofUserProperty.all()
.This mechanism is useful if the availability of the property is contingent of some other settings.
- Overrides:
isEnabled
in classUserPropertyDescriptor
-
newInstance
Description copied from class:UserPropertyDescriptor
Creates a default instance ofUserProperty
to be associated withUser
object that wasn't created from a persisted XML data.See
User
class javadoc for more details about the life cycle ofUser
and when this method is invoked.- Specified by:
newInstance
in classUserPropertyDescriptor
- Returns:
- null if the implementation choose not to add any property object for such user.
-
getUserPropertyCategory
Description copied from class:UserPropertyDescriptor
Define the category for this user property descriptor.- Overrides:
getUserPropertyCategory
in classUserPropertyDescriptor
- Returns:
- never null, always the same value for a given instance of
Descriptor
.
-