Class VcsBuildTriggerService
- java.lang.Object
 - 
- jetbrains.buildServer.buildTriggers.BuildTriggerService
 - 
- jetbrains.buildServer.buildTriggers.vcs.VcsBuildTriggerService
 
 
 
- 
- All Implemented Interfaces:
 ServerExtension,TeamCityExtension
public class VcsBuildTriggerService extends BuildTriggerService
- Author:
 - Pavel.Sher
 
 
- 
- 
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVcsBuildTriggerService.QuietPeriodMode 
- 
Field Summary
Fields Modifier and Type Field Description static StringENABLE_QUEUE_OPTIMIZATION_PARAMstatic StringMERGED_BRANCHES_THRESHOLD_PARAMstatic StringTRIGGER_NAMEstatic StringTRIGGER_RULES_PARAMstatic StringVCS_TRIGGER_BRANCH_MAX_CHANGE_AGE_PARAMstatic StringVCS_TRIGGER_RUN_BUILD_ON_SAME_REVISION_IN_EVERY_BRANCH_PARAMstatic StringWATCH_CHANGES_IN_DEPENDENCIES_PARAM 
- 
Constructor Summary
Constructors Constructor Description VcsBuildTriggerService(VcsTriggeringContext triggeringContext) 
- 
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringdescribeTrigger(BuildTriggerDescriptor trigger)Returns human readable description of the provided build trigger settingsBuildTriggeringPolicygetBuildTriggeringPolicy()Returns policy used by build trigger to trigger builds.Map<String,String>getDefaultTriggerProperties()Returns default properties to use when trigger is createdStringgetDisplayName()Returns name of this trigger to show in UI.StringgetEditParametersUrl()Returns path to jsp or to custom controller which will return trigger edit parameters page To resolve paths in plugin, seePluginDescriptor.getPluginResourcesPath(String)StringgetName()Returns trigger namePropertiesProcessorgetTriggerPropertiesProcessor()Returns processor for trigger properties.booleanisMultipleTriggersPerBuildTypeAllowed()Returns true if more than one trigger of this type can be added to the build configuration or template.voidsetTimeService(TimeService timeService)booleansupportsBuildCustomization()Specifies whether this triggers allows users to set custom parameters for triggered builds.- 
Methods inherited from class jetbrains.buildServer.buildTriggers.BuildTriggerService
isAvailable 
 - 
 
 - 
 
- 
- 
Field Detail
- 
VCS_TRIGGER_BRANCH_MAX_CHANGE_AGE_PARAM
public static final String VCS_TRIGGER_BRANCH_MAX_CHANGE_AGE_PARAM
- See Also:
 - Constant Field Values
 
 
- 
VCS_TRIGGER_RUN_BUILD_ON_SAME_REVISION_IN_EVERY_BRANCH_PARAM
public static final String VCS_TRIGGER_RUN_BUILD_ON_SAME_REVISION_IN_EVERY_BRANCH_PARAM
- See Also:
 - Constant Field Values
 
 
- 
MERGED_BRANCHES_THRESHOLD_PARAM
public static final String MERGED_BRANCHES_THRESHOLD_PARAM
- See Also:
 - Constant Field Values
 
 
- 
ENABLE_QUEUE_OPTIMIZATION_PARAM
public static final String ENABLE_QUEUE_OPTIMIZATION_PARAM
- See Also:
 - Constant Field Values
 
 
- 
TRIGGER_NAME
public static final String TRIGGER_NAME
- See Also:
 - Constant Field Values
 
 
- 
TRIGGER_RULES_PARAM
public static final String TRIGGER_RULES_PARAM
- See Also:
 - Constant Field Values
 
 
- 
WATCH_CHANGES_IN_DEPENDENCIES_PARAM
public static final String WATCH_CHANGES_IN_DEPENDENCIES_PARAM
- See Also:
 - Constant Field Values
 
 
 - 
 
- 
Constructor Detail
- 
VcsBuildTriggerService
public VcsBuildTriggerService(@NotNull VcsTriggeringContext triggeringContext) 
 - 
 
- 
Method Detail
- 
setTimeService
public void setTimeService(TimeService timeService)
 
- 
getName
@NotNull public String getName()
Description copied from class:BuildTriggerServiceReturns trigger name- Specified by:
 getNamein classBuildTriggerService- Returns:
 - trigger name
 
 
- 
getDisplayName
@NotNull public String getDisplayName()
Description copied from class:BuildTriggerServiceReturns name of this trigger to show in UI.- Specified by:
 getDisplayNamein classBuildTriggerService- Returns:
 - see above
 
 
- 
describeTrigger
@NotNull public String describeTrigger(@NotNull BuildTriggerDescriptor trigger)
Description copied from class:BuildTriggerServiceReturns human readable description of the provided build trigger settings- Specified by:
 describeTriggerin classBuildTriggerService- Parameters:
 trigger- trigger- Returns:
 - see above
 
 
- 
getEditParametersUrl
public String getEditParametersUrl()
Description copied from class:BuildTriggerServiceReturns path to jsp or to custom controller which will return trigger edit parameters page To resolve paths in plugin, seePluginDescriptor.getPluginResourcesPath(String)- Overrides:
 getEditParametersUrlin classBuildTriggerService- Returns:
 - see above
 - See Also:
 PluginDescriptor
 
- 
getDefaultTriggerProperties
public Map<String,String> getDefaultTriggerProperties()
Description copied from class:BuildTriggerServiceReturns default properties to use when trigger is created- Overrides:
 getDefaultTriggerPropertiesin classBuildTriggerService- Returns:
 - see above
 
 
- 
getTriggerPropertiesProcessor
public PropertiesProcessor getTriggerPropertiesProcessor()
Description copied from class:BuildTriggerServiceReturns processor for trigger properties. Properties processor performs validation function and is called when trigger is edited or created.- Overrides:
 getTriggerPropertiesProcessorin classBuildTriggerService- Returns:
 - see above
 
 
- 
getBuildTriggeringPolicy
@NotNull public BuildTriggeringPolicy getBuildTriggeringPolicy()
Description copied from class:BuildTriggerServiceReturns policy used by build trigger to trigger builds.- Specified by:
 getBuildTriggeringPolicyin classBuildTriggerService- Returns:
 - build triggering policy
 
 
- 
isMultipleTriggersPerBuildTypeAllowed
public boolean isMultipleTriggersPerBuildTypeAllowed()
Description copied from class:BuildTriggerServiceReturns true if more than one trigger of this type can be added to the build configuration or template. By default returns false.- Overrides:
 isMultipleTriggersPerBuildTypeAllowedin classBuildTriggerService- Returns:
 - see above
 
 
- 
supportsBuildCustomization
public boolean supportsBuildCustomization()
Description copied from class:BuildTriggerServiceSpecifies whether this triggers allows users to set custom parameters for triggered builds. If the returned value is true then thePolledBuildTrigger.triggerBuild(PolledTriggerContext)should usePolledTriggerContext.createBuildCustomizer(jetbrains.buildServer.users.SUser)to create triggered build promotions.- Overrides:
 supportsBuildCustomizationin classBuildTriggerService
 
 - 
 
 -