diff --git a/core/src/main/java/hudson/matrix/MatrixProject.java b/core/src/main/java/hudson/matrix/MatrixProject.java index 3357d0fe33..59eaf80745 100644 --- a/core/src/main/java/hudson/matrix/MatrixProject.java +++ b/core/src/main/java/hudson/matrix/MatrixProject.java @@ -231,26 +231,14 @@ public class MatrixProject extends AbstractProject im synchronized(transientActions) { super.updateTransientActions(); - for (BuildStep step : builders) { - Action a = step.getProjectAction(this); - if(a!=null) - transientActions.add(a); - } - for (BuildStep step : publishers) { - Action a = step.getProjectAction(this); - if(a!=null) - transientActions.add(a); - } - for (BuildWrapper step : buildWrappers) { - Action a = step.getProjectAction(this); - if(a!=null) - transientActions.add(a); - } - for (Trigger trigger : triggers) { - Action a = trigger.getProjectAction(); - if(a!=null) - transientActions.add(a); - } + for (BuildStep step : builders) + transientActions.addAll(step.getProjectActions(this)); + for (BuildStep step : publishers) + transientActions.addAll(step.getProjectActions(this)); + for (BuildWrapper step : buildWrappers) + transientActions.addAll(step.getProjectActions(this)); + for (Trigger trigger : triggers) + transientActions.addAll(trigger.getProjectActions(this)); } } diff --git a/core/src/main/java/hudson/model/AbstractProject.java b/core/src/main/java/hudson/model/AbstractProject.java index 83ac8d6b3c..34cefb6145 100644 --- a/core/src/main/java/hudson/model/AbstractProject.java +++ b/core/src/main/java/hudson/model/AbstractProject.java @@ -487,9 +487,7 @@ public abstract class AbstractProject

,R extends A transientActions.clear(); for (JobProperty p : properties) { - Action a = p.getJobAction((P)this); - if(a!=null) - transientActions.add(a); + transientActions.addAll(p.getJobActions((P)this)); } for (TransientProjectActionFactory tpaf : TransientProjectActionFactory.all()) @@ -830,7 +828,7 @@ public abstract class AbstractProject

,R extends A *

* Note that this method returns a read-only view of {@link Action}s. * {@link BuildStep}s and others who want to add a project action - * should do so by implementing {@link BuildStep#getProjectAction(AbstractProject)}. + * should do so by implementing {@link BuildStep#getProjectActions(AbstractProject)}. * * @see TransientProjectActionFactory */ diff --git a/core/src/main/java/hudson/model/JobProperty.java b/core/src/main/java/hudson/model/JobProperty.java index 78501e027e..4833b89c89 100644 --- a/core/src/main/java/hudson/model/JobProperty.java +++ b/core/src/main/java/hudson/model/JobProperty.java @@ -32,6 +32,8 @@ import hudson.tasks.Publisher; import hudson.tasks.BuildStepMonitor; import java.io.IOException; +import java.util.Collection; +import java.util.Collections; import org.kohsuke.stapler.export.ExportedBean; @@ -94,10 +96,18 @@ public abstract class JobProperty> implements Describable - * Returning non-null from this method allows a job property to add an item + * Returning actions from this method allows a job property to add them * to the left navigation bar in the job page. * *

@@ -108,13 +118,16 @@ public abstract class JobProperty> implements Describable getJobActions(J job) { + // delegate to getJobAction (singular) for backward compatible behavior + Action a = getJobAction(job); + if (a==null) return Collections.emptyList(); + return Collections.singletonList(a); } // @@ -146,4 +159,8 @@ public abstract class JobProperty> implements Describable project) { return getJobAction((J)project); } + + public final Collection getProjectActions(AbstractProject project) { + return getJobActions((J)project); + } } diff --git a/core/src/main/java/hudson/model/ParametersDefinitionProperty.java b/core/src/main/java/hudson/model/ParametersDefinitionProperty.java index babb4db454..3d1aa6a830 100644 --- a/core/src/main/java/hudson/model/ParametersDefinitionProperty.java +++ b/core/src/main/java/hudson/model/ParametersDefinitionProperty.java @@ -26,6 +26,8 @@ package hudson.model; import java.io.IOException; import java.util.ArrayList; import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; import java.util.List; import java.util.AbstractList; @@ -87,8 +89,8 @@ public class ParametersDefinitionProperty extends JobProperty job) { - return this; + public Collection getJobActions(AbstractProject job) { + return Collections.singleton(this); } public AbstractProject getProject() { diff --git a/core/src/main/java/hudson/model/PermalinkProjectAction.java b/core/src/main/java/hudson/model/PermalinkProjectAction.java index 3df20965ed..da0bd53343 100644 --- a/core/src/main/java/hudson/model/PermalinkProjectAction.java +++ b/core/src/main/java/hudson/model/PermalinkProjectAction.java @@ -28,7 +28,7 @@ import java.util.concurrent.CopyOnWriteArrayList; /** * Optional interface for {@link Action}s that are attached - * to {@link AbstractProject} (through {@link JobProperty#getJobAction(Job)}), + * to {@link AbstractProject} (through {@link JobProperty#getJobActions(Job)}), * which allows plugins to define additional permalinks in the project. * *

diff --git a/core/src/main/java/hudson/model/Project.java b/core/src/main/java/hudson/model/Project.java index a15cd4ee83..f9b6dbeba4 100644 --- a/core/src/main/java/hudson/model/Project.java +++ b/core/src/main/java/hudson/model/Project.java @@ -201,26 +201,14 @@ public abstract class Project

,B extends Build> synchronized(transientActions) { super.updateTransientActions(); - for (BuildStep step : getBuildersList()) { - Action a = step.getProjectAction(this); - if(a!=null) - transientActions.add(a); - } - for (BuildStep step : getPublishersList()) { - Action a = step.getProjectAction(this); - if(a!=null) - transientActions.add(a); - } - for (BuildWrapper step : getBuildWrappers().values()) { - Action a = step.getProjectAction(this); - if(a!=null) - transientActions.add(a); - } - for (Trigger trigger : getTriggers().values()) { - Action a = trigger.getProjectAction(); - if(a!=null) - transientActions.add(a); - } + for (BuildStep step : getBuildersList()) + transientActions.addAll(step.getProjectActions(this)); + for (BuildStep step : getPublishersList()) + transientActions.addAll(step.getProjectActions(this)); + for (BuildWrapper step : getBuildWrappers().values()) + transientActions.addAll(step.getProjectActions(this)); + for (Trigger trigger : getTriggers().values()) + transientActions.addAll(trigger.getProjectActions(this)); } } diff --git a/core/src/main/java/hudson/model/ProminentProjectAction.java b/core/src/main/java/hudson/model/ProminentProjectAction.java index 520aa25c5b..082f87580e 100644 --- a/core/src/main/java/hudson/model/ProminentProjectAction.java +++ b/core/src/main/java/hudson/model/ProminentProjectAction.java @@ -35,10 +35,10 @@ import hudson.triggers.Trigger; * are used to create a large, more visible icon in the top page to draw * users' attention. * - * @see BuildStep#getProjectAction(AbstractProject) - * @see BuildWrapper#getProjectAction(AbstractProject) - * @see Trigger#getProjectAction() - * @see JobProperty#getJobAction(Job) + * @see BuildStep#getProjectActions(AbstractProject) + * @see BuildWrapper#getProjectActions(AbstractProject) + * @see Trigger#getProjectActions() + * @see JobProperty#getJobActions(Job) * * @author Kohsuke Kawaguchi */ diff --git a/core/src/main/java/hudson/tasks/BuildStep.java b/core/src/main/java/hudson/tasks/BuildStep.java index 85743561ed..bca9eac748 100644 --- a/core/src/main/java/hudson/tasks/BuildStep.java +++ b/core/src/main/java/hudson/tasks/BuildStep.java @@ -39,6 +39,7 @@ import hudson.model.CheckPoint; import hudson.model.Run; import java.io.IOException; +import java.util.Collection; import java.util.List; import java.util.AbstractList; import java.util.Iterator; @@ -101,7 +102,13 @@ public interface BuildStep { boolean perform(AbstractBuild build, Launcher launcher, BuildListener listener) throws InterruptedException, IOException; /** - * Returns an action object if this {@link BuildStep} has an action + * @deprecated as of 1.341. + * Use {@link #getProjectActions(AbstractProject)} instead. + */ + Action getProjectAction(AbstractProject project); + + /** + * Returns action objects if this {@link BuildStep} has actions * to contribute to a {@link Project}. * *

@@ -119,9 +126,9 @@ public interface BuildStep { * since {@link BuildStep} object doesn't usually have this "parent" pointer. * * @return - * null if there's no action to be contributed. + * can be empty but never null. */ - Action getProjectAction(AbstractProject project); + Collection getProjectActions(AbstractProject project); /** diff --git a/core/src/main/java/hudson/tasks/BuildStepCompatibilityLayer.java b/core/src/main/java/hudson/tasks/BuildStepCompatibilityLayer.java index 052453de35..e34f677195 100644 --- a/core/src/main/java/hudson/tasks/BuildStepCompatibilityLayer.java +++ b/core/src/main/java/hudson/tasks/BuildStepCompatibilityLayer.java @@ -34,6 +34,8 @@ import hudson.model.CheckPoint; import hudson.Launcher; import java.io.IOException; +import java.util.Collection; +import java.util.Collections; /** * Provides compatibility with {@link BuildStep} before 1.150 @@ -67,6 +69,15 @@ public abstract class BuildStepCompatibilityLayer implements BuildStep { else return null; } + + public Collection getProjectActions(AbstractProject project) { + // delegate to getJobAction (singular) for backward compatible behavior + Action a = getProjectAction(project); + if (a==null) return Collections.emptyList(); + return Collections.singletonList(a); + } + + // // old definitions < 1.150 // diff --git a/core/src/main/java/hudson/tasks/BuildWrapper.java b/core/src/main/java/hudson/tasks/BuildWrapper.java index a016db5bb3..42dadd7a5b 100644 --- a/core/src/main/java/hudson/tasks/BuildWrapper.java +++ b/core/src/main/java/hudson/tasks/BuildWrapper.java @@ -26,7 +26,6 @@ package hudson.tasks; import hudson.ExtensionPoint; import hudson.Launcher; import hudson.DescriptorExtensionList; -import hudson.FileSystemProvisionerDescriptor; import hudson.LauncherDecorator; import hudson.model.AbstractBuild; import hudson.model.Build; @@ -40,6 +39,8 @@ import hudson.model.Descriptor; import hudson.model.Run.RunnerAbortedException; import java.io.IOException; +import java.util.Collection; +import java.util.Collections; /** * Pluggability point for performing pre/post actions for the build process. @@ -187,11 +188,30 @@ public abstract class BuildWrapper implements ExtensionPoint, Describable getProjectActions(AbstractProject job) { + // delegate to getJobAction (singular) for backward compatible behavior + Action a = getProjectAction(job); + if (a==null) return Collections.emptyList(); + return Collections.singletonList(a); + } + + public Descriptor getDescriptor() { return (Descriptor) Hudson.getInstance().getDescriptorOrDie(getClass()); diff --git a/core/src/main/java/hudson/tasks/Builder.java b/core/src/main/java/hudson/tasks/Builder.java index dd783192cc..0d479180a3 100644 --- a/core/src/main/java/hudson/tasks/Builder.java +++ b/core/src/main/java/hudson/tasks/Builder.java @@ -34,6 +34,8 @@ import hudson.model.Project; import hudson.model.Descriptor; import hudson.model.Hudson; +import java.util.Collection; + /** * {@link BuildStep}s that perform the actual build. * @@ -56,13 +58,6 @@ public abstract class Builder extends BuildStepCompatibilityLayer implements Bui return true; } - /** - * Default implementation that does nothing. - */ - public Action getProjectAction(Project project) { - return null; - } - /** * Returns {@link BuildStepMonitor#NONE} by default, as {@link Builder}s normally don't depend * on its previous result. diff --git a/core/src/main/java/hudson/tasks/JavadocArchiver.java b/core/src/main/java/hudson/tasks/JavadocArchiver.java index 0f56e728bb..00f041e575 100644 --- a/core/src/main/java/hudson/tasks/JavadocArchiver.java +++ b/core/src/main/java/hudson/tasks/JavadocArchiver.java @@ -40,6 +40,8 @@ import org.kohsuke.stapler.AncestorInPath; import javax.servlet.ServletException; import java.io.File; import java.io.IOException; +import java.util.Collection; +import java.util.Collections; /** * Saves Javadoc for the project and publish them. @@ -117,8 +119,8 @@ public class JavadocArchiver extends Recorder { } @Override - public Action getProjectAction(AbstractProject project) { - return new JavadocAction(project); + public Collection getProjectActions(AbstractProject project) { + return Collections.singleton(new JavadocAction(project)); } public BuildStepMonitor getRequiredMonitorService() { diff --git a/core/src/main/java/hudson/tasks/junit/JUnitResultArchiver.java b/core/src/main/java/hudson/tasks/junit/JUnitResultArchiver.java index 17bc0013de..8ce07a4239 100644 --- a/core/src/main/java/hudson/tasks/junit/JUnitResultArchiver.java +++ b/core/src/main/java/hudson/tasks/junit/JUnitResultArchiver.java @@ -55,6 +55,8 @@ import java.io.File; import java.io.IOException; import java.io.Serializable; import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; import java.util.List; import net.sf.json.JSONObject; @@ -189,8 +191,8 @@ public class JUnitResultArchiver extends Recorder implements Serializable, } @Override - public Action getProjectAction(AbstractProject project) { - return new TestResultProjectAction(project); + public Collection getProjectActions(AbstractProject project) { + return Collections.singleton(new TestResultProjectAction(project)); } public MatrixAggregator createAggregator(MatrixBuild build, diff --git a/core/src/main/java/hudson/triggers/SCMTrigger.java b/core/src/main/java/hudson/triggers/SCMTrigger.java index eb39b51ce0..9e740399f2 100644 --- a/core/src/main/java/hudson/triggers/SCMTrigger.java +++ b/core/src/main/java/hudson/triggers/SCMTrigger.java @@ -43,6 +43,8 @@ import org.kohsuke.stapler.DataBoundConstructor; import java.io.File; import java.io.IOException; import java.io.PrintStream; +import java.util.Collection; +import java.util.Collections; import java.util.Date; import java.util.List; import java.util.ArrayList; @@ -93,8 +95,8 @@ public class SCMTrigger extends Trigger { } @Override - public Action getProjectAction() { - return new SCMAction(); + public Collection getProjectActions() { + return Collections.singleton(new SCMAction()); } /** diff --git a/core/src/main/java/hudson/triggers/Trigger.java b/core/src/main/java/hudson/triggers/Trigger.java index b85968b0a1..9f9ee57c31 100644 --- a/core/src/main/java/hudson/triggers/Trigger.java +++ b/core/src/main/java/hudson/triggers/Trigger.java @@ -107,11 +107,30 @@ public abstract class Trigger implements Describable> /** * Returns an action object if this {@link Trigger} has an action * to contribute to a {@link Project}. + * + * @deprecated as of 1.341 + * Use {@link #getProjectActions()} instead. */ public Action getProjectAction() { return null; } + /** + * {@link Action}s to be displayed in the job page. + * + * @param job + * This object owns the {@link BuildWrapper}. The returned action will be added to this object. + * @return + * can be empty but never null + * @since 1.341 + */ + public Collection getProjectActions() { + // delegate to getJobAction (singular) for backward compatible behavior + Action a = getProjectAction(); + if (a==null) return Collections.emptyList(); + return Collections.singletonList(a); + } + public TriggerDescriptor getDescriptor() { return (TriggerDescriptor)Hudson.getInstance().getDescriptorOrDie(getClass()); } diff --git a/maven-plugin/src/main/java/hudson/maven/AbstractMavenProject.java b/maven-plugin/src/main/java/hudson/maven/AbstractMavenProject.java index 3fc645dbef..e9b46d54be 100644 --- a/maven-plugin/src/main/java/hudson/maven/AbstractMavenProject.java +++ b/maven-plugin/src/main/java/hudson/maven/AbstractMavenProject.java @@ -72,11 +72,8 @@ public abstract class AbstractMavenProject

,R exte addTransientActionsFromBuild(getLastBuild(),added); addTransientActionsFromBuild(getLastSuccessfulBuild(),added); - for (Trigger trigger : triggers) { - Action a = trigger.getProjectAction(); - if(a!=null) - transientActions.add(a); - } + for (Trigger trigger : triggers) + transientActions.addAll(trigger.getProjectActions()); } } diff --git a/maven-plugin/src/main/java/hudson/maven/MavenBuildProxy.java b/maven-plugin/src/main/java/hudson/maven/MavenBuildProxy.java index 29f20adf9b..059f148590 100644 --- a/maven-plugin/src/main/java/hudson/maven/MavenBuildProxy.java +++ b/maven-plugin/src/main/java/hudson/maven/MavenBuildProxy.java @@ -120,7 +120,7 @@ public interface MavenBuildProxy { /** * Nominates that the reporter will contribute a project action - * for this build by using {@link MavenReporter#getProjectAction(MavenModule)}. + * for this build by using {@link MavenReporter#getProjectActions(MavenModule)}. * *

* The specified {@link MavenReporter} object will be transfered to the master diff --git a/maven-plugin/src/main/java/hudson/maven/MavenModule.java b/maven-plugin/src/main/java/hudson/maven/MavenModule.java index d6ccff333f..86b446c125 100644 --- a/maven-plugin/src/main/java/hudson/maven/MavenModule.java +++ b/maven-plugin/src/main/java/hudson/maven/MavenModule.java @@ -413,9 +413,7 @@ public final class MavenModule extends AbstractMavenProject added) { diff --git a/maven-plugin/src/main/java/hudson/maven/MavenReporter.java b/maven-plugin/src/main/java/hudson/maven/MavenReporter.java index 99726c5714..3fa17a12f7 100644 --- a/maven-plugin/src/main/java/hudson/maven/MavenReporter.java +++ b/maven-plugin/src/main/java/hudson/maven/MavenReporter.java @@ -40,6 +40,8 @@ import org.apache.maven.reporting.MavenReport; import java.io.IOException; import java.io.Serializable; +import java.util.Collection; +import java.util.Collections; /** * Listens to the build execution of {@link MavenBuild}, @@ -261,11 +263,40 @@ public abstract class MavenReporter implements Describable, Exten * * @return * null not to contribute an action, which is the default. + * @deprecated as of 1.341 + * Use {@link #getProjectActions(MavenModule)} instead. */ public Action getProjectAction(MavenModule module) { return null; } + /** + * Equivalent of {@link BuildStep#getProjectActions(AbstractProject)} + * for {@link MavenReporter}. + * + *

+ * Registers a transient action to {@link MavenModule} when it's rendered. + * This is useful if you'd like to display an action at the module level. + * + *

+ * Since this contributes a transient action, the returned {@link Action} + * will not be serialized. + * + *

+ * For this method to be invoked, your {@link MavenReporter} has to invoke + * {@link MavenBuildProxy#registerAsProjectAction(MavenReporter)} during the build. + * + * @return + * can be empty but never null. + * @since 1.341 + */ + public Collection getProjectActions(MavenModule module) { + // delegate to getProjectAction (singular) for backward compatible behavior + Action a = getProjectAction(module); + if (a==null) return Collections.emptyList(); + return Collections.singletonList(a); + } + /** * Works like {@link #getProjectAction(MavenModule)} but * works at {@link MavenModuleSet} level. diff --git a/maven-plugin/src/main/java/hudson/maven/reporters/MavenJavadocArchiver.java b/maven-plugin/src/main/java/hudson/maven/reporters/MavenJavadocArchiver.java index a14c024483..fb86ad7367 100644 --- a/maven-plugin/src/main/java/hudson/maven/reporters/MavenJavadocArchiver.java +++ b/maven-plugin/src/main/java/hudson/maven/reporters/MavenJavadocArchiver.java @@ -42,6 +42,8 @@ import org.codehaus.plexus.component.configurator.ComponentConfigurationExceptio import java.io.File; import java.io.IOException; +import java.util.Collection; +import java.util.Collections; /** * Records the javadoc and archives it. @@ -107,8 +109,8 @@ public class MavenJavadocArchiver extends MavenReporter { return postExecute(build,pom,report,listener,null); } - public Action getProjectAction(MavenModule project) { - return new JavadocAction(project); + public Collection getProjectActions(MavenModule project) { + return Collections.singleton(new JavadocAction(project)); } public Action getAggregatedProjectAction(MavenModuleSet project) { diff --git a/maven-plugin/src/main/java/hudson/maven/reporters/MavenSiteArchiver.java b/maven-plugin/src/main/java/hudson/maven/reporters/MavenSiteArchiver.java index 3342369fa1..6cfa6696e8 100644 --- a/maven-plugin/src/main/java/hudson/maven/reporters/MavenSiteArchiver.java +++ b/maven-plugin/src/main/java/hudson/maven/reporters/MavenSiteArchiver.java @@ -43,6 +43,8 @@ import org.codehaus.plexus.component.configurator.ComponentConfigurationExceptio import java.io.File; import java.io.IOException; +import java.util.Collection; +import java.util.Collections; /** * Watches out for the execution of maven-site-plugin and records its output. @@ -84,8 +86,8 @@ public class MavenSiteArchiver extends MavenReporter { } - public Action getProjectAction(MavenModule project) { - return new SiteAction(project); + public Collection getProjectActions(MavenModule project) { + return Collections.singleton(new SiteAction(project)); } public Action getAggregatedProjectAction(MavenModuleSet project) { diff --git a/maven-plugin/src/main/java/hudson/maven/reporters/SurefireArchiver.java b/maven-plugin/src/main/java/hudson/maven/reporters/SurefireArchiver.java index 79858ba431..c423fbf39e 100644 --- a/maven-plugin/src/main/java/hudson/maven/reporters/SurefireArchiver.java +++ b/maven-plugin/src/main/java/hudson/maven/reporters/SurefireArchiver.java @@ -47,6 +47,8 @@ import org.codehaus.plexus.configuration.xml.XmlPlexusConfiguration; import java.io.File; import java.io.IOException; +import java.util.Collection; +import java.util.Collections; /** * Records the surefire test result. @@ -122,8 +124,8 @@ public class SurefireArchiver extends MavenReporter { } - public Action getProjectAction(MavenModule module) { - return new TestResultProjectAction(module); + public Collection getProjectActions(MavenModule module) { + return Collections.singleton(new TestResultProjectAction(module)); } private boolean isSurefireTest(MojoInfo mojo) {