|Constructor and Description|
|Modifier and Type||Method and Description|
Human readable name of this kind of configurable object.
Returns the resource path to the help screen HTML, if any.
Creates a configured instance from the submitted form.
addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, getCheckUrl, getConfigFile, getConfigPage, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getPlugin, getPropertyType, getPropertyType, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, toArray, toList, toMap
public String getDisplayName()
public AuthorizationStrategy newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData) throws Descriptor.FormException
Hudson only invokes this method when the user wants an instance of T. So there's no need to check that in the implementation.
Starting 1.206, the default implementation of this method does the following:
... which performs the databinding on the constructor of
For some types of
Describable, such as
ListViewColumn, 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.
req- Always non-null (see note above.) This object includes represents the entire submission.
formData- The JSON object that captures the configuration data for this
Descriptor. See http://wiki.hudson-ci.org/display/HUDSON/Structured+Form+Submission Always non-null.
Descriptor.FormException- Signals a problem in the submitted form.
public String getHelpFile()
Starting 1.282, this method uses "convention over configuration" — you should just put the "help.html" (and its localized versions, if any) in the same directory you put your Jelly view files, and this method will automatically does the right thing.
This value is relative to the context root of Hudson, so normally the values are something like "/plugin/emma/help.html" to refer to static resource files in a plugin, or "/publisher/EmmaPublisher/abc" to refer to Jelly script abc.jelly or a method EmmaPublisher.doAbc().
Copyright © 2004-2015 Hudson. All Rights Reserved.