Package hudson.scm

Class AbstractScmTagAction

java.lang.Object
hudson.model.AbstractModelObject
hudson.model.TaskAction
hudson.scm.AbstractScmTagAction
All Implemented Interfaces:
Action, BuildBadgeAction, ModelObject, SearchableModelObject, SearchItem, RunAction2
public abstract class AbstractScmTagAction extends TaskAction implements BuildBadgeAction, RunAction2
Common part of CVSSCM.TagAction and SubversionTagAction.

This class implements the action that tags the modules. Derived classes need to provide tagForm.jelly view that displays a form for letting user start tagging.

Author:
Kohsuke Kawaguchi

  • Field Details

  • Constructor Details

    • AbstractScmTagAction

      protected AbstractScmTagAction(Run<?,?> run)
      Since:
      1.568

    • AbstractScmTagAction

      @Deprecated protected AbstractScmTagAction(AbstractBuild build)
      Deprecated.

  • Method Details

    • getUrlName

      public final 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:

    • getPermission

      protected Permission getPermission()
      Defaults to SCM.TAG.
      Specified by:
      getPermission in class TaskAction

    • getRun

      public Run<?,?> getRun()
      Since:
      1.568

    • getBuild

      @Deprecated public AbstractBuild getBuild()
      Deprecated.

    • getTooltip

      public String getTooltip()
      This message is shown as the tool tip of the build badge icon.

    • isTagged

      public abstract boolean isTagged()
      Returns true if the build is tagged already.

    • getACL

      protected ACL getACL()
      Description copied from class: TaskAction
      Gets the ACL against which TaskAction.getPermission() is checked.
      Specified by:
      getACL in class TaskAction

    • doIndex

      public void doIndex(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) throws IOException, jakarta.servlet.ServletException
      Throws:
      IOException
      jakarta.servlet.ServletException

    • doIndex

      @Deprecated @StaplerNotDispatchable public void doIndex(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) throws IOException, javax.servlet.ServletException
      Deprecated.
      use doIndex(StaplerRequest2, StaplerResponse2)
      Throws:
      IOException
      javax.servlet.ServletException

    • chooseAction

      protected String chooseAction()

    • onAttached

      public void onAttached(Run<?,?> r)
      Description copied from interface: RunAction2
      Called when this action is added to a build.
      Specified by:
      onAttached in interface RunAction2

    • onLoad

      public void onLoad(Run<?,?> r)
      Description copied from interface: RunAction2
      Called after a build is loaded to which this action was previously attached.
      Specified by:
      onLoad in interface RunAction2