Package com.cloudbees.jenkins.support.timer

Class FileListCapComponent

java.lang.Object

com.cloudbees.jenkins.support.api.Component

com.cloudbees.jenkins.support.timer.FileListCapComponent

All Implemented Interfaces:

ExtensionPoint

public abstract class FileListCapComponent
extends Component

Component that attaches files inside FileListCap into a support bundle.

Author:

stevenchristou

Nested Class Summary

Nested classes/interfaces inherited from class com.cloudbees.jenkins.support.api.Component

Component.ComponentCategory

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_FILE_SIZE	Maximum file size to pack is 2Mb.
static final long	MAX_LOG_FILE_AGE_MS	Maximum age (in milliseconds) of log files we would bother including in a bundle.

Constructor Summary

Constructors

Constructor	Description
FileListCapComponent()

Method Summary

Modifier and Type	Method	Description
void	addContents(Container container, FileListCap fileListCap)
Component.ComponentCategory	getCategory()	Specify in which Component.ComponentCategory the current component is related.
Set<Permission>	getRequiredPermissions()	Returns the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle.

Methods inherited from class com.cloudbees.jenkins.support.api.Component

addContents, canBeGeneratedAsync, getDisplayName, getDisplayPermissions, getId, isApplicable, isEnabled, isSelectedByDefault, start, supersedes

Methods inherited from class java.lang.Object

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

Field Details

MAX_FILE_SIZE

public static final int MAX_FILE_SIZE

Maximum file size to pack is 2Mb.

See Also:

• Constant Field Values

MAX_LOG_FILE_AGE_MS

public static final long MAX_LOG_FILE_AGE_MS

Maximum age (in milliseconds) of log files we would bother including in a bundle. Anything older is likely no longer relevant.

Constructor Details

FileListCapComponent

public FileListCapComponent()

Method Details

getRequiredPermissions

@NonNull
public Set<Permission> getRequiredPermissions()

Description copied from class: Component

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.

Specified by:

getRequiredPermissions in class Component

Returns:

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

getCategory

@NonNull
public Component.ComponentCategory getCategory()

Description copied from class: Component

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

Overrides:

getCategory in class Component

Returns:

An enum value of Component.ComponentCategory.

addContents

public void addContents(@NonNull
 Container container,
 FileListCap fileListCap)