Package jetbrains.buildServer.buildFailures

Class BuildFailureOnMetricFeature

java.lang.Object

jetbrains.buildServer.serverSide.BuildFeature

jetbrains.buildServer.buildFailures.BuildFailureOnMetricFeature

All Implemented Interfaces:

ExecutorModeSupport, Describable, PropertiesProcessor, ServerExtension, TeamCityExtension

public class BuildFailureOnMetricFeature
extends BuildFeature
implements PropertiesProcessor

Author:

kir

Nested Class Summary

Nested classes/interfaces inherited from class jetbrains.buildServer.serverSide.BuildFeature

BuildFeature.PlaceToShow

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY

Constructor Summary

Constructors

Constructor	Description
BuildFailureOnMetricFeature(ExtensionHolder extensionHolder, RevisionRuleBuildFinders buildFinders, ExecutorServices executorServices)

Method Summary

Modifier and Type	Method	Description
String	describeParameters(Map<String,String> params)	Returns parameters description of the build feature, will be used in the TeamCity UI to describe this feature settings.
Map<String,String>	getDefaultParameters()
String	getDisplayName()	User presentable name of the feature.
String	getEditParametersUrl()
PropertiesProcessor	getParametersProcessor()	Returns parameters processor which will be used to validate and alter parameters specified by user.
BuildFeature.PlaceToShow	getPlaceToShow()	Return the UI location for build feature settings
String	getType()	Type of the feature, must be unique among all of the features.
boolean	isRequiresAgent()
Collection<InvalidProperty>	process(Map<String,String> properties)	Will be called when user attempts to save properties from the user interface or when runner parameters are used to compute agent compatibility for a build configuration.

Methods inherited from class jetbrains.buildServer.serverSide.BuildFeature

getParametersProcessor, getRequirements, getSupportType, isAvailable, isMultipleFeaturesPerBuildTypeAllowed, isUnchangedBySettingsFreeze

Methods inherited from class java.lang.Object

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

Field Detail

KEY

@NonNls
public static final String KEY

See Also:

Constant Field Values

Constructor Detail

BuildFailureOnMetricFeature

public BuildFailureOnMetricFeature(@NotNull
                                   ExtensionHolder extensionHolder,
                                   @NotNull
                                   RevisionRuleBuildFinders buildFinders,
                                   @NotNull
                                   ExecutorServices executorServices)

Method Detail

getType

@NotNull
public String getType()

Description copied from class: BuildFeature

Type of the feature, must be unique among all of the features.

Specified by:

getType in class BuildFeature

Returns:

type of the feature

getDisplayName

@NotNull
public String getDisplayName()

Description copied from class: BuildFeature

User presentable name of the feature.

Specified by:

getDisplayName in interface Describable

Specified by:

getDisplayName in class BuildFeature

Returns:

name of the feature to show in the user interface.

getEditParametersUrl

public String getEditParametersUrl()

Specified by:

getEditParametersUrl in class BuildFeature

Returns:

absolute path to a JSP file or controller for editing parameters, should not include context path.

getDefaultParameters

public Map<String,String> getDefaultParameters()

Overrides:

getDefaultParameters in class BuildFeature

Returns:

default parameters

getParametersProcessor

public PropertiesProcessor getParametersProcessor()

Description copied from class: BuildFeature

Returns parameters processor which will be used to validate and alter parameters specified by user.

Overrides:

getParametersProcessor in class BuildFeature

Returns:

see above

process

public Collection<InvalidProperty> process(Map<String,String> properties)

Description copied from interface: PropertiesProcessor

Will be called when user attempts to save properties from the user interface or when runner parameters are used to compute agent compatibility for a build configuration.

Properties map passed as argument can be verified or modified by the processor (for example, one could remove all properties with empty values from this map). If processor was called during saving properties to a configuration file, then modified map will be stored without changes.

Specified by:

process in interface PropertiesProcessor

Parameters:

properties - properties to process

Returns:

collection of invalid properties, if this collection is not empty properties will not be saved into the configuration file.

describeParameters

@NotNull
public String describeParameters(@NotNull
                                 Map<String,String> params)

Description copied from class: BuildFeature

Returns parameters description of the build feature, will be used in the TeamCity UI to describe this feature settings.

Overrides:

describeParameters in class BuildFeature

Parameters:

params - parameters to describe

Returns:

short description of parameters.

getPlaceToShow

public BuildFeature.PlaceToShow getPlaceToShow()

Description copied from class: BuildFeature

Return the UI location for build feature settings

Overrides:

getPlaceToShow in class BuildFeature

Returns:

see above

See Also:

BuildFeature.PlaceToShow

isRequiresAgent

public boolean isRequiresAgent()

Overrides:

isRequiresAgent in class BuildFeature

Returns:

true if this build feature has some code which should be executed on the agent during the build. If false is returned then parameters of this feature will not be passed to an agent.