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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SupportAction.Selection

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static Permission	CREATE_BUNDLE	Deprecated. see SupportPlugin.CREATE_BUNDLE

Constructor Summary

Constructors

Constructor	Description
SupportAction()

Method Summary

Modifier and Type	Method	Description
void	doDeleteBundles(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
void	doDownload(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)	Generates a support bundle with selected components from the UI.
void	doDownloadBundles(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
void	doGenerateAllBundles(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)	Generates a support bundle with selected components from the UI.
void	doGenerateBundle(String components, org.kohsuke.stapler.StaplerResponse rsp)	Generates a support bundle with only requested components.
org.jvnet.localizer.Localizable	getActionBlurb()
org.jvnet.localizer.Localizable	getActionTitle()
String	getActionTitleText()
Api	getApi()	Remote API access.
List<String>	getBundles()
Map<Component.ComponentCategory,List<Component>>	getCategorizedComponents()
List<Component>	getComponents()
String	getDisplayName()
String	getIconFileName()
Object	getTarget()
String	getUrlName()
boolean	isAnonymized()
boolean	selectedByDefault(Component c)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CREATE_BUNDLE

@Deprecated
public static final Permission CREATE_BUNDLE

Deprecated.

see SupportPlugin.CREATE_BUNDLE

Constructor Detail

SupportAction

public SupportAction()

Method Detail

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 void doDeleteBundles(org.kohsuke.stapler.StaplerRequest req,
                            org.kohsuke.stapler.StaplerResponse rsp)
                     throws javax.servlet.ServletException,
                            IOException

Throws:

javax.servlet.ServletException

IOException

doDownloadBundles

public void doDownloadBundles(org.kohsuke.stapler.StaplerRequest req,
                              org.kohsuke.stapler.StaplerResponse rsp)
                       throws javax.servlet.ServletException,
                              IOException

Throws:

javax.servlet.ServletException

IOException

doDownload

public void doDownload(org.kohsuke.stapler.StaplerRequest req,
                       org.kohsuke.stapler.StaplerResponse rsp)
                throws javax.servlet.ServletException,
                       IOException

Generates a support bundle with selected components from the UI.

Parameters:

req - The stapler request

rsp - The stapler response

Throws:

javax.servlet.ServletException - If an error occurred during form submission

IOException - If an input or output exception occurs

doGenerateAllBundles

public void doGenerateAllBundles(org.kohsuke.stapler.StaplerRequest req,
                                 org.kohsuke.stapler.StaplerResponse rsp)
                          throws javax.servlet.ServletException,
                                 IOException

Generates a support bundle with selected components from the UI.

Parameters:

req - The stapler request

rsp - The stapler response

Throws:

javax.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.StaplerResponse 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)