@ExportedBean(defaultVisibility=2) public class ParametersDefinitionProperty extends OptionalJobProperty<Job<?,?>> implements Action
This class also implements Action
so that index.jelly provides
a form to enter build parameters.
The owning job needs a sidepanel.jelly
and should have web methods delegating to ParameterizedJobMixIn.doBuild(org.kohsuke.stapler.StaplerRequest, org.kohsuke.stapler.StaplerResponse, jenkins.util.TimeDuration)
and ParameterizedJobMixIn.doBuildWithParameters(org.kohsuke.stapler.StaplerRequest, org.kohsuke.stapler.StaplerResponse, jenkins.util.TimeDuration)
.
The builds also need a sidepanel.jelly
.
Modifier and Type | Class and Description |
---|---|
static class |
ParametersDefinitionProperty.DescriptorImpl |
OptionalJobProperty.OptionalJobPropertyDescriptor
BuildStep.PublisherList
ExtensionPoint.LegacyInstancesAreScopedToHudson
owner
BUILDERS, PUBLISHERS
Constructor and Description |
---|
ParametersDefinitionProperty(List<ParameterDefinition> parameterDefinitions) |
ParametersDefinitionProperty(ParameterDefinition... parameterDefinitions) |
Modifier and Type | Method and Description |
---|---|
void |
_doBuild(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp)
Deprecated.
|
void |
_doBuild(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp,
TimeDuration delay)
Interprets the form submission and schedules a build for a parameterized job.
|
void |
buildWithParameters(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp)
|
void |
buildWithParameters(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp,
TimeDuration delay) |
String |
getDisplayName()
Gets the string to be displayed.
|
String |
getIconFileName()
Gets the file name of the icon.
|
ParameterizedJobMixIn.ParameterizedJob |
getJob() |
Collection<Action> |
getJobActions(AbstractProject<?,?> job)
Deprecated.
|
Collection<Action> |
getJobActions(Job<?,?> job)
Action s to be displayed in the job page. |
AbstractProject<?,?> |
getOwner()
Deprecated.
|
ParameterDefinition |
getParameterDefinition(String name)
Gets the
ParameterDefinition of the given name, if any. |
List<String> |
getParameterDefinitionNames()
Gets the names of all the parameter definitions.
|
List<ParameterDefinition> |
getParameterDefinitions() |
AbstractProject<?,?> |
getProject()
Deprecated.
|
String |
getUrlName()
Gets the URL path name.
|
getDescriptor
getJobAction, getJobOverrides, getProjectAction, getProjectActions, getRequiredMonitorService, getSubTasks, perform, prebuild, reconfigure, setOwner
@DataBoundConstructor public ParametersDefinitionProperty(List<ParameterDefinition> parameterDefinitions)
public ParametersDefinitionProperty(ParameterDefinition... parameterDefinitions)
@Deprecated public AbstractProject<?,?> getOwner()
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class) public ParameterizedJobMixIn.ParameterizedJob getJob()
@Exported public List<ParameterDefinition> getParameterDefinitions()
public List<String> getParameterDefinitionNames()
@Nonnull public Collection<Action> getJobActions(Job<?,?> job)
JobProperty
Action
s to be displayed in the job page.
Returning actions from this method allows a job property to add them to the left navigation bar in the job page.
Action
can implement additional marker interface to integrate
with the UI in different ways.
getJobActions
in class JobProperty<Job<?,?>>
job
- Always the same as JobProperty.owner
but passed in anyway for backward compatibility (I guess.)
You really need not use this value at all.ProminentProjectAction
,
PermalinkProjectAction
@Deprecated public Collection<Action> getJobActions(AbstractProject<?,?> job)
@Deprecated public AbstractProject<?,?> getProject()
@Deprecated public void _doBuild(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) throws IOException, javax.servlet.ServletException
_doBuild(StaplerRequest, StaplerResponse, TimeDuration)
IOException
javax.servlet.ServletException
public void _doBuild(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, @QueryParameter TimeDuration delay) throws IOException, javax.servlet.ServletException
This method is supposed to be invoked from ParameterizedJobMixIn.doBuild(StaplerRequest, StaplerResponse, TimeDuration)
.
IOException
javax.servlet.ServletException
@Deprecated public void buildWithParameters(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) throws IOException, javax.servlet.ServletException
IOException
javax.servlet.ServletException
public void buildWithParameters(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, @CheckForNull TimeDuration delay) throws IOException, javax.servlet.ServletException
IOException
javax.servlet.ServletException
public ParameterDefinition getParameterDefinition(String name)
ParameterDefinition
of the given name, if any.public String getDisplayName()
Action
getDisplayName
in interface Action
getDisplayName
in interface ModelObject
public String getIconFileName()
Action
getIconFileName
in interface Action
If an absolute file name that starts from '/' is returned (like "/plugin/foo/abc.gif'), then it will be interpreted as a path from the context root of Jenkins. This is useful to pick up image files from a plugin.
Finally, return null to hide it from the task list. This is normally not very useful, but this can be used for actions that only contribute floatBox.jelly and no task list item. The other case where this is useful is to avoid showing links that require a privilege when the user is anonymous.
Functions.isAnonymous()
,
Functions.getIconFilePath(Action)
public String getUrlName()
Action
For example, if this method returns "xyz", and if the parent object (that this action is associated with) is bound to /foo/bar/zot, then this action object will be exposed to /foo/bar/zot/xyz.
This method should return a string that's unique among other Action
s.
The returned string can be an absolute URL, like "http://www.sun.com/", which is useful for directly connecting to external systems.
If the returned string starts with '/', like '/foo', then it's assumed to be relative to the context path of the Jenkins webapp.
getUrlName
in interface Action
Action.getIconFileName()
.Functions.getActionUrl(String, Action)
Copyright © 2018. All rights reserved.