Package com.cloudbees.jenkins.support.actions

Class SupportObjectAction<T extends AbstractModelObject>

java.lang.Object

com.cloudbees.jenkins.support.actions.SupportObjectAction<T>

Type Parameters:

T - The type of AbstractModelObject

All Implemented Interfaces:

Action, ModelObject

Direct Known Subclasses:

SupportAbstractItemAction, SupportComputerAction, SupportRunAction

public abstract class SupportObjectAction<T extends AbstractModelObject>
extends Object
implements Action

Support Action at Object level.

Constructor Summary

Constructors

Constructor	Description
SupportObjectAction(T object)

Method Summary

Modifier and Type	Method	Description
final void	doGenerateAndDownload(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
org.jvnet.localizer.Localizable	getActionBlurb()
org.jvnet.localizer.Localizable	getActionTitle()
List<ObjectComponentDescriptor<T>>	getApplicableComponentsDescriptors()
protected String	getBundleNameQualifier()
List<? extends ObjectComponent<T>>	getComponents()
Map<ObjectComponentDescriptor<T>,ObjectComponent<T>>	getDefaultComponentsDescriptors()
String	getIconFileName()
final T	getObject()
String	getUrlName()
protected final List<ObjectComponent<T>>	parseRequest(org.kohsuke.stapler.StaplerRequest2 req)	Parse the stapler JSON output and retrieve configured components.
void	setComponents(List<? extends ObjectComponent<T>> components)

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Action

getDisplayName

Constructor Details

SupportObjectAction

public SupportObjectAction(@NonNull
 T object)

Method Details

getObject

@NonNull
public final T getObject()

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getBundleNameQualifier

protected String getBundleNameQualifier()

setComponents

@DataBoundSetter
public void setComponents(List<? extends ObjectComponent<T>> components)

getActionTitle

public org.jvnet.localizer.Localizable getActionTitle()

getActionBlurb

public org.jvnet.localizer.Localizable getActionBlurb()

getComponents

public List<? extends ObjectComponent<T>> getComponents()

getApplicableComponentsDescriptors

public List<ObjectComponentDescriptor<T>> getApplicableComponentsDescriptors()

getDefaultComponentsDescriptors

public Map<ObjectComponentDescriptor<T>,ObjectComponent<T>> getDefaultComponentsDescriptors()

doGenerateAndDownload

public final void doGenerateAndDownload(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                                 throws jakarta.servlet.ServletException,
IOException,
Descriptor.FormException

Throws:

jakarta.servlet.ServletException

IOException

Descriptor.FormException

parseRequest

protected final List<ObjectComponent<T>> parseRequest(org.kohsuke.stapler.StaplerRequest2 req)
                                               throws jakarta.servlet.ServletException,
Descriptor.FormException

Parse the stapler JSON output and retrieve configured components.

Parameters:

req - the request

Returns:

the DescribableList of components

Throws:

jakarta.servlet.ServletException

Descriptor.FormException