Package jp.ikedam.jenkins.plugins.scoringloadbalancer

Class ScoringLoadBalancer.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<ScoringLoadBalancer>

jp.ikedam.jenkins.plugins.scoringloadbalancer.ScoringLoadBalancer.DescriptorImpl

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Enclosing class:

ScoringLoadBalancer

@Extension
@Symbol("scoringLoadBalancer")
public static class ScoringLoadBalancer.DescriptorImpl
extends Descriptor<ScoringLoadBalancer>

Descriptor for ScoringLoadBalancer Manages views and holds configuration for ScoringLoadBalancer.

Nested Class Summary

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

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
DescriptorImpl()	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	configure(boolean enabled, boolean reportScoresEnabled, boolean simultaneousBuildsWorkaroundEnabled, int simultaneousBuildsWorkaroundThrottleTime, List<ScoringRule> scoringRuleList)	Used for testing purpose.
boolean	configure(boolean enabled, boolean reportScoresEnabled, boolean simultaneousBuildsWorkaroundEnabled, int simultaneousBuildsWorkaroundThrottleTime, ScoringRule... scoringRules)	Used for testing purpose.
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)	Update and store configuration.
DescriptorExtensionList<ScoringRule,Descriptor<ScoringRule>>	getAllScoringRuleList()	Returns all ScoringRules registered to Jenkins.
String	getDisplayName()	Returns the name to display.
List<ScoringRule>	getScoringRuleList()	Returns the list of enabled scoring rules.
int	getSimultaneousBuildsWorkaroundThrottleTime()	Returns the throttle time of the workaround for simultaneous builds, which only allows a single build to start within the amount of milliseconds that is returned by this method.
boolean	isEnabled()	Returns whether ScoringLoadBalancer is enabled
boolean	isReportScoresEnabled()	Returns whether to log scores of nodes in each load balancing calculation.
boolean	isSimultaneousBuildsWorkaroundEnabled()	Returns whether to enable the workaround for simultaneous builds, which throttles builds / only allows a single build to start within a certain time.
void	setEnabled(boolean enabled)
void	setReportScoresEnabled(boolean reportScoresEnabled)
void	setScoringRuleList(List<ScoringRule> scoringRuleList)
void	setSimultaneousBuildsWorkaroundEnabled(boolean simultaneousBuildsWorkaroundEnabled)
void	setSimultaneousBuildsWorkaroundThrottleTime(int simultaneousBuildsWorkaroundThrottleTime)

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

Constructor Details

DescriptorImpl

public DescriptorImpl()

Constructor. Restore configurations.

Method Details

isEnabled

public boolean isEnabled()

Returns whether ScoringLoadBalancer is enabled

Returns:

whether ScoringLoadBalancer is enabled

isReportScoresEnabled

public boolean isReportScoresEnabled()

Returns whether to log scores of nodes in each load balancing calculation. Enabling this makes many outputs, and not good for production environments.

Returns:

whether to log scores of nodes

isSimultaneousBuildsWorkaroundEnabled

public boolean isSimultaneousBuildsWorkaroundEnabled()

Returns whether to enable the workaround for simultaneous builds, which throttles builds / only allows a single build to start within a certain time.

Returns:

whether to enable the workaround and throttle builds.

getSimultaneousBuildsWorkaroundThrottleTime

public int getSimultaneousBuildsWorkaroundThrottleTime()

Returns the throttle time of the workaround for simultaneous builds, which only allows a single build to start within the amount of milliseconds that is returned by this method.

Returns:

the throttle time in milliseconds of the workaround.

getScoringRuleList

public List<ScoringRule> getScoringRuleList()

Returns the list of enabled scoring rules.

Returns:

the enabled scoring rules.

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
 net.sf.json.JSONObject json)
                  throws Descriptor.FormException

Update and store configuration.

Overrides:

configure in class Descriptor<ScoringLoadBalancer>

Parameters:

req -

json -

Returns:

Throws:

Descriptor.FormException

See Also:

• Descriptor.configure(org.kohsuke.stapler.StaplerRequest, net.sf.json.JSONObject)

configure

public boolean configure(boolean enabled,
 boolean reportScoresEnabled,
 boolean simultaneousBuildsWorkaroundEnabled,
 int simultaneousBuildsWorkaroundThrottleTime,
 List<ScoringRule> scoringRuleList)

Used for testing purpose.

Parameters:

enabled -

reportScoresEnabled -

simultaneousBuildsWorkaroundEnabled -

simultaneousBuildsWorkaroundThrottleTime -

scoringRuleList -

Returns:

configure

public boolean configure(boolean enabled,
 boolean reportScoresEnabled,
 boolean simultaneousBuildsWorkaroundEnabled,
 int simultaneousBuildsWorkaroundThrottleTime,
 ScoringRule... scoringRules)

Used for testing purpose.

Parameters:

enabled -

reportScoresEnabled -

simultaneousBuildsWorkaroundEnabled -

simultaneousBuildsWorkaroundThrottleTime -

scoringRules -

Returns:

setEnabled

@DataBoundSetter
public void setEnabled(boolean enabled)

setReportScoresEnabled

@DataBoundSetter
public void setReportScoresEnabled(boolean reportScoresEnabled)

setSimultaneousBuildsWorkaroundEnabled

@DataBoundSetter
public void setSimultaneousBuildsWorkaroundEnabled(boolean simultaneousBuildsWorkaroundEnabled)

setSimultaneousBuildsWorkaroundThrottleTime

@DataBoundSetter
public void setSimultaneousBuildsWorkaroundThrottleTime(int simultaneousBuildsWorkaroundThrottleTime)

setScoringRuleList

@DataBoundSetter
public void setScoringRuleList(List<ScoringRule> scoringRuleList)

getDisplayName

public String getDisplayName()

Returns the name to display. Displayed in System Configuration page as a section title.

Overrides:

getDisplayName in class Descriptor<ScoringLoadBalancer>

Returns:

the name to display

See Also:

• Descriptor.getDisplayName()

getAllScoringRuleList

public DescriptorExtensionList<ScoringRule,Descriptor<ScoringRule>> getAllScoringRuleList()

Returns all ScoringRules registered to Jenkins.

Returns:

list of Descriptor of ScoringRules.