Package hudson.model

Class ComputerSet

java.lang.Object
hudson.model.AbstractModelObject
hudson.model.ComputerSet
All Implemented Interfaces:
Describable<ComputerSet>, ModelObject, SearchableModelObject, SearchItem, ModelObjectWithChildren, HasWidgets
@ExportedBean public final class ComputerSet extends AbstractModelObject implements Describable<ComputerSet>, ModelObjectWithChildren, HasWidgets
Serves as the top of Computers in the URL hierarchy.

Getter methods are prefixed with '_' to avoid collision with computer names.

Author:
Kohsuke Kawaguchi

  • Constructor Details

    • ComputerSet

      public ComputerSet()

  • Method Details

    • getDisplayName

      @Exported public String getDisplayName()
      Specified by:
      getDisplayName in interface ModelObject

    • get_monitors

      @Deprecated public static List<NodeMonitor> get_monitors()
      Deprecated.
      as of 1.301 Use getMonitors().

    • get_all

      @Deprecated(since="2.480") public Computer[] get_all()
      Deprecated.
      Use getComputers() instead.
      Returns:
      All Computer instances managed by this set.

    • getComputers

      @Exported(name="computer", inline=true) public Collection<? extends IComputer> getComputers()
      Returns:
      All IComputer instances managed by this set, sorted by name.

    • doChildrenContextMenu

      public ModelObjectWithContextMenu.ContextMenu doChildrenContextMenu(org.kohsuke.stapler.StaplerRequest2 request, org.kohsuke.stapler.StaplerResponse2 response) throws Exception
      Description copied from interface: ModelObjectWithChildren
      Generates the context menu to list up all the children.
      Specified by:
      doChildrenContextMenu in interface ModelObjectWithChildren
      Throws:
      Exception

    • getNodeMonitorDescriptors

      public DescriptorExtensionList<NodeMonitor,Descriptor<NodeMonitor>> getNodeMonitorDescriptors()
      Exposing NodeMonitor.all() for Jelly binding.

    • getMonitors

      public static DescribableList<NodeMonitor,Descriptor<NodeMonitor>> getMonitors()

    • getNonIgnoredMonitors

      public static Map<Descriptor<NodeMonitor>,NodeMonitor> getNonIgnoredMonitors()
      Returns a subset pf getMonitors() that are not ignored.

    • get_slaveNames

      public List<String> get_slaveNames()
      Gets all the agent names.

    • getTotalExecutors

      @Exported public int getTotalExecutors()
      Number of total Executors that belong to this label that are functioning.

      This excludes executors that belong to offline nodes.

    • getBusyExecutors

      @Exported public int getBusyExecutors()
      Number of busy Executors that are carrying out some work right now.

    • getIdleExecutors

      public int getIdleExecutors()
      getTotalExecutors()-getBusyExecutors(), plus executors that are being brought online.

    • getSearchUrl

      public String getSearchUrl()
      Description copied from interface: SearchItem
      Returns the URL of this item relative to the parent SearchItem.
      Specified by:
      getSearchUrl in interface SearchItem
      Returns:
      URL like "foo" or "foo/bar". The path can end with '/'. The path that starts with '/' will be interpreted as the absolute path (within the context path of Jenkins.)

    • getDynamic

      public Computer getDynamic(String token, org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)

    • do_launchAll

      public void do_launchAll(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) throws IOException
      Throws:
      IOException

    • doUpdateNow

      public void doUpdateNow(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) throws IOException, jakarta.servlet.ServletException
      Triggers the schedule update now. TODO: ajax on the client side to wait until the update completion might be nice.
      Throws:
      IOException
      jakarta.servlet.ServletException

    • doCreateItem

      public void doCreateItem(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, @QueryParameter String name, @QueryParameter String mode, @QueryParameter String from) throws IOException, jakarta.servlet.ServletException
      First check point in creating a new agent.
      Throws:
      IOException
      jakarta.servlet.ServletException

    • doDoCreateItem

      @POST public void doDoCreateItem(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, @QueryParameter String name, @QueryParameter String type) throws IOException, jakarta.servlet.ServletException, Descriptor.FormException
      Really creates a new agent.
      Throws:
      IOException
      jakarta.servlet.ServletException
      Descriptor.FormException

    • checkName

      public String checkName(String name) throws Failure
      Makes sure that the given name is good as an agent name.
      Returns:
      trimmed name if valid; throws ParseException if not
      Throws:
      Failure

    • doCheckName

      public FormValidation doCheckName(@QueryParameter String value) throws IOException, jakarta.servlet.ServletException
      Makes sure that the given name is good as an agent name.
      Throws:
      IOException
      jakarta.servlet.ServletException

    • doConfigSubmit

      @POST public org.kohsuke.stapler.HttpResponse doConfigSubmit(org.kohsuke.stapler.StaplerRequest2 req) throws IOException, jakarta.servlet.ServletException, Descriptor.FormException
      Accepts submission from the configuration page.
      Throws:
      IOException
      jakarta.servlet.ServletException
      Descriptor.FormException

    • getApi

      public Api getApi()

    • getDescriptor

      public Descriptor<ComputerSet> getDescriptor()
      Description copied from interface: Describable
      Gets the descriptor for this instance.

      Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

      Specified by:
      getDescriptor in interface Describable<ComputerSet>

    • initialize

      public static void initialize()
      Just to force the execution of the static initializer.

    • init

      @Initializer(after=JOB_CONFIG_ADAPTED) public static void init()

    • getComputerNames

      @NonNull public static List<String> getComputerNames()
      Returns:
      The list of strings of computer names (excluding master)
      Since:
      2.14