jenkins.model

Class ParameterizedJobMixIn<JobT extends Job<JobT,RunT> & ParameterizedJobMixIn.ParameterizedJob & Queue.Task,RunT extends Run<JobT,RunT> & Queue.Executable>

java.lang.Object

jenkins.model.ParameterizedJobMixIn<JobT,RunT>

public abstract class ParameterizedJobMixIn<JobT extends Job<JobT,RunT> & ParameterizedJobMixIn.ParameterizedJob & Queue.Task,RunT extends Run<JobT,RunT> & Queue.Executable>
extends Object

Allows a Job to make use of ParametersDefinitionProperty and be scheduled in various ways. Stateless so there is no need to keep an instance of it in a field.

Since:

1.556

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ParameterizedJobMixIn.ParameterizedJob Marker for job using this mixin.

Field Summary

Fields

Modifier and Type	Field and Description
static AlternativeUiTextProvider.Message<ParameterizedJobMixIn.ParameterizedJob>	BUILD_NOW_TEXT Allows customization of the human-readable display name to be rendered in the Build Now link.

Constructor Summary

Constructors

Constructor and Description
ParameterizedJobMixIn()

Method Summary

Modifier and Type	Method and Description
protected abstract JobT	asJob()
void	doBuild(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, TimeDuration delay) Schedules a new build command.
void	doBuildWithParameters(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, TimeDuration delay) Supports build trigger with parameters via an HTTP GET or POST.
void	doCancelQueue(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Cancels a scheduled build.
SearchIndexBuilder	extendSearchIndex(SearchIndexBuilder sib) Use from a Job.makeSearchIndex() override.
static CauseAction	getBuildCause(ParameterizedJobMixIn.ParameterizedJob job, org.kohsuke.stapler.StaplerRequest req) Computes the build cause, using RemoteCause or UserCause as appropriate.
String	getBuildNowText() Suggested implementation of ParameterizedJobMixIn.ParameterizedJob.getBuildNowText().
static <T extends Trigger<?>> T	getTrigger(Job<?,?> job, Class<T> clazz) Checks for the existence of a specific trigger on a job.
boolean	isParameterized() A job should define a method of the same signature for use from BuildButtonColumn.
boolean	scheduleBuild()
boolean	scheduleBuild(Cause c)
boolean	scheduleBuild(int quietPeriod)
boolean	scheduleBuild(int quietPeriod, Cause c)
QueueTaskFuture<RunT>	scheduleBuild2(int quietPeriod, Action... actions) Provides a standard implementation of an optional method of the same name in a Job type to schedule a build with the ability to wait for its result.
static Queue.Item	scheduleBuild2(Job<?,?> job, int quietPeriod, Action... actions) Convenience method to schedule a build.

Methods inherited from class java.lang.Object

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

Field Detail

BUILD_NOW_TEXT

public static final AlternativeUiTextProvider.Message<ParameterizedJobMixIn.ParameterizedJob> BUILD_NOW_TEXT

Allows customization of the human-readable display name to be rendered in the Build Now link.

Since:

TODO

See Also:

getBuildNowText()

Constructor Detail

ParameterizedJobMixIn

public ParameterizedJobMixIn()

Method Detail

asJob

protected abstract JobT asJob()

scheduleBuild

public final boolean scheduleBuild()

See Also:

BuildableItem.scheduleBuild()

scheduleBuild

public final boolean scheduleBuild(Cause c)

See Also:

BuildableItem.scheduleBuild(Cause)

scheduleBuild

public final boolean scheduleBuild(int quietPeriod)

See Also:

BuildableItem.scheduleBuild(int)

scheduleBuild

public final boolean scheduleBuild(int quietPeriod,
                                   Cause c)

See Also:

BuildableItem.scheduleBuild(int, Cause)

scheduleBuild2

@CheckForNull
public final QueueTaskFuture<RunT> scheduleBuild2(int quietPeriod,
                                                                Action... actions)

Provides a standard implementation of an optional method of the same name in a Job type to schedule a build with the ability to wait for its result. That job method is often used during functional tests (JenkinsRule.assertBuildStatusSuccess).

Parameters:

quietPeriod - seconds to wait before starting (normally 0)

actions - various actions to associate with the scheduling, such as ParametersAction or CauseAction

Returns:

a handle by which you may wait for the build to complete (or just start); or null if the build was not actually scheduled for some reason

scheduleBuild2

@CheckForNull
public static Queue.Item scheduleBuild2(Job<?,?> job,
                                                      int quietPeriod,
                                                      Action... actions)

Convenience method to schedule a build. Useful for Trigger implementations, for example. If you need to wait for the build to start (or finish), use Queue.Item#getFuture.

Parameters:

job - a job which might be schedulable

quietPeriod - seconds to wait before starting; use -1 to use the job’s default settings

actions - various actions to associate with the scheduling, such as ParametersAction or CauseAction

Returns:

a newly created, or reused, queue item if the job could be scheduled; null if it was refused for some reason (e.g., some Queue.QueueDecisionHandler rejected it), or if job is not a ParameterizedJobMixIn.ParameterizedJob or it is not Job.isBuildable())

Since:

1.621

isParameterized

public final boolean isParameterized()

A job should define a method of the same signature for use from BuildButtonColumn.

doBuild

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

Schedules a new build command. Create a method on your job with the same signature and delegate to this.

Throws:

IOException

javax.servlet.ServletException

doBuildWithParameters

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

Supports build trigger with parameters via an HTTP GET or POST. Currently only String parameters are supported. Create a method on your job with the same signature and delegate to this.

Throws:

IOException

javax.servlet.ServletException

doCancelQueue

public final void doCancelQueue(org.kohsuke.stapler.StaplerRequest req,
                                org.kohsuke.stapler.StaplerResponse rsp)
                         throws IOException,
                                javax.servlet.ServletException

Cancels a scheduled build. Create a method on your job marked RequirePOST but with the same signature and delegate to this.

Throws:

IOException

javax.servlet.ServletException

extendSearchIndex

public final SearchIndexBuilder extendSearchIndex(SearchIndexBuilder sib)

Use from a Job.makeSearchIndex() override.

Parameters:

sib - the super value

Returns:

the value to return

getBuildCause

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static final CauseAction getBuildCause(ParameterizedJobMixIn.ParameterizedJob job,
                                                                                                                     org.kohsuke.stapler.StaplerRequest req)

Computes the build cause, using RemoteCause or UserCause as appropriate.

getBuildNowText

public final String getBuildNowText()

Suggested implementation of ParameterizedJobMixIn.ParameterizedJob.getBuildNowText(). Uses BUILD_NOW_TEXT.

getTrigger

@CheckForNull
public static <T extends Trigger<?>> T getTrigger(Job<?,?> job,
                                                                Class<T> clazz)

Checks for the existence of a specific trigger on a job.

Type Parameters:

T - a trigger type

Parameters:

job - a job

clazz - the type of the trigger

Returns:

a configured trigger of the requested type, or null if there is none such, or job is not a ParameterizedJobMixIn.ParameterizedJob

Since:

1.621