Package com.cloudbees.jenkins.support.api

Class Component

java.lang.Object

com.cloudbees.jenkins.support.api.Component

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

AboutBrowser, AboutJenkins, AboutUser, AdministrativeMonitors, AgentProtocols, BuildQueue, ConfigFileComponent, CustomLogs, EnvironmentVariables, FileDescriptorLimit, FileListCapComponent, GCLogs, HeapUsageHistogram, ItemsContent, JenkinsLogs, LoadStats, LoggerManager, Metrics, NetworkInterfaces, NodeMonitors, ObjectComponent, OtherConfigFilesComponent, OtherLogs, RemotingDiagnostics, ReverseProxy, RootCAs, RunningBuilds, SlaveCommandStatistics, SlaveLogs, SystemProperties, TaskLogs, UnfilteredFileListCapComponent, UpdateCenter

@ExportedBean
public abstract class Component
extends Object
implements ExtensionPoint

Represents a component of a support bundle.

This is the unit of user consent; when creating a support bundle, the user would enable/disable individual components.

Author:

Stephen Connolly

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Component.ComponentCategory	Categories supported by this version of support-core

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
Component()

Method Summary

Modifier and Type	Method	Description
abstract void	addContents(Container container)	Add contents to a container
Component.ComponentCategory	getCategory()	Specify in which Component.ComponentCategory the current component is related.
abstract String	getDisplayName()
String	getDisplayPermissions()
String	getId()	Returns the component id.
abstract Set<Permission>	getRequiredPermissions()	Returns the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle.
<C extends AbstractModelObject> boolean	isApplicable(Class<C> clazz)	Return if this component is applicable to a specific class of item.
boolean	isEnabled()	Returns true if the current authentication can include this component in a bundle.
boolean	isSelectedByDefault()
void	start(SupportContext context)	Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

Component

public Component()

Method Detail

getRequiredPermissions

@NonNull
public abstract Set<Permission> getRequiredPermissions()

Returns the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle. An empty list indicates that any user can include this bundle.

Returns:

the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle.

getDisplayPermissions

public String getDisplayPermissions()

isEnabled

@Exported
public boolean isEnabled()

Returns true if the current authentication can include this component in a bundle.

Returns:

true if the current authentication can include this component in a bundle.

isSelectedByDefault

@Exported
public boolean isSelectedByDefault()

isApplicable

public <C extends AbstractModelObject> boolean isApplicable(Class<C> clazz)

Return if this component is applicable to a specific class of item.

Type Parameters:

C - Object that extends AbstractModelObject

Parameters:

clazz - the class

Returns:

true if applicable to this class

getDisplayName

@NonNull
@Exported
public abstract String getDisplayName()

addContents

public abstract void addContents(@NonNull
                                 Container container)

Add contents to a container

Parameters:

container - a Container

getId

@Exported
@NonNull
public String getId()

Returns the component id.

Returns:

by default, the Class.getSimpleName() of the component implementation.

start

@Deprecated
public void start(@NonNull
                  SupportContext context)

Deprecated.

getCategory

@Exported
@NonNull
public Component.ComponentCategory getCategory()

Specify in which Component.ComponentCategory the current component is related.

Returns:

An enum value of Component.ComponentCategory.

Since:

TODO