hudson.model

Class ParametersDefinitionProperty

java.lang.Object

hudson.model.JobProperty<J>

jenkins.model.OptionalJobProperty<Job<?,?>>

hudson.model.ParametersDefinitionProperty

All Implemented Interfaces:

ExtensionPoint, Action, Describable<JobProperty<?>>, ModelObject, ReconfigurableDescribable<JobProperty<?>>, BuildStep

@ExportedBean(defaultVisibility=2)
public class ParametersDefinitionProperty
extends OptionalJobProperty<Job<?,?>>
implements Action

Keeps a list of the parameters defined for a project.

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParametersDefinitionProperty.DescriptorImpl

Nested classes/interfaces inherited from class jenkins.model.OptionalJobProperty

OptionalJobProperty.OptionalJobPropertyDescriptor

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.JobProperty

owner

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
ParametersDefinitionProperty(List<ParameterDefinition> parameterDefinitions)
ParametersDefinitionProperty(ParameterDefinition... parameterDefinitions)

Method Summary

Modifier and Type	Method and Description
void	_doBuild(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Deprecated. use _doBuild(StaplerRequest, StaplerResponse, TimeDuration)
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) Deprecated. use buildWithParameters(StaplerRequest, StaplerResponse, TimeDuration)
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) Actions 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.

Methods inherited from class jenkins.model.OptionalJobProperty

getDescriptor

Methods inherited from class hudson.model.JobProperty

getJobAction, getJobOverrides, getProjectAction, getProjectActions, getRequiredMonitorService, getSubTasks, perform, prebuild, reconfigure, setOwner

Methods inherited from class java.lang.Object

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

Constructor Detail

ParametersDefinitionProperty

@DataBoundConstructor
public ParametersDefinitionProperty(List<ParameterDefinition> parameterDefinitions)

ParametersDefinitionProperty

public ParametersDefinitionProperty(ParameterDefinition... parameterDefinitions)

Method Detail

getOwner

@Deprecated
public AbstractProject<?,?> getOwner()

Deprecated.

getJob

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public ParameterizedJobMixIn.ParameterizedJob getJob()

getParameterDefinitions

@Exported
public List<ParameterDefinition> getParameterDefinitions()

getParameterDefinitionNames

public List<String> getParameterDefinitionNames()

Gets the names of all the parameter definitions.

getJobActions

@Nonnull
public Collection<Action> getJobActions(Job<?,?> job)

Description copied from class: JobProperty

Actions 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.

Overrides:

getJobActions in class JobProperty<Job<?,?>>

Parameters:

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.

Returns:

can be empty but never null.

See Also:

ProminentProjectAction, PermalinkProjectAction

getJobActions

@Deprecated
public Collection<Action> getJobActions(AbstractProject<?,?> job)

Deprecated.

getProject

@Deprecated
public AbstractProject<?,?> getProject()

Deprecated.

_doBuild

@Deprecated
public void _doBuild(org.kohsuke.stapler.StaplerRequest req,
                                 org.kohsuke.stapler.StaplerResponse rsp)
                          throws IOException,
                                 javax.servlet.ServletException

Deprecated. use _doBuild(StaplerRequest, StaplerResponse, TimeDuration)

Throws:

IOException

javax.servlet.ServletException

_doBuild

public void _doBuild(org.kohsuke.stapler.StaplerRequest req,
                     org.kohsuke.stapler.StaplerResponse rsp,
                     @QueryParameter
                     TimeDuration delay)
              throws IOException,
                     javax.servlet.ServletException

Interprets the form submission and schedules a build for a parameterized job.

This method is supposed to be invoked from ParameterizedJobMixIn.doBuild(StaplerRequest, StaplerResponse, TimeDuration).

Throws:

IOException

javax.servlet.ServletException

buildWithParameters

@Deprecated
public void buildWithParameters(org.kohsuke.stapler.StaplerRequest req,
                                            org.kohsuke.stapler.StaplerResponse rsp)
                                     throws IOException,
                                            javax.servlet.ServletException

Deprecated. use buildWithParameters(StaplerRequest, StaplerResponse, TimeDuration)

Throws:

IOException

javax.servlet.ServletException

buildWithParameters

public void buildWithParameters(org.kohsuke.stapler.StaplerRequest req,
                                org.kohsuke.stapler.StaplerResponse rsp,
                                @CheckForNull
                                TimeDuration delay)
                         throws IOException,
                                javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

getParameterDefinition

public ParameterDefinition getParameterDefinition(String name)

Gets the ParameterDefinition of the given name, if any.

getDisplayName

public String getDisplayName()

Description copied from interface: Action

Gets the string to be displayed. The convention is to capitalize the first letter of each word, such as "Test Result".

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getIconFileName

public String getIconFileName()

Description copied from interface: Action

Gets the file name of the icon.

Specified by:

getIconFileName in interface Action

Returns:

If just a file name (like "abc.gif") is returned, it will be interpreted as a file name inside /images/24x24. This is useful for using one of the stock images.

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.

See Also:

Functions.isAnonymous(), Functions.getIconFilePath(Action)

getUrlName

public String getUrlName()

Description copied from interface: Action

Gets the URL path name.

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 Actions.

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.

Specified by:

getUrlName in interface Action

Returns:

null if this action object doesn't need to be bound to web (when you do that, be sure to also return null from Action.getIconFileName().

See Also:

Functions.getActionUrl(String, Action)