Offering default methods on ParameterizedJob #2864
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -53,6 +53,7 @@ | |
| import javax.servlet.ServletException; | ||
| import static javax.servlet.http.HttpServletResponse.SC_CREATED; | ||
| import static javax.servlet.http.HttpServletResponse.SC_CONFLICT; | ||
| import jenkins.triggers.SCMTriggerItem; | ||
| import jenkins.util.TimeDuration; | ||
| import org.kohsuke.accmod.Restricted; | ||
| import org.kohsuke.accmod.restrictions.NoExternalUse; | ||
|
|
@@ -65,10 +66,11 @@ | |
| /** | ||
| * Allows a {@link Job} to make use of {@link ParametersDefinitionProperty} and be scheduled in various ways. | ||
| * Stateless so there is no need to keep an instance of it in a field. | ||
| * Besides implementing {@link ParameterizedJob}, you should override {@link Job#makeSearchIndex} to call {@link #extendSearchIndex}. | ||
| * @since 1.556 | ||
| */ | ||
| @SuppressWarnings("unchecked") // AbstractItem.getParent does not correctly override; scheduleBuild2 inherently untypable | ||
| public abstract class ParameterizedJobMixIn<JobT extends Job<JobT, RunT> & ParameterizedJobMixIn.ParameterizedJob<JobT, RunT> & Queue.Task, RunT extends Run<JobT, RunT> & Queue.Executable> { | ||
|
|
||
| protected abstract JobT asJob(); | ||
|
|
||
|
|
@@ -95,11 +97,7 @@ public final boolean scheduleBuild(int quietPeriod, Cause c) { | |
| } | ||
|
|
||
| /** | ||
| * Standard implementation of {@link ParameterizedJob#scheduleBuild2}. | ||
| */ | ||
| public final @CheckForNull QueueTaskFuture<RunT> scheduleBuild2(int quietPeriod, Action... actions) { | ||
| Queue.Item i = scheduleBuild2(quietPeriod, Arrays.asList(actions)); | ||
|
|
@@ -161,15 +159,14 @@ private List<ParameterValue> getDefaultParametersValues() { | |
| } | ||
|
|
||
| /** | ||
| * Standard implementation of {@link ParameterizedJob#isParameterized}. | ||
| */ | ||
| public final boolean isParameterized() { | ||
| return asJob().getProperty(ParametersDefinitionProperty.class) != null; | ||
| } | ||
|
|
||
| /** | ||
| * Standard implementation of {@link ParameterizedJob#doBuild}. | ||
| */ | ||
| @SuppressWarnings("deprecation") | ||
| public final void doBuild(StaplerRequest req, StaplerResponse rsp, @QueryParameter TimeDuration delay) throws IOException, ServletException { | ||
|
|
@@ -206,9 +203,7 @@ public final void doBuild(StaplerRequest req, StaplerResponse rsp, @QueryParamet | |
| } | ||
|
|
||
| /** | ||
| * Standard implementation of {@link ParameterizedJob#doBuildWithParameters}. | ||
| */ | ||
| @SuppressWarnings("deprecation") | ||
| public final void doBuildWithParameters(StaplerRequest req, StaplerResponse rsp, @QueryParameter TimeDuration delay) throws IOException, ServletException { | ||
|
|
@@ -226,8 +221,7 @@ public final void doBuildWithParameters(StaplerRequest req, StaplerResponse rsp, | |
| } | ||
|
|
||
| /** | ||
| * Standard implementation of {@link ParameterizedJob#doCancelQueue}. | ||
| */ | ||
| @RequirePOST | ||
| public final void doCancelQueue( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException { | ||
|
|
@@ -275,7 +269,6 @@ public static final CauseAction getBuildCause(ParameterizedJob job, StaplerReque | |
|
|
||
| /** | ||
| * Suggested implementation of {@link ParameterizedJob#getBuildNowText}. | ||
| */ | ||
| public final String getBuildNowText() { | ||
| return isParameterized() ? AlternativeUiTextProvider.get(BUILD_NOW_TEXT, asJob(), Messages.ParameterizedJobMixIn_build_with_parameters()) | ||
|
|
@@ -294,7 +287,7 @@ public final String getBuildNowText() { | |
| if (!(job instanceof ParameterizedJob)) { | ||
| return null; | ||
| } | ||
| for (Trigger<?> t : ((ParameterizedJob<?, ?>) job).getTriggers().values()) { | ||
| if (clazz.isInstance(t)) { | ||
| return clazz.cast(t); | ||
| } | ||
|
|
@@ -303,16 +296,42 @@ public final String getBuildNowText() { | |
| } | ||
|
|
||
| /** | ||
| * Marker for job using this mixin, and default implementations of many methods. | ||
| */ | ||
| public interface ParameterizedJob<JobT extends Job<JobT, RunT> & ParameterizedJobMixIn.ParameterizedJob<JobT, RunT> & Queue.Task, RunT extends Run<JobT, RunT> & Queue.Executable> extends BuildableItem { | ||
|
There was a problem hiding this comment. To follow-up on my bug in #2874 (comment) . Effectively it makes any any Parameterized job explicitly buildable. After some consideration, it seems to be a valid change according to the ParameterizedJobMixIn documentation. 🐜 since I expect ParameterizedJob Javadoc to explicitly say it. There was a problem hiding this comment. Well the mixin Javadoc does say
which I guess is enough. Anyway |
||
|
|
||
| /** | ||
| * Creates a helper object. | ||
| * (Would have been done entirely as an interface with default methods had this been designed for Java 8.) | ||
| */ | ||
| default ParameterizedJobMixIn<JobT, RunT> getParameterizedJobMixIn() { | ||
| return new ParameterizedJobMixIn<JobT, RunT>() { | ||
| @SuppressWarnings("unchecked") // untypable | ||
| @Override protected JobT asJob() { | ||
| return (JobT) ParameterizedJob.this; | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| @SuppressWarnings("deprecation") | ||
| @CheckForNull hudson.model.BuildAuthorizationToken getAuthToken(); | ||
|
|
||
| /** | ||
| * Quiet period for the job. | ||
| * @return by default, {@link Jenkins#getQuietPeriod} | ||
| */ | ||
| default int getQuietPeriod() { | ||
| return Jenkins.getInstance().getQuietPeriod(); | ||
| } | ||
|
|
||
| /** | ||
| * Text to display for a build button. | ||
| * Uses {@link #BUILD_NOW_TEXT}. | ||
| * @see ParameterizedJobMixIn#getBuildNowText | ||
| */ | ||
| default String getBuildNowText() { | ||
| return getParameterizedJobMixIn().getBuildNowText(); | ||
| } | ||
|
|
||
| /** | ||
| * Gets currently configured triggers. | ||
|
|
@@ -322,6 +341,80 @@ public interface ParameterizedJob extends hudson.model.Queue.Task, hudson.model. | |
| */ | ||
| Map<TriggerDescriptor,Trigger<?>> getTriggers(); | ||
|
|
||
| /** | ||
| * @deprecated use {@link #scheduleBuild(Cause)} | ||
| */ | ||
| @Deprecated | ||
| @Override | ||
| default boolean scheduleBuild() { | ||
| return getParameterizedJobMixIn().scheduleBuild(); | ||
| } | ||
|
|
||
| @Override | ||
| default boolean scheduleBuild(Cause c) { | ||
| return getParameterizedJobMixIn().scheduleBuild(c); | ||
| } | ||
|
|
||
| /** | ||
| * @deprecated use {@link #scheduleBuild(int, Cause)} | ||
| */ | ||
| @Deprecated | ||
| @Override | ||
| default boolean scheduleBuild(int quietPeriod) { | ||
| return getParameterizedJobMixIn().scheduleBuild(quietPeriod); | ||
| } | ||
|
|
||
| @Override | ||
| default boolean scheduleBuild(int quietPeriod, Cause c) { | ||
| return getParameterizedJobMixIn().scheduleBuild(quietPeriod, c); | ||
| } | ||
|
|
||
| /** | ||
| * Provides a standard implementation of {@link SCMTriggerItem#scheduleBuild2} to schedule a build with the ability to wait for its result. | ||
| * That job method is often used during functional tests ({@code JenkinsRule.assertBuildStatusSuccess}). | ||
| * @param quietPeriod seconds to wait before starting (normally 0) | ||
| * @param actions various actions to associate with the scheduling, such as {@link ParametersAction} or {@link CauseAction} | ||
| * @return 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 | ||
| */ | ||
| @CheckForNull | ||
| default QueueTaskFuture<RunT> scheduleBuild2(int quietPeriod, Action... actions) { | ||
| return getParameterizedJobMixIn().scheduleBuild2(quietPeriod, actions); | ||
| } | ||
|
|
||
| /** | ||
| * Schedules a new build command. | ||
| * @see ParameterizedJobMixIn#doBuild | ||
| */ | ||
| default void doBuild(StaplerRequest req, StaplerResponse rsp, @QueryParameter TimeDuration delay) throws IOException, ServletException { | ||
|
There was a problem hiding this comment. So, no Restricted/RequirePOST annotations here? I am not sure it is safe to offer such default impl. 🐛 , but probably I miss something. There was a problem hiding this comment. The original had neither annotation. |
||
| getParameterizedJobMixIn().doBuild(req, rsp, delay); | ||
| } | ||
|
|
||
| /** | ||
| * Supports build trigger with parameters via an HTTP GET or POST. | ||
| * Currently only String parameters are supported. | ||
| * @see ParameterizedJobMixIn#doBuildWithParameters | ||
| */ | ||
| default void doBuildWithParameters(StaplerRequest req, StaplerResponse rsp, @QueryParameter TimeDuration delay) throws IOException, ServletException { | ||
|
|
||
| getParameterizedJobMixIn().doBuildWithParameters(req, rsp, delay); | ||
| } | ||
|
|
||
| /** | ||
| * Cancels a scheduled build. | ||
| * @see ParameterizedJobMixIn#doCancelQueue | ||
| */ | ||
| @RequirePOST | ||
|
|
||
| default void doCancelQueue(StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException { | ||
| getParameterizedJobMixIn().doCancelQueue(req, rsp); | ||
| } | ||
|
|
||
| /** | ||
| * For use from {@link BuildButtonColumn}. | ||
| * @see ParameterizedJobMixIn#isParameterized | ||
| */ | ||
| default boolean isParameterized() { | ||
| return getParameterizedJobMixIn().isParameterized(); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
implements BuildableItemis now redundant, could be removed I guess.The only implementations of
ParameterizedJobwere alreadyBuildableItems so retrofitting it to implement that interface should not cause any behavioral change even if someone were doing thatinstanceofcheck.