Class ConsoleExplainErrorAction

java.lang.Object
io.jenkins.plugins.explain_error.ConsoleExplainErrorAction
All Implemented Interfaces:
Action, ModelObject

public class ConsoleExplainErrorAction extends Object implements Action
Action to add "Explain Error" functionality to console output pages. This action needs to be manually added to builds.
  • Constructor Details

    • ConsoleExplainErrorAction

      public ConsoleExplainErrorAction(Run<?,?> run)
  • Method Details

    • getIconFileName

      public String getIconFileName()
      Specified by:
      getIconFileName in interface Action
    • getDisplayName

      public String getDisplayName()
      Specified by:
      getDisplayName in interface Action
      Specified by:
      getDisplayName in interface ModelObject
    • getUrlName

      public String getUrlName()
      Specified by:
      getUrlName in interface Action
    • doExplainConsoleError

      public void doExplainConsoleError(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) throws javax.servlet.ServletException, IOException
      AJAX endpoint to explain error from console output. Called via JavaScript from the console output page.
      Throws:
      javax.servlet.ServletException
      IOException
    • doCheckExistingExplanation

      public void doCheckExistingExplanation(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) throws javax.servlet.ServletException, IOException
      AJAX endpoint to check if an explanation already exists. Returns JSON with hasExplanation boolean and timestamp if it exists.
      Throws:
      javax.servlet.ServletException
      IOException
    • getRun

      public Run<?,?> getRun()