Package hudson.triggers

Class SCMTrigger.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<Trigger<?>>

hudson.triggers.TriggerDescriptor

hudson.triggers.SCMTrigger.DescriptorImpl

All Implemented Interfaces:

PersistentDescriptor, Saveable, Loadable, OnMaster

Enclosing class:

SCMTrigger

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

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
boolean	synchronousPolling	Whether the projects should be polled all in one go in the order of dependencies.

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
DescriptorImpl()

Method Summary

Modifier and Type	Method	Description
void	clogCheck()	Checks if the queue is clogged, and if so, activate SCMTrigger.AdministrativeMonitorImpl.
boolean	configure(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject json)	Invoked when the global configuration page is submitted.
FormValidation	doCheckPollingThreadCount(String value)
FormValidation	doCheckScmpoll_spec(String value, boolean ignorePostCommitHooks, Item item)	Performs syntax check.
String	getDisplayName()	Human readable name of this kind of configurable object.
ExecutorService	getExecutor()
List<SCMTriggerItem>	getItemsBeingPolled()
int	getPollingThreadCount()	Gets the number of concurrent threads used for polling.
List<SCMTrigger.Runner>	getRunners()	Gets the snapshot of SCMTrigger.Runners that are performing polling.
boolean	isApplicable(Item item)	Returns true if this trigger is applicable to the given Item.
boolean	isClogged()	Returns true if the SCM polling thread queue has too many jobs than it can handle.
boolean	isPollingThreadCountOptionVisible()
void	setPollingThreadCount(int n)	Sets the number of concurrent threads used for SCM polling and resizes the thread pool accordingly

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, 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

Methods inherited from interface hudson.model.PersistentDescriptor

load

Methods inherited from interface hudson.model.Saveable

save

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<?>>

Parameters:

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.