Package com.cloudbees.jenkins.support.impl

Class AdvancedProcFilesRetriever

java.lang.Object

com.cloudbees.jenkins.support.api.Component

com.cloudbees.jenkins.support.api.ObjectComponent<Computer>

com.cloudbees.jenkins.support.impl.ProcFilesRetriever

com.cloudbees.jenkins.support.impl.AdvancedProcFilesRetriever

All Implemented Interfaces:

ExtensionPoint, Describable<ObjectComponent<Computer>>

Direct Known Subclasses:

JVMProcessSystemMetricsContents, SystemConfiguration

public abstract class AdvancedProcFilesRetriever
extends ProcFilesRetriever

Base class for gathering specified /proc files with the capacity of selecting whether filter or not each file content. You may want to filter some files and not doing so to other files.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AdvancedProcFilesRetriever.ProcFile	A class to define a file with a name in the bundle and also whether its content should be filtered.

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

Component.ComponentCategory

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
AdvancedProcFilesRetriever()

Method Summary

Modifier and Type	Method	Description
protected void	addUnixContents(Container container, Node node)
Component.ComponentCategory	getCategory()	Specify in which Component.ComponentCategory the current component is related.
Map<String,String>	getFilesToRetrieve()	If you want to use this method, it's best to use ProcFilesRetriever.
abstract Set<AdvancedProcFilesRetriever.ProcFile>	getProcFilesToRetrieve()	The method to define the files to include in the bundle.

Methods inherited from class com.cloudbees.jenkins.support.impl.ProcFilesRetriever

addContents, addContents, afterAddUnixContents, getNodeName, getNodes, getRequiredPermissions, getSystemPlatform, isApplicable

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

allInstances, for_, getDescriptor, isApplicable, isSelectedByDefault

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

AdvancedProcFilesRetriever

public AdvancedProcFilesRetriever()

Method Details

getFilesToRetrieve

@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
public Map<String,String> getFilesToRetrieve()

If you want to use this method, it's best to use ProcFilesRetriever.

Specified by:

getFilesToRetrieve in class ProcFilesRetriever

Returns:

the map of files that should be retrieved and put in the support bundle.

getProcFilesToRetrieve

public abstract Set<AdvancedProcFilesRetriever.ProcFile> getProcFilesToRetrieve()

The method to define the files to include in the bundle. You add AdvancedProcFilesRetriever.ProcFile to be able to specify file by file whether its content should be filtered or not.

Returns:

a set of files to be included in the bundle

addUnixContents

protected void addUnixContents(@NonNull
 Container container,
 @NonNull
 Node node)

Overrides:

addUnixContents in class ProcFilesRetriever

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 ProcFilesRetriever

Returns:

An enum value of Component.ComponentCategory.