Package com.cloudbees.jenkins.support

Class SupportAction

java.lang.Object
com.cloudbees.jenkins.support.SupportAction
All Implemented Interfaces:
ExtensionPoint, Action, ModelObject, RootAction, org.kohsuke.stapler.StaplerProxy
@Extension @ExportedBean public class SupportAction extends Object implements RootAction, org.kohsuke.stapler.StaplerProxy
Main root action for generating support.

  • Field Details

  • Constructor Details

    • SupportAction

      public SupportAction()

  • Method Details

    • getTarget

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public Object getTarget()
      Specified by:
      getTarget in interface org.kohsuke.stapler.StaplerProxy

    • 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

    • getActionTitleText

      public String getActionTitleText()

    • getActionTitle

      public org.jvnet.localizer.Localizable getActionTitle()

    • getActionBlurb

      public org.jvnet.localizer.Localizable getActionBlurb()

    • getComponents

      @Exported @WebMethod(name="components") public List<Component> getComponents()

    • getCategorizedComponents

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public Map<Component.ComponentCategory,List<Component>> getCategorizedComponents()

    • getBundles

      public List<String> getBundles()

    • getApi

      public final Api getApi()
      Remote API access.

    • isAnonymized

      public boolean isAnonymized()

    • doDeleteBundles

      public org.kohsuke.stapler.HttpResponse doDeleteBundles(org.kohsuke.stapler.StaplerRequest2 req) throws jakarta.servlet.ServletException
      Throws:
      jakarta.servlet.ServletException

    • doDownloadBundles

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

    • doDownload

      public void doDownload(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) throws jakarta.servlet.ServletException, IOException
      Generates a support bundle with selected components from the UI.
      Parameters:
      req - The stapler request
      rsp - The stapler response
      Throws:
      jakarta.servlet.ServletException - If an error occurred during form submission
      IOException - If an input or output exception occurs

    • doGenerateAllBundles

      public void doGenerateAllBundles(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) throws jakarta.servlet.ServletException, IOException
      Generates a support bundle with selected components from the UI.
      Parameters:
      req - The stapler request
      rsp - The stapler response
      Throws:
      jakarta.servlet.ServletException - If an error occurred during form submission
      IOException - If an input or output exception occurs

    • doGenerateBundleAsync

      public org.kohsuke.stapler.HttpRedirect doGenerateBundleAsync(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) throws jakarta.servlet.ServletException, IOException
      Generates a support bundle with selected components from the UI. in async
      Parameters:
      req - The stapler request
      rsp - The stapler response
      Throws:
      jakarta.servlet.ServletException - If an error occurred during form submission
      IOException - If an input or output exception occurs

    • doGenerateBundle

      public void doGenerateBundle(@QueryParameter("components") String components, org.kohsuke.stapler.StaplerResponse2 rsp) throws IOException
      Generates a support bundle with only requested components.
      Parameters:
      components - component names separated by comma.
      rsp - The stapler response
      Throws:
      IOException - If an input or output exception occurs

    • selectedByDefault

      public boolean selectedByDefault(Component c)

    • getGeneratorByTaskId

      public ProgressiveRendering getGeneratorByTaskId(String taskId) throws Exception
      Throws:
      Exception

    • doDownloadBundle

      public void doDownloadBundle(@QueryParameter("taskId") String taskId, org.kohsuke.stapler.StaplerResponse2 rsp) throws IOException
      Throws:
      IOException