Package jetbrains.buildServer.controllers.admin.projects

Class BuildRunnerBean

java.lang.Object

jetbrains.buildServer.controllers.RememberState

jetbrains.buildServer.controllers.admin.projects.BuildRunnerBean

All Implemented Interfaces:

StatefulObject

public class BuildRunnerBean
extends RememberState

Holds build runner properties when a build configuration is being edited on the web

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BuildRunnerBean.ExecutionPolicyValue	ExecutionPolicyValue bean

Constructor Summary

Constructors

Constructor	Description
BuildRunnerBean(String id, String runTypeInfoKey, Map<String,String> properties, AvailableBuildRunners availableRunners)	Constructor for new build runner
BuildRunnerBean(SBuildRunnerDescriptor runnerDescriptor, AvailableBuildRunners availableRunners, String inheritedFrom, boolean isEnforced, boolean overridden, boolean enabled)	Constructor for existing build runner

Method Summary

Modifier and Type	Method	Description
Collection<String>	getAvailableRunnerExtensionUrls()
Map<BuildRunnerGroup,List<RunTypeData>>	getAvailableRunTypes()
String	getBuildStepName()	Returns name of the build runner step
String	getDeprecationReason()
String	getDeprecationReference()
String	getDisplayName()	Returns build step name if it exists, or display name of runner
String	getId()	Returns unique identifier of this build runner bean
String	getInheritedFrom()
String	getNewRunnerId()
RunnerPropertiesBean	getPropertiesBean()	Returns bean containing properties of the currently selected build runner
RunType	getRunType()
String	getRunTypeInfoKey()	Returns type of the currently selected runner
RunTypeWithExtensions	getRunTypeWithExtensions()
BuildRunnerBean.ExecutionPolicyValue	getSelectedExecutionPolicy()
RunTypeData	getSelectedRunType()
String	getShortDescription()
String	getStepExecutionPolicyKey()
Collection<BuildRunnerBean.ExecutionPolicyValue>	getStepExecutionPolicyValues()
String	getUsedStepIdsString()
boolean	isAllowIdEditing()
boolean	isBootstrapStep()
boolean	isEnabled()
boolean	isEnforced()
boolean	isIdEditingFeatureEnabled()
boolean	isInherited()
boolean	isNewRunner()	Returns true if this bean represents new build runner (not yet created).
boolean	isOverridden()
boolean	isRunnerTypeSelected()	Returns true if type of the runner is selected
boolean	isRunTypeAvailable(String runTypeInfoKey)
boolean	isStateModified()	Returns true if state of this bean is modified
void	setBuildStepName(String buildStepName)	Sets name of the build runner step
void	setExistingRunners(List<SBuildRunnerDescriptor> buildRunners)
void	setNewRunnerId(String newRunnerId)
void	setRunTypeInfoKey(String runTypeInfoKey)	Selects new runner

Methods inherited from class jetbrains.buildServer.controllers.RememberState

findField, forgetState, getField, getRememberedState, isFieldModified, normalizeLineFeeds, rememberState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BuildRunnerBean

public BuildRunnerBean(@NotNull
                       String id,
                       @NotNull
                       String runTypeInfoKey,
                       @Nullable
                       Map<String,String> properties,
                       @NotNull
                       AvailableBuildRunners availableRunners)

Constructor for new build runner

Parameters:

runTypeInfoKey - run type key

BuildRunnerBean

public BuildRunnerBean(@NotNull
                       SBuildRunnerDescriptor runnerDescriptor,
                       @NotNull
                       AvailableBuildRunners availableRunners,
                       String inheritedFrom,
                       boolean isEnforced,
                       boolean overridden,
                       boolean enabled)

Constructor for existing build runner

Parameters:

runnerDescriptor - build runner descriptor

availableRunners - available runners

enabled - enabled

Method Detail

isIdEditingFeatureEnabled

public boolean isIdEditingFeatureEnabled()

isAllowIdEditing

public boolean isAllowIdEditing()

getId

@NotNull
public String getId()

Returns unique identifier of this build runner bean

Returns:

see above

isNewRunner

public boolean isNewRunner()

Returns true if this bean represents new build runner (not yet created).

Returns:

see above

getRunTypeInfoKey

public String getRunTypeInfoKey()

Returns type of the currently selected runner

Returns:

type of the currently selected runner

isRunnerTypeSelected

public boolean isRunnerTypeSelected()

Returns true if type of the runner is selected

Returns:

see above

Since:

6.0

getBuildStepName

public String getBuildStepName()

Returns name of the build runner step

Returns:

build runner step name

getDisplayName

public String getDisplayName()

Returns build step name if it exists, or display name of runner

Returns:

build step name if it exists

getNewRunnerId

@NotNull
public String getNewRunnerId()

isBootstrapStep

public boolean isBootstrapStep()

setBuildStepName

public void setBuildStepName(String buildStepName)

Sets name of the build runner step

setNewRunnerId

public void setNewRunnerId(@NotNull
                           String newRunnerId)

setRunTypeInfoKey

public void setRunTypeInfoKey(String runTypeInfoKey)

Selects new runner

Parameters:

runTypeInfoKey - new runner type

getUsedStepIdsString

public String getUsedStepIdsString()

getAvailableRunTypes

@NotNull
public Map<BuildRunnerGroup,List<RunTypeData>> getAvailableRunTypes()

getSelectedRunType

@NotNull
public RunTypeData getSelectedRunType()

getRunType

@NotNull
public RunType getRunType()

getRunTypeWithExtensions

@Nullable
public RunTypeWithExtensions getRunTypeWithExtensions()

getShortDescription

@NotNull
public String getShortDescription()

isInherited

public boolean isInherited()

Returns:

true if this runner is inherited from template

isEnforced

public boolean isEnforced()

Returns:

true if this runner is inherited from enforced template

getInheritedFrom

public String getInheritedFrom()

Returns:

template full name if inherited from a template, null otherwise

isOverridden

public boolean isOverridden()

Returns:

true if this runner is inherited from template, but overridden in the configuration

Since:

2017.2

isEnabled

public boolean isEnabled()

Returns:

true if this runner is enabled

Since:

7.0

isRunTypeAvailable

public boolean isRunTypeAvailable(String runTypeInfoKey)

getStepExecutionPolicyKey

@NotNull
public String getStepExecutionPolicyKey()

Returns:

runner parameter name for build policy

Since:

7.1

getStepExecutionPolicyValues

@NotNull
public Collection<BuildRunnerBean.ExecutionPolicyValue> getStepExecutionPolicyValues()

Returns:

all possible values for step execution policy

Since:

7.1

getSelectedExecutionPolicy

@NotNull
public BuildRunnerBean.ExecutionPolicyValue getSelectedExecutionPolicy()

getPropertiesBean

public RunnerPropertiesBean getPropertiesBean()

Returns bean containing properties of the currently selected build runner

Returns:

bean containing properties of the currently selected build runner

getDeprecationReason

@NotNull
public String getDeprecationReason()

getDeprecationReference

@NotNull
public String getDeprecationReference()

getAvailableRunnerExtensionUrls

@NotNull
public Collection<String> getAvailableRunnerExtensionUrls()

isStateModified

public boolean isStateModified()

Returns true if state of this bean is modified

Specified by:

isStateModified in interface StatefulObject

Overrides:

isStateModified in class RememberState

Returns:

true if state of this bean is modified

setExistingRunners

public void setExistingRunners(@NotNull
                               List<SBuildRunnerDescriptor> buildRunners)