Package hudson.slaves

Class NodeDescriptor

java.lang.Object

hudson.model.Descriptor<Node>

hudson.slaves.NodeDescriptor

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Direct Known Subclasses:

Jenkins.DescriptorImpl, Slave.SlaveDescriptor

public abstract class NodeDescriptor
extends Descriptor<Node>

Descriptor for Slave.

Views

This object needs to have newInstanceDetail.jelly view, which shows up in http://server/hudson/computers/new page as an explanation of this job type.

Other Implementation Notes

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields

Modifier and Type	Field	Description
static DescriptorList<Node>	ALL	Deprecated. as of 1.286 Use all() for read access, and Extension for registration.

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NodeDescriptor()
protected	NodeDescriptor(Class<? extends Node> clazz)

Method Summary

Modifier and Type	Method	Description
static DescriptorExtensionList<Node,NodeDescriptor>	all()	Returns all the registered NodeDescriptor descriptors.
static List<NodeDescriptor>	allInstantiable()
FormValidation	doCheckName(String value)
String	getConfigPage()
void	handleNewNodePage(ComputerSet computerSet, String name, org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)	Handles the form submission from the "/computer/new" page, which is the first form for creating a new node.
boolean	isInstantiable()	Can the administrator create this type of nodes from UI? Return false if it only makes sense for programs to create it, not through the "new node" UI.
String	newInstanceDetailPage()

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Field Detail

ALL

@Deprecated
public static final DescriptorList<Node> ALL

Deprecated.

as of 1.286 Use all() for read access, and Extension for registration.

All the registered instances.

Constructor Detail

NodeDescriptor

protected NodeDescriptor(Class<? extends Node> clazz)

NodeDescriptor

protected NodeDescriptor()

Method Detail

isInstantiable

public boolean isInstantiable()

Can the administrator create this type of nodes from UI? Return false if it only makes sense for programs to create it, not through the "new node" UI.

newInstanceDetailPage

public final String newInstanceDetailPage()

handleNewNodePage

public void handleNewNodePage(ComputerSet computerSet,
                              String name,
                              org.kohsuke.stapler.StaplerRequest req,
                              org.kohsuke.stapler.StaplerResponse rsp)
                       throws IOException,
                              javax.servlet.ServletException

Handles the form submission from the "/computer/new" page, which is the first form for creating a new node. By default, it shows the configuration page for entering details, but subtypes can override this differently.

Parameters:

name - Name of the new node.

Throws:

IOException

javax.servlet.ServletException

getConfigPage

public String getConfigPage()

Overrides:

getConfigPage in class Descriptor<Node>

doCheckName

public FormValidation doCheckName(@QueryParameter
                                  String value)

all

public static DescriptorExtensionList<Node,NodeDescriptor> all()

Returns all the registered NodeDescriptor descriptors.

allInstantiable

public static List<NodeDescriptor> allInstantiable()