Package com.cloudbees.jenkins.support.impl

Class GCLogs

java.lang.Object

com.cloudbees.jenkins.support.api.Component

com.cloudbees.jenkins.support.impl.GCLogs

All Implemented Interfaces:

ExtensionPoint

@Extension(ordinal=90.0)
public class GCLogs
extends Component

GC Logs Retriever.

Introspects the running VM for -Xloggc:blah.log option and so on to propose including those if found

NOTE: currently only tested on OpenJDK / HotSpot.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	GCLogs.VmArgumentFinder	Isolated code to make it testable

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
GCLogs()

Method Summary

Modifier and Type	Method	Description
void	addContents(Container result)	Add contents to a container
Component.ComponentCategory	getCategory()	Specify in which Component.ComponentCategory the current component is related.
String	getDisplayName()
String	getGcLogFileLocation()
Set<Permission>	getRequiredPermissions()	Returns the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle.
boolean	isFileLocationParameterized(String fileLocation)
boolean	isGcLogRotationConfigured()
boolean	isSelectedByDefault()

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

getDisplayPermissions, getId, isApplicable, isEnabled, start

Methods inherited from class java.lang.Object

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

Constructor Details

GCLogs

public GCLogs()

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.

getDisplayName

@NonNull
public String getDisplayName()

Specified by:

getDisplayName in class Component

addContents

public void addContents(@NonNull
 Container result)

Description copied from class: Component

Add contents to a container

Specified by:

addContents in class Component

Parameters:

result - a Container

isSelectedByDefault

public boolean isSelectedByDefault()

Overrides:

isSelectedByDefault in class Component

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.

getGcLogFileLocation

@CheckForNull
public String getGcLogFileLocation()

isFileLocationParameterized

public boolean isFileLocationParameterized(String fileLocation)

isGcLogRotationConfigured

public boolean isGcLogRotationConfigured()