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
  • Field Details

  • Constructor Details

    • NodeDescriptor

      protected NodeDescriptor(Class<? extends Node> clazz)
    • NodeDescriptor

      protected NodeDescriptor()
  • Method Details

    • 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.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) throws IOException, jakarta.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
      jakarta.servlet.ServletException
    • getConfigPage

      public String getConfigPage()
      Overrides:
      getConfigPage in class Descriptor<Node>
    • doCheckName

      public FormValidation doCheckName(@QueryParameter String value)
    • all

      Returns all the registered NodeDescriptor descriptors.
    • allInstantiable

      public static List<NodeDescriptor> allInstantiable()