Package jetbrains.buildServer.buildTriggers

Class BuildTriggerService

java.lang.Object

jetbrains.buildServer.buildTriggers.BuildTriggerService

All Implemented Interfaces:

ServerExtension, TeamCityExtension

Direct Known Subclasses:

FinishBuildTriggerService, RemoteRunOnBranchTriggerService, RetryBuildTriggerService, SchedulerBuildTriggerService, UnknownTriggerService, VcsBuildTriggerService

public abstract class BuildTriggerService
extends Object
implements ServerExtension

Represents build trigger service

Since:

5.1

Constructor Summary

Constructors

Constructor	Description
BuildTriggerService()

Method Summary

Modifier and Type	Method	Description
abstract String	describeTrigger(BuildTriggerDescriptor trigger)	Returns human readable description of the provided build trigger settings
abstract BuildTriggeringPolicy	getBuildTriggeringPolicy()	Returns policy used by build trigger to trigger builds.
Map<String,String>	getDefaultTriggerProperties()	Returns default properties to use when trigger is created
abstract String	getDisplayName()	Returns name of this trigger to show in UI.
String	getEditParametersUrl()	Returns path to jsp or to custom controller which will return trigger edit parameters page To resolve paths in plugin, see PluginDescriptor.getPluginResourcesPath(String)
abstract String	getName()	Returns trigger name
PropertiesProcessor	getTriggerPropertiesProcessor()	Returns processor for trigger properties.
boolean	isAvailable(BuildTypeSettings settings)
boolean	isMultipleTriggersPerBuildTypeAllowed()	Returns true if more than one trigger of this type can be added to the build configuration or template.
boolean	supportsBuildCustomization()	Specifies whether this triggers allows users to set custom parameters for triggered builds.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildTriggerService

public BuildTriggerService()

Method Detail

getName

@NotNull
public abstract String getName()

Returns trigger name

Returns:

trigger name

getDisplayName

@NotNull
public abstract String getDisplayName()

Returns name of this trigger to show in UI.

Returns:

see above

describeTrigger

@NotNull
public abstract String describeTrigger(@NotNull
                                       BuildTriggerDescriptor trigger)

Returns human readable description of the provided build trigger settings

Parameters:

trigger - trigger

Returns:

see above

getTriggerPropertiesProcessor

@Nullable
public PropertiesProcessor getTriggerPropertiesProcessor()

Returns processor for trigger properties. Properties processor performs validation function and is called when trigger is edited or created.

Returns:

see above

getEditParametersUrl

@Nullable
public String getEditParametersUrl()

Returns path to jsp or to custom controller which will return trigger edit parameters page To resolve paths in plugin, see PluginDescriptor.getPluginResourcesPath(String)

Returns:

see above

See Also:

PluginDescriptor

getDefaultTriggerProperties

@Nullable
public Map<String,String> getDefaultTriggerProperties()

Returns default properties to use when trigger is created

Returns:

see above

getBuildTriggeringPolicy

@NotNull
public abstract BuildTriggeringPolicy getBuildTriggeringPolicy()

Returns policy used by build trigger to trigger builds.

Returns:

build triggering policy

isMultipleTriggersPerBuildTypeAllowed

public boolean isMultipleTriggersPerBuildTypeAllowed()

Returns true if more than one trigger of this type can be added to the build configuration or template. By default returns false.

Returns:

see above

supportsBuildCustomization

public boolean supportsBuildCustomization()

Specifies whether this triggers allows users to set custom parameters for triggered builds. If the returned value is true then the PolledBuildTrigger.triggerBuild(PolledTriggerContext) should use PolledTriggerContext.createBuildCustomizer(jetbrains.buildServer.users.SUser) to create triggered build promotions.

Since:

2021.1

isAvailable

public boolean isAvailable(BuildTypeSettings settings)

Parameters:

buildTypeSettings -

Returns:

true if this build trigger should be available for configuring a given build type. If false is returned then the build trigger should not appear on the available triggers list.

Since:

2024.07