Class SCMTrigger.DescriptorImpl

All Implemented Interfaces:
PersistentDescriptor, Saveable, Loadable, OnMaster
Enclosing class:
SCMTrigger

@Extension @Symbol("pollSCM") public static class SCMTrigger.DescriptorImpl extends TriggerDescriptor implements PersistentDescriptor
  • Field Details

    • synchronousPolling

      public boolean synchronousPolling
      Whether the projects should be polled all in one go in the order of dependencies. The default behavior is that each project polls for changes independently.
  • Constructor Details

    • DescriptorImpl

      public DescriptorImpl()
  • Method Details

    • isApplicable

      public boolean isApplicable(Item item)
      Description copied from class: TriggerDescriptor
      Returns true if this trigger is applicable to the given Item.
      Specified by:
      isApplicable in class TriggerDescriptor
      Returns:
      true to allow user to configure a trigger for this item.
    • getExecutor

      public ExecutorService getExecutor()
    • isClogged

      public boolean isClogged()
      Returns true if the SCM polling thread queue has too many jobs than it can handle.
    • clogCheck

      public void clogCheck()
      Checks if the queue is clogged, and if so, activate SCMTrigger.AdministrativeMonitorImpl.
    • getRunners

      public List<SCMTrigger.Runner> getRunners()
      Gets the snapshot of SCMTrigger.Runners that are performing polling.
    • getItemsBeingPolled

      public List<SCMTriggerItem> getItemsBeingPolled()
    • getDisplayName

      @NonNull public String getDisplayName()
      Description copied from class: Descriptor
      Human readable name of this kind of configurable object. Should be overridden for most descriptors, if the display name is visible somehow. As a fallback it uses Class.getSimpleName() on Descriptor.clazz, so for example MyThing from some.pkg.MyThing.DescriptorImpl. Historically some implementations returned null as a way of hiding the descriptor from the UI, but this is generally managed by an explicit method such as isEnabled or isApplicable.
      Overrides:
      getDisplayName in class Descriptor<Trigger<?>>
    • getPollingThreadCount

      public int getPollingThreadCount()
      Gets the number of concurrent threads used for polling.
    • setPollingThreadCount

      public void setPollingThreadCount(int n)
      Sets the number of concurrent threads used for SCM polling and resizes the thread pool accordingly
      Parameters:
      n - number of concurrent threads in the range 5..100, outside values will set the to the nearest bound
    • isPollingThreadCountOptionVisible

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public boolean isPollingThreadCountOptionVisible()
    • configure

      public boolean configure(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject json) throws Descriptor.FormException
      Description copied from class: Descriptor
      Invoked when the global configuration page is submitted. Can be overridden to store descriptor-specific information.
      Overrides:
      configure in class Descriptor<Trigger<?>>
      json - The JSON object that captures the configuration data for this Descriptor. See the developer documentation.
      Returns:
      false to keep the client in the same config page.
      Throws:
      Descriptor.FormException
    • doCheckPollingThreadCount

      public FormValidation doCheckPollingThreadCount(@QueryParameter String value)
    • doCheckScmpoll_spec

      public FormValidation doCheckScmpoll_spec(@QueryParameter String value, @QueryParameter boolean ignorePostCommitHooks, @AncestorInPath Item item)
      Performs syntax check.