Package jenkins.model

Class ParameterizedJobMixIn<JobT extends Job<JobT,RunT> & ParameterizedJobMixIn.ParameterizedJob<JobT,RunT> & 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<JobT,RunT> & 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. Besides implementing ParameterizedJobMixIn.ParameterizedJob, you should

• override Job.makeSearchIndex() to call extendSearchIndex(hudson.search.SearchIndexBuilder)
• override AbstractItem.performDelete() to call ParameterizedJobMixIn.ParameterizedJob.makeDisabled(boolean)
• override Job.getIconColor() to call ParameterizedJobMixIn.ParameterizedJob.isDisabled()
• use <p:config-disableBuild/>
• use <p:makeDisabled/>

Since:

1.556

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ParameterizedJobMixIn.ParameterizedJob<JobT extends Job<JobT,RunT> & ParameterizedJobMixIn.ParameterizedJob<JobT,RunT> & Queue.Task,RunT extends Run<JobT,RunT> & Queue.Executable>	Marker for job using this mixin, and default implementations of many methods.

Field Summary

Fields

Modifier and Type	Field	Description
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.
static final AlternativeUiTextProvider.Message<ParameterizedJobMixIn.ParameterizedJob>	BUILD_WITH_PARAMETERS_TEXT

Constructor Summary

Constructors

Constructor	Description
ParameterizedJobMixIn()

Method Summary

Modifier and Type	Method	Description
protected abstract JobT	asJob()
final void	doBuild(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, TimeDuration delay)	Standard implementation of ParameterizedJobMixIn.ParameterizedJob.doBuild(org.kohsuke.stapler.StaplerRequest2, org.kohsuke.stapler.StaplerResponse2, jenkins.util.TimeDuration).
final void	doBuildWithParameters(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, TimeDuration delay)	Standard implementation of ParameterizedJobMixIn.ParameterizedJob.doBuildWithParameters(org.kohsuke.stapler.StaplerRequest2, org.kohsuke.stapler.StaplerResponse2, jenkins.util.TimeDuration).
final void	doCancelQueue(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	Standard implementation of ParameterizedJobMixIn.ParameterizedJob.doCancelQueue(org.kohsuke.stapler.StaplerRequest2, org.kohsuke.stapler.StaplerResponse2).
final SearchIndexBuilder	extendSearchIndex(SearchIndexBuilder sib)	Use from a Job.makeSearchIndex() override.
static CauseAction	getBuildCause(ParameterizedJobMixIn.ParameterizedJob job, org.kohsuke.stapler.StaplerRequest2 req)	Computes the build cause, using RemoteCause or UserCause as appropriate.
final 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.
final boolean	isParameterized()	Standard implementation of ParameterizedJobMixIn.ParameterizedJob.isParameterized().
final boolean	scheduleBuild()
final boolean	scheduleBuild(int quietPeriod)
final boolean	scheduleBuild(int quietPeriod, Cause c)
final boolean	scheduleBuild(Cause c)
final QueueTaskFuture<RunT>	scheduleBuild2(int quietPeriod, Action... actions)	Standard implementation of ParameterizedJobMixIn.ParameterizedJob.scheduleBuild2(int, hudson.model.Action...).
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 Details

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:

1.624

See Also:

• getBuildNowText()

BUILD_WITH_PARAMETERS_TEXT

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

Constructor Details

ParameterizedJobMixIn

public ParameterizedJobMixIn()

Method Details

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)

Standard implementation of ParameterizedJobMixIn.ParameterizedJob.scheduleBuild2(int, hudson.model.Action...).

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()

Standard implementation of ParameterizedJobMixIn.ParameterizedJob.isParameterized().

doBuild

public final void doBuild(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp,
 @QueryParameter
 TimeDuration delay)
                   throws IOException,
jakarta.servlet.ServletException

Standard implementation of ParameterizedJobMixIn.ParameterizedJob.doBuild(org.kohsuke.stapler.StaplerRequest2, org.kohsuke.stapler.StaplerResponse2, jenkins.util.TimeDuration).

Throws:

IOException

jakarta.servlet.ServletException

doBuildWithParameters

public final void doBuildWithParameters(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp,
 @QueryParameter
 TimeDuration delay)
                                 throws IOException,
jakarta.servlet.ServletException

Standard implementation of ParameterizedJobMixIn.ParameterizedJob.doBuildWithParameters(org.kohsuke.stapler.StaplerRequest2, org.kohsuke.stapler.StaplerResponse2, jenkins.util.TimeDuration).

Throws:

IOException

jakarta.servlet.ServletException

doCancelQueue

public final void doCancelQueue(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                         throws IOException,
jakarta.servlet.ServletException

Standard implementation of ParameterizedJobMixIn.ParameterizedJob.doCancelQueue(org.kohsuke.stapler.StaplerRequest2, org.kohsuke.stapler.StaplerResponse2).

Throws:

IOException

jakarta.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(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static CauseAction getBuildCause(ParameterizedJobMixIn.ParameterizedJob job,
 org.kohsuke.stapler.StaplerRequest2 req)

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

getBuildNowText

public final String getBuildNowText()

Suggested implementation of ParameterizedJobMixIn.ParameterizedJob.getBuildNowText().

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