Package com.cloudbees.jenkins.support.configfiles

Class AgentsConfigFile

java.lang.Object

com.cloudbees.jenkins.support.api.Component

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

com.cloudbees.jenkins.support.configfiles.AgentsConfigFile

All Implemented Interfaces:

ExtensionPoint, Describable<ObjectComponent<Computer>>

@Extension
public class AgentsConfigFile
extends ObjectComponent<Computer>

Adds nodes config.xml files to the bundle. Any secret string is redacted in the xml file. Unselected by default.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AgentsConfigFile.DescriptorImpl

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

Method Summary

Modifier and Type	Method	Description
void	addContents(Container container)	Add contents to a container
void	addContents(Container container, Computer item)	Add contents from a specific item to a container
Component.ComponentCategory	getCategory()	Specify in which Component.ComponentCategory the current component is related.
AgentsConfigFile.DescriptorImpl	getDescriptor()
String	getDisplayName()
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	isApplicable(Computer item)	Return if this component is applicable to a specific item.
<C extends AbstractModelObject> boolean	isApplicable(Class<C> clazz)	Return if this component is applicable to a specific class of item.
boolean	isSelectedByDefault()
boolean	isSelectedByDefault(Computer item)	Control if the component should be selected by default, based on the applicable item

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

allInstances, for_

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

getDisplayPermissions, getId, isEnabled, start

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentsConfigFile

@DataBoundConstructor
public AgentsConfigFile()

Method Detail

isSelectedByDefault

public boolean isSelectedByDefault()

Overrides:

isSelectedByDefault in class Component

isSelectedByDefault

public boolean isSelectedByDefault(Computer item)

Description copied from class: ObjectComponent

Control if the component should be selected by default, based on the applicable item

Overrides:

isSelectedByDefault in class ObjectComponent<Computer>

Parameters:

item - the item

Returns:

true to select the component by default

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.

getDisplayName

@NonNull
public String getDisplayName()

Specified by:

getDisplayName in class Component

addContents

public void addContents(@NonNull
                        Container container)

Description copied from class: ObjectComponent

Add contents to a container

Overrides:

addContents in class ObjectComponent<Computer>

Parameters:

container - a Container

addContents

public void addContents(@NonNull
                        Container container,
                        Computer item)

Description copied from class: ObjectComponent

Add contents from a specific item to a container

Specified by:

addContents in class ObjectComponent<Computer>

Parameters:

container - the Container

item - the item

isApplicable

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

Description copied from class: ObjectComponent

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

Overrides:

isApplicable in class ObjectComponent<Computer>

Type Parameters:

C - Object that extends AbstractModelObject

Parameters:

clazz - the class

Returns:

true if applicable to this class

isApplicable

public boolean isApplicable(Computer item)

Description copied from class: ObjectComponent

Return if this component is applicable to a specific item.

Overrides:

isApplicable in class ObjectComponent<Computer>

Parameters:

item - the item

Returns:

true if applicable

getDescriptor

public AgentsConfigFile.DescriptorImpl getDescriptor()

Description copied from class: ObjectComponent

Specified by:

getDescriptor in interface Describable<ObjectComponent<Computer>>

Overrides:

getDescriptor in class ObjectComponent<Computer>