Class BuildTypeSettingsImpl
- java.lang.Object
-
- jetbrains.buildServer.serverSide.impl.BuildTypeSettingsImpl
-
- All Implemented Interfaces:
BuildTypeOptions,BuildTypeOwnSettings,BuildTypeSettings,BuildTypeSettingsEx,CleanupSettings,CleanupSettingsInit,CompatibleAgents,DependencySettings,BuildTypeSettingsSupport,ParameterSupport,InheritableUserParametersHolder,InheritableUserParametersHolderEx,InternalParameters,ReadOnlyUserParameters,UserParametersHolder,VcsLabelingSettings,OptionSupport
public class BuildTypeSettingsImpl extends Object implements BuildTypeSettingsEx, BuildTypeSettingsSupport
- Author:
- Pavel.Sher
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static classBuildTypeSettingsImpl.HasNameButNotIdFilter-
Nested classes/interfaces inherited from interface jetbrains.buildServer.serverSide.BuildTypeOptions
BuildTypeOptions.BuildConfigurationType
-
Nested classes/interfaces inherited from interface jetbrains.buildServer.serverSide.vcs.VcsLabelingSettings
VcsLabelingSettings.LabelingType
-
-
Field Summary
Fields Modifier and Type Field Description static StringDUPLICATE_ID_ERROR_MESSAGEprotected BuildTypeSettingsContextmyContextstatic StringTEAMCITY_BUILD_AGENT_LESS_PARAM-
Fields inherited from interface jetbrains.buildServer.serverSide.BuildTypeOptions
BT_ALLOW_EXTERNAL_STATUS, BT_ALLOW_PERSONAL_BUILD_TRIGGERING, BT_ARTIFACT_PUBLISH_CONDITION, BT_ARTIFACT_RULES, BT_BRANCH_FILTER, BT_BUILD_CONFIGURATION_TYPE, BT_BUILD_DEFAULT_BRANCH, BT_BUILD_NUMBER_PATTERN, BT_CHECKOUT_DIR, BT_CHECKOUT_MODE, BT_CLEAN_BUILD, BT_EXCLUDE_DEFAULT_BRANCH_CHANGES, BT_EXECUTION_TIMEOUT, BT_FAIL_IF_TESTS_FAIL, BT_FAIL_ON_ANY_ERROR_MESSAGE, BT_FAIL_ON_EXIT_CODE, BT_FAIL_ON_OOME_OR_CRASH, BT_GENERATED_SETTINGS_CHECKSUM, BT_HANGING_BUILDS_DETECTION_ENABLED, BT_MAX_RUNNING_BUILDS, BT_MAX_RUNNING_BUILDS_PER_BRANCH, BT_SHOW_DEPS_CHANGES, BT_SUPPORT_TEST_RETRY, DEFAULT_BUILD_NUMBER_PATTERN, DEFAULT_MAX_RUNNING_BUILDS_PER_BRANCH, DEFAULT_VCS_LABELING_BRANCH_FILTER, VCS_LABELING_BRANCH_FILTER
-
Fields inherited from interface jetbrains.buildServer.serverSide.CleanupSettings
CLEANUP_PREVENT_DEPENDENCIES_ARTIFACTS_FROM_CLEANUP, DISABLE_CLEANUP_POLICIES
-
Fields inherited from interface jetbrains.buildServer.serverSide.vcs.VcsLabelingSettings
DEFAULT_LABEL_PATTERN
-
-
Constructor Summary
Constructors Constructor Description BuildTypeSettingsImpl(ProjectEx project, BuildTypeSettingsContext context, TemplatesHolder templatesHolder, ProjectHolder projectHolder, ContainerFactory containerFactory, OptionSpecParser specParser, EventDispatcher<BuildTypeSettingsListener> dispatcher)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddArtifactDependency(SArtifactDependency dependency)Adds artifact dependency.SBuildFeatureDescriptoraddBuildFeature(String type, Map<String,String> params)Adds build feature with specified type and parameters to this settings object.voidaddBuildFeature(SBuildFeatureDescriptor feature)Adds build feature descriptor to this settings object.voidaddBuildParameter(Parameter parameter)Adds build parameter to the configuration.SBuildRunnerDescriptoraddBuildRunner(String id, String name, String runnerType, Map<String,String> parameters)Creates a new build runner with the specified id, name, runner type, and parameters, and adds it to the current build settings.SBuildRunnerDescriptoraddBuildRunner(String name, String runnerType, Map<String,String> parameters)Creates new build runner and adds it to these settings.SBuildRunnerDescriptoraddBuildRunner(BuildRunnerDescriptor runner)Adds runner descriptor.BuildTriggerDescriptoraddBuildTrigger(String type, Map<String,String> params)Adds new trigger of specified type and with specified parameters to build configuration settings.booleanaddBuildTrigger(BuildTriggerDescriptor triggerDescriptor)Adds new trigger to build configuration settings.voidaddCleanupPolicy(HistoryRetentionPolicy policy)Sets cleanup policy for this build configurationvoidaddConfigParameter(Parameter param)Adds configuration parameter.voidaddDependency(Dependency dependOn)Add dependency on another build configurationvoidaddListener(BuildTypeSettingsListener listener)voidaddListener(BuildTypeSettingsListener listener, boolean delayPropagation)Adds listener to the build type settings and all settings of the attached templatesvoidaddParameter(Parameter param)Adds parameter.voidaddRequirement(Requirement requirement)Adds new build requirement to the configuration.voidaddRunParameter(SBuildRunnerDescriptor runner, Parameter parameter)booleanaddVcsRoot(SVcsRoot root)Adds VCS root to the build configuration with default checkout rules.voidapplyRunnersOrder(String[] ids)Accepts array of runner identifiers and reorders them according to this array.voidapplyRunnersOrder(String[] ids, boolean alwaysSetCustom)Apply custom order of build stepsvoidattachedToModel(ProjectDataModel model)booleancontainsOwnVcsRoot(long vcsRootId)Returns true if VCS root with specified id is attached directly and is not inherited via a templatebooleancontainsVcsRoot(long vcsRootId)Returns true if VCS root with specified id is attached directly or is inherited via a templatevoidcopyAllSettings(BuildTypeSettingsEx settingsSource)Copies all settings, the behaviour is the same as copySettings with empty copyOptions, i.e.voidcopyOverridableSettings(BuildTypeSettingsEx settingsSource)voidcopyOwnSettings(BuildTypeSettingsEx settingsSource)Deprecated.voidcopySettings(BuildTypeSettingsEx source, BuildTypeCopySettings copyOptions)Copies settings, parameters, options etc.BuildTypeSettingsExcreateCopy()ParametersProvidercreateParametersProvider(SBuild build)ReadOnlyBuildTypeSettingscreateReadOnlySettings()voiddispose()static <T extends BuildRunnerDescriptor>
List<T>doApplyRunnersOrder(String[] newOrderIds, Collection<T> _currentRunners)SBuildFeatureDescriptorfindBuildFeatureById(String featureId)Returns build feature with specified idSBuildRunnerDescriptorfindBuildRunnerById(String runnerId)Finds build runner by its' idSBuildRunnerDescriptorfindBuildRunnerByType(String runnerType)Finds build runner by its' type.StringfindRunnerParameter(String paramName)Searches runner parameter in all build runners and returns value of the first found parameter with given name.BuildTriggerDescriptorfindTriggerById(String triggerId)Finds build trigger descriptor by its' idCompatibilityResultgetAgentCompatibility(AgentDescription agentDescription)Fetches compatibility information for given agent descriptionList<SArtifactDependency>getArtifactDependencies()Returns artifacts this build configuration depending on.StringgetArtifactPaths()Returns build artifact paths.List<Requirement>getBuildFeatureRequirements()Returns list of additional agent requirements imposed by configured enabled build features.Collection<SBuildFeatureDescriptor>getBuildFeatures()Returns build features added to this settings object.Collection<SBuildFeatureDescriptor>getBuildFeaturesOfType(String type)Returns all build features of specified type.ContainerWithDisabled<String,SBuildFeatureDescriptor>getBuildFeatureSupport()StringgetBuildNumberPattern()Returns current build number patternStringgetBuildParameter(String key)Returns build parameter by parameter keyMap<String,String>getBuildParameters()Return map of build parameters specified by user.Collection<Parameter>getBuildParametersCollection()Returns build parameters collection.List<SBuildRunnerDescriptor>getBuildRunners()Returns collection of build runners attached to these settingsContainerWithDisabled<String,SBuildRunnerDescriptor>getBuildRunnerSupport()BuildSettingsgetBuildSettings()Collection<BuildTriggerDescriptor>getBuildTriggersCollection()Returns collection of build trigger settingsContainerWithDisabled<String,BuildTriggerDescriptor>getBuildTriggersSupport()BranchFiltergetBuildTypeBranchFilter(ValueResolver valueResolver)BranchFiltergetBuildTypeBranchFilterUnsafe(ValueResolver valueResolver)Same asBuildTypeSettingsEx.getBuildTypeBranchFilter(ValueResolver)but throws an exception if the filter is incorrectOption[]getChangedOptions()Return options with changed values, i.e.StringgetCheckoutDirectory()Returns build checkout directory - if specified explicitly usingBuildTypeSettings.setCheckoutDirectory(String).CheckoutRulesgetCheckoutRules(VcsRoot root)Returns checkout rules configured for the specified VCS root.BuildTypeDescriptor.CheckoutTypegetCheckoutType()Returns method used by agent to retrieve project sources.Map<String,Boolean>getCleanupOptions()Collection<HistoryRetentionPolicy>getCleanupPolicies()Map<SBuildAgent,CompatibilityResult>getCompatibilityMap()Returns compatibility map, key is an agent and value is compatibility result.Collection<SBuildAgent>getCompatibleAgents()Returns collection of compatible agentsMap<String,String>getConfigParameters()Returns map of configuration parametersCollection<Parameter>getConfigParametersCollection()Returns collection of configuration parameters.List<Dependency>getDependencies()Get existing dependencies, empty collection when no dependencies existDependencyOptionsgetDependencyOptions(SBuildType buildType)Collection<String>getDisabledParameterDescriptorIds()Container<String,Boolean>getDisabledState()List<Requirement>getImplicitRequirements()Get list of non-satisfied implicit requirements for build agents.Map<String,Boolean>getInheritedCleanupOptions()Collection<HistoryRetentionPolicy>getInheritedCleanupPolicies()Collection<Parameter>getInheritedParametersCollection()List<VcsRoot>getLabelingRoots()List of roots which should be processed by labeling processVcsLabelingSettings.LabelingTypegetLabelingType()StringgetLabelPattern()<T> TgetOption(Option<T> option)Get option value<T> TgetOptionDefaultValue(Option<T> option)Collection<Option>getOptions()ContainerWithInherited<Option<Object>,OptionValue<Object>>getOptionSupport()List<SArtifactDependency>getOwnArtifactDependencies()List<SBuildFeatureDescriptor>getOwnBuildFeatures()List<SBuildRunnerDescriptor>getOwnBuildRunners()List<BuildTriggerDescriptor>getOwnBuildTriggers()Map<String,Boolean>getOwnCleanupOptions()Collection<HistoryRetentionPolicy>getOwnCleanupPolicies()CleanupSettingsSupportgetOwnCleanupSupport()List<Dependency>getOwnDependencies()Collection<String>getOwnDisabledParameterDescriptorIds()ParametergetOwnNonInheritedParameter(String paramName)Own parameter without inherited parameter spec.Collection<Option>getOwnOptions()Return options defined in this object, i.e.OptionSupportExgetOwnOptionSupport()ParametergetOwnParameter(String paramName)Map<String,String>getOwnParameters()Collection<Parameter>getOwnParametersCollection()Collection<Parameter>getOwnParametersWithoutInheritedSpec()List<Requirement>getOwnRequirements()Collection<String>getOwnRunnerTypes()SerializableParametersCollectiongetOwnSerializableParameters()List<String>getOwnTemplateExternalIds()List<String>getOwnTemplateIds()List<BuildTypeTemplateEx>getOwnTemplates()List<VcsRootEntry>getOwnVcsRootEntries()ParametergetParameter(String paramName)Map<String,Boolean>getParameterDescriptorState()Map<String,String>getParameters()Returns map of build and configuration parameters.Collection<Parameter>getParametersCollection()Returns build and configuration parameters in single collection.ParametersProvidergetParametersProvider()ContainerWithInherited<String,Parameter>getParametersSupport()StringgetParameterValue(String paramName)ProjectExgetProject()Returns the project this build type entity belongs to.ReadOnlyReasongetReadOnlyReason()List<Requirement>getRequirements()Get list of explicit requirements for build agents which can run this build configuration.ContainerWithDisabled<String,Requirement>getRequirementSupport()BuildStepConditionsgetRunnerConditions(SBuildRunnerDescriptor descriptor)String[]getRunnersOrder()Collection<String>getRunnerTypes()Returns types of the runners attached to these settingsList<Requirement>getRunTypeRequirements()Returns list of additional agent requirements imposed by configured runners.SecureDataStoragegetSecureDataStorage()BuildTypeTemplateExgetTemplate()Deprecated.StringgetTemplateExternalId()Deprecated.StringgetTemplateId()Deprecated.List<String>getTemplateIds()Returns internal ids of the templates this settings are based on, including one of the default templateList<BuildTypeTemplateEx>getTemplates()Returns templates these settings are based on, including the default template.<T> TypedValue<T>getTypedOption(Option<T> option)Get option extended value.List<String>getUndefinedParameters()Returns collection of parameter names (config and build params) referenced in the build configuration settings but without values provided.List<VcsRootEntry>getVcsRootEntries()Returns all entries of vcs roots.List<SVcsRoot>getVcsRoots()Returns all roots currently attached to this configurationbooleanisAgentLessBuildType()booleanisCompositeBuildType()booleanisDeployment()booleanisEnabled(String paramsDescriptorId)Returns true if descriptor with specified id (runner, trigger or build feature) is enabled and false otherwise.booleanisReadOnly()booleanisTemplateAccessible()Checks accessibility of all attached templates, excluding the default template (if present)booleanisTemplateBased()Returns true if these settings are directly based on a template.voidpersist()Persists these settings.voidpersist(ConfigAction cause)voidremoveAllBuildRunners()Removes all build runners from these settingsvoidremoveArtifactDependency(SArtifactDependency dependency)Removes artifact dependency.SBuildFeatureDescriptorremoveBuildFeature(String featureId)Removes build feature with specified id from this settings object.voidremoveBuildParameter(String paramName)Removes existing build parameter by its name.SBuildRunnerDescriptorremoveBuildRunner(String runnerId)Removes runner descriptor with specified id.booleanremoveBuildTrigger(BuildTriggerDescriptor triggerDescriptor)Removes specified build trigger from the settingsvoidremoveCleanupPolicies()Remove all own cleanup policies for the objectvoidremoveConfigParameter(String paramName)Removes configuration parameters with specified namebooleanremoveDependency(Dependency dependOn)Remove dependency on another build configurationvoidremoveListener(BuildTypeSettingsListener listener)voidremoveParameter(String paramName)Removes parameter.voidremoveRequirement(String propertyName)Removes first requirement with the specified property name from the configuration.voidremoveRequirement(Requirement req)Removes a requirement from the configuration.booleanremoveVcsRoot(SVcsRoot root)Removes existing VCS root from the build configuration.voidreplaceDependency(SArtifactDependency origDep, SArtifactDependency newDep)Replaces original dependency object with another onevoidreplaceDependency(Dependency orig, Dependency newDep)Replaces original dependency object with another onebooleanreplaceInValues(String regexp, String replacement)Replaces values according to specified regexp and replacement string in all text parameters of the build configurationbooleanreplaceInValues(Pattern regexpPattern, String replacement)Replaces values according to specified pattern and replacement string in all text parameters of the build configurationbooleanreplaceVcsRoot(SVcsRoot oldVcsRoot, SVcsRoot newVcsRoot)Replaces existing VCS root entry in settings with a new one, maintaining the order of the root entriesvoidresetRunnersOrder()Resets custom runner order to default.voidsetArtifactDependencies(List<SArtifactDependency> artifactDeps)Sets artifacts this build configuration depending on.voidsetArtifactPaths(String artifactPaths)Sets build artifact paths.voidsetBuildNumberPattern(String pattern)Sets build number pattern.voidsetCheckoutDirectory(String checkoutDirectory)Sets build checkout directory.booleansetCheckoutRules(VcsRoot root, CheckoutRules rules)Sets checkout rules for specified VCS root.voidsetCheckoutType(BuildTypeDescriptor.CheckoutType checkoutType)Sets preferred checkout type for the configuration sources.voidsetCleanupOption(String option, Boolean value)Sets value for a cleanup optionvoidsetEnabled(String paramsDescriptorId, boolean enabled)Enables or disables descriptor with specified id in build configuration settings.<T> voidsetOption(Option<T> option, T value)Set option value, clears value if it is the same as defaultvoidsetParametersSupport(ParametersSupport paramsSupport)voidsetProject(ProjectEx project)Sets new project to settings objectvoidsetSecureDataStorage(SecureDataStorage secureDataStorage)Sets secure data storage to be used by these settings when they are persisted on disk.voidsetTemplateIds(List<String> templateIds)Change which templates these settings are attached to.voidsetTemplatesOrder(List<String> templateIds)Imposes new order on the associated templates.booleansetVcsRoots(Collection<SVcsRoot> vcsRoots)Sets VCS roots.booleantextValueMatches(Pattern regexpPattern)Returns true if configuration has value in text parameters which matches specified pattern.booleanupdateBuildFeature(String featureId, String type, Map<String,String> parameters)Updates build feature descriptor with specified id, changes type and parameters.booleanupdateBuildRunner(String runnerId, String name, String type, Map<String,String> params)Updates parameters in the existing build runner descriptor.booleanupdateBuildTrigger(String triggerId, String newType, Map<String,String> newParams)Updates build trigger descriptor with specified id, changes type and parameters.booleanupdateBuildTrigger(BuildTriggerDescriptor newDescriptor)Updates build trigger descriptor with id equal to newDescriptor id.booleanvcsRootsAccessibleInProject(SProject project)-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface jetbrains.buildServer.serverSide.BuildTypeSettingsEx
getDeclaredOption
-
Methods inherited from interface jetbrains.buildServer.serverSide.InheritableUserParametersHolderEx
getOwnAndParentsNonInheritedParameter, getOwnAndParentsNonInheritedParameters
-
Methods inherited from interface jetbrains.buildServer.serverSide.InternalParameters
getBooleanInternalParameter, getBooleanInternalParameterOrTrue, getInternalParameterValue
-
-
-
-
Field Detail
-
TEAMCITY_BUILD_AGENT_LESS_PARAM
public static final String TEAMCITY_BUILD_AGENT_LESS_PARAM
- See Also:
- Constant Field Values
-
DUPLICATE_ID_ERROR_MESSAGE
public static final String DUPLICATE_ID_ERROR_MESSAGE
- See Also:
- Constant Field Values
-
myContext
@NotNull protected final BuildTypeSettingsContext myContext
-
-
Constructor Detail
-
BuildTypeSettingsImpl
public BuildTypeSettingsImpl(@NotNull ProjectEx project, @NotNull BuildTypeSettingsContext context, @NotNull TemplatesHolder templatesHolder, @NotNull ProjectHolder projectHolder, @NotNull ContainerFactory containerFactory, @NotNull OptionSpecParser specParser, @NotNull EventDispatcher<BuildTypeSettingsListener> dispatcher)
-
-
Method Detail
-
addVcsRoot
public boolean addVcsRoot(@NotNull SVcsRoot root) throws InvalidVcsRootScopeException, VcsRootNotFoundExceptionDescription copied from interface:BuildTypeSettingsAdds VCS root to the build configuration with default checkout rules.- Specified by:
addVcsRootin interfaceBuildTypeSettings- Parameters:
root- VCS root to add- Returns:
- true if VCS root was actually added and false otherwise (this VCS root already exists)
- Throws:
InvalidVcsRootScopeException- if VCS root scope is local and corresponds to another project (not the project - owner of this build configuration)VcsRootNotFoundException- if specified VCS root does not exist anymore
-
replaceVcsRoot
public boolean replaceVcsRoot(@NotNull SVcsRoot oldVcsRoot, @NotNull SVcsRoot newVcsRoot)Description copied from interface:BuildTypeSettingsExReplaces existing VCS root entry in settings with a new one, maintaining the order of the root entries- Specified by:
replaceVcsRootin interfaceBuildTypeSettingsEx- Parameters:
oldVcsRoot- VCS root to be replacednewVcsRoot- VCS root to insert instead- Returns:
- true if VCS root was actually replaced, false otherwise (the root to be replaced did not exist or the new root already existed)
-
setVcsRoots
public boolean setVcsRoots(@NotNull Collection<SVcsRoot> vcsRoots)Description copied from interface:BuildTypeSettingsExSets VCS roots. All existing VCS roots that are not present in vcsRoots are deleted, all other existing VCS roots are reordered if necessary, but retain their original checkout rules.- Specified by:
setVcsRootsin interfaceBuildTypeSettingsEx- Returns:
- true if any changes occured
-
setArtifactDependencies
public void setArtifactDependencies(@NotNull List<SArtifactDependency> artifactDeps)Description copied from interface:BuildTypeSettingsSets artifacts this build configuration depending on.- Specified by:
setArtifactDependenciesin interfaceBuildTypeSettings- Parameters:
artifactDeps- new artifacts dependency list.
-
addArtifactDependency
public void addArtifactDependency(@NotNull SArtifactDependency dependency)Description copied from interface:BuildTypeSettingsAdds artifact dependency.- Specified by:
addArtifactDependencyin interfaceBuildTypeSettings- Parameters:
dependency- new artifact dependency
-
addDependency
public void addDependency(@NotNull Dependency dependOn)Description copied from interface:DependencySettingsAdd dependency on another build configuration- Specified by:
addDependencyin interfaceDependencySettings- Parameters:
dependOn- new dependency
-
addCleanupPolicy
public void addCleanupPolicy(@NotNull HistoryRetentionPolicy policy)Description copied from interface:CleanupSettingsInitSets cleanup policy for this build configuration- Specified by:
addCleanupPolicyin interfaceCleanupSettingsInit- Parameters:
policy- policy to set
-
getRequirements
@NotNull public List<Requirement> getRequirements()
Description copied from interface:BuildTypeSettingsGet list of explicit requirements for build agents which can run this build configuration. Explicit requirements are specified by user in Web UI explicitly.- Specified by:
getRequirementsin interfaceBuildTypeSettings- Returns:
- see above
-
addRequirement
public void addRequirement(@NotNull Requirement requirement)Description copied from interface:BuildTypeSettingsAdds new build requirement to the configuration. If the requirement has no id, then a copy of it with new id is generated and added to the settings.- Specified by:
addRequirementin interfaceBuildTypeSettings- Parameters:
requirement- new requirement.
-
addListener
public void addListener(@NotNull BuildTypeSettingsListener listener)- Specified by:
addListenerin interfaceBuildTypeSettingsEx
-
addListener
public void addListener(@NotNull BuildTypeSettingsListener listener, boolean delayPropagation)Description copied from interface:BuildTypeSettingsExAdds listener to the build type settings and all settings of the attached templates- Specified by:
addListenerin interfaceBuildTypeSettingsEx- Parameters:
listener- ListenerdelayPropagation- If true, attaching of the listener to a template is delayed until attachedToModel is called
-
removeListener
public void removeListener(@NotNull BuildTypeSettingsListener listener)- Specified by:
removeListenerin interfaceBuildTypeSettingsEx
-
getCheckoutType
@NotNull public BuildTypeDescriptor.CheckoutType getCheckoutType()
Description copied from interface:BuildTypeSettingsReturns method used by agent to retrieve project sources. CheckoutType.ON_SERVER server creates patch and sends it to agent CheckoutType.ON_AGENT agent checks sources out CheckoutType.MANUAL script does it itself. This method returns actual checkout type, which may differ from the value set byBuildTypeSettings.setCheckoutType(jetbrains.buildServer.BuildTypeDescriptor.CheckoutType)- Specified by:
getCheckoutTypein interfaceBuildTypeSettings- Returns:
- method to get sources on agent.
-
getArtifactDependencies
@NotNull public List<SArtifactDependency> getArtifactDependencies()
Description copied from interface:BuildTypeSettingsReturns artifacts this build configuration depending on.- Specified by:
getArtifactDependenciesin interfaceBuildTypeSettings- Returns:
- list of artifacts this build configuration depending on
-
containsVcsRoot
public boolean containsVcsRoot(long vcsRootId)
Description copied from interface:BuildTypeSettingsReturns true if VCS root with specified id is attached directly or is inherited via a template- Specified by:
containsVcsRootin interfaceBuildTypeSettings- Parameters:
vcsRootId- id of VCS root- Returns:
- see above
-
containsOwnVcsRoot
public boolean containsOwnVcsRoot(long vcsRootId)
Description copied from interface:BuildTypeSettingsReturns true if VCS root with specified id is attached directly and is not inherited via a template- Specified by:
containsOwnVcsRootin interfaceBuildTypeSettings- Parameters:
vcsRootId- id of VCS root- Returns:
- see above
-
getVcsRootEntries
@NotNull public List<VcsRootEntry> getVcsRootEntries()
Description copied from interface:BuildTypeSettingsReturns all entries of vcs roots. Each entry contains reference to root and its checkout rules.- Specified by:
getVcsRootEntriesin interfaceBuildTypeSettings- Returns:
- all entries of vcs roots for this configuration
-
getVcsRoots
@NotNull public List<SVcsRoot> getVcsRoots()
Description copied from interface:BuildTypeSettingsReturns all roots currently attached to this configuration- Specified by:
getVcsRootsin interfaceBuildTypeSettings- Returns:
- collection of all attached vcs roots.
-
getCheckoutRules
public CheckoutRules getCheckoutRules(@NotNull VcsRoot root)
Description copied from interface:BuildTypeSettingsReturns checkout rules configured for the specified VCS root. If specified VCS root is not attached to this build configuration, then null is returned.- Specified by:
getCheckoutRulesin interfaceBuildTypeSettings- Parameters:
root- VCS root- Returns:
- checkout rules or null if specified VCS root is not attached to the build configuration
-
getLabelingType
@NotNull public VcsLabelingSettings.LabelingType getLabelingType()
- Specified by:
getLabelingTypein interfaceVcsLabelingSettings- Returns:
- Returns labeling mode
-
getDependencies
@NotNull public List<Dependency> getDependencies()
Description copied from interface:DependencySettingsGet existing dependencies, empty collection when no dependencies exist- Specified by:
getDependenciesin interfaceDependencySettings- Returns:
- see above
-
getDependencyOptions
public DependencyOptions getDependencyOptions(@NotNull SBuildType buildType)
- Specified by:
getDependencyOptionsin interfaceBuildTypeSettingsEx- Parameters:
buildType- build type- Returns:
- dependency options instance if current settings instance has snapshot dependency on specified build type or null
-
getBuildTypeBranchFilter
@NotNull public BranchFilter getBuildTypeBranchFilter(@NotNull ValueResolver valueResolver)
- Specified by:
getBuildTypeBranchFilterin interfaceBuildTypeSettingsEx- Parameters:
valueResolver- value resolver- Returns:
- branch filter which is used to filter branches available in this build type
-
getBuildTypeBranchFilterUnsafe
public BranchFilter getBuildTypeBranchFilterUnsafe(@NotNull ValueResolver valueResolver) throws InvalidBranchSpecException
Description copied from interface:BuildTypeSettingsExSame asBuildTypeSettingsEx.getBuildTypeBranchFilter(ValueResolver)but throws an exception if the filter is incorrect- Specified by:
getBuildTypeBranchFilterUnsafein interfaceBuildTypeSettingsEx- Throws:
InvalidBranchSpecException
-
isAgentLessBuildType
public boolean isAgentLessBuildType()
- Specified by:
isAgentLessBuildTypein interfaceBuildTypeSettingsEx
-
getLabelPattern
@NotNull public String getLabelPattern()
- Specified by:
getLabelPatternin interfaceVcsLabelingSettings- Returns:
- Returns pattern to use for labeling
-
getLabelingRoots
@NotNull public List<VcsRoot> getLabelingRoots()
Description copied from interface:VcsLabelingSettingsList of roots which should be processed by labeling process- Specified by:
getLabelingRootsin interfaceVcsLabelingSettings- Returns:
- list of up-to-date vcs roots
-
getBuildTriggersCollection
@NotNull public Collection<BuildTriggerDescriptor> getBuildTriggersCollection()
Description copied from interface:BuildTypeSettingsReturns collection of build trigger settings- Specified by:
getBuildTriggersCollectionin interfaceBuildTypeSettings- Returns:
- see above
-
getTemplate
@NotNull @Deprecated public BuildTypeTemplateEx getTemplate()
Deprecated.Description copied from interface:BuildTypeSettingsReturns the first template these settings are based on.- Specified by:
getTemplatein interfaceBuildTypeSettings- Specified by:
getTemplatein interfaceBuildTypeSettingsEx- Returns:
- see above
-
getTemplates
@NotNull public List<BuildTypeTemplateEx> getTemplates()
Description copied from interface:BuildTypeSettingsReturns templates these settings are based on, including the default template.- Specified by:
getTemplatesin interfaceBuildTypeSettings- Specified by:
getTemplatesin interfaceBuildTypeSettingsEx- Returns:
- see above
-
getOwnTemplates
@NotNull public List<BuildTypeTemplateEx> getOwnTemplates()
- Specified by:
getOwnTemplatesin interfaceBuildTypeOwnSettings
-
getTemplateExternalId
@Nullable @Deprecated public String getTemplateExternalId()
Deprecated.- Specified by:
getTemplateExternalIdin interfaceBuildTypeSettingsEx
-
getOwnTemplateExternalIds
@NotNull public List<String> getOwnTemplateExternalIds()
- Specified by:
getOwnTemplateExternalIdsin interfaceBuildTypeOwnSettings
-
setTemplatesOrder
public void setTemplatesOrder(@NotNull List<String> templateIds)Description copied from interface:BuildTypeSettingsExImposes new order on the associated templates. Unlike#setTemplatIdsthis method cannot add or remove templates.- Specified by:
setTemplatesOrderin interfaceBuildTypeSettingsEx- Parameters:
templateIds- the existing template ids in the new order
-
setTemplateIds
public void setTemplateIds(@NotNull List<String> templateIds)Description copied from interface:BuildTypeSettingsExChange which templates these settings are attached to. No copying of settings or cleaning of duplicates occurs in process- Specified by:
setTemplateIdsin interfaceBuildTypeSettingsEx
-
isTemplateBased
public boolean isTemplateBased()
Description copied from interface:BuildTypeSettingsReturns true if these settings are directly based on a template. It does not take into account a default template.- Specified by:
isTemplateBasedin interfaceBuildTypeOwnSettings- Specified by:
isTemplateBasedin interfaceBuildTypeSettings- Returns:
- see above
-
getTemplateIds
@NotNull public List<String> getTemplateIds()
Description copied from interface:BuildTypeSettingsReturns internal ids of the templates this settings are based on, including one of the default template- Specified by:
getTemplateIdsin interfaceBuildTypeSettings- Returns:
- see above
-
getOwnTemplateIds
@NotNull public List<String> getOwnTemplateIds()
- Specified by:
getOwnTemplateIdsin interfaceBuildTypeOwnSettings
-
getTemplateId
@Deprecated public String getTemplateId()
Deprecated.Description copied from interface:BuildTypeSettingsReturns internal id of the first template this setting is based on- Specified by:
getTemplateIdin interfaceBuildTypeSettings- Returns:
- see above
-
attachedToModel
public void attachedToModel(@NotNull ProjectDataModel model)- Specified by:
attachedToModelin interfaceBuildTypeSettingsEx
-
isTemplateAccessible
public boolean isTemplateAccessible()
Description copied from interface:BuildTypeSettingsChecks accessibility of all attached templates, excluding the default template (if present)- Specified by:
isTemplateAccessiblein interfaceBuildTypeSettings- Returns:
- true if there are such templates and all of them are accessible to currently logged in user, false otherwise
-
getOptions
@NotNull public Collection<Option> getOptions()
- Specified by:
getOptionsin interfaceOptionSupport- Returns:
- combined set of options - own and inherited
-
addBuildRunner
@NotNull public SBuildRunnerDescriptor addBuildRunner(@NotNull BuildRunnerDescriptor runner)
Description copied from interface:BuildTypeSettingsAdds runner descriptor. UseBuildRunnerDescriptorFactoryto create instance of runner descriptor.
Before 8.0 this method requiredSBuildRunnerDescriptoras parameter- Specified by:
addBuildRunnerin interfaceBuildTypeSettings- Parameters:
runner- descriptor- Returns:
- instance of actually added runner
-
addBuildRunner
@NotNull public SBuildRunnerDescriptor addBuildRunner(@NotNull String name, @NotNull String runnerType, @NotNull Map<String,String> parameters)
Description copied from interface:BuildTypeSettingsCreates new build runner and adds it to these settings. Runner's ID is autogenerated- Specified by:
addBuildRunnerin interfaceBuildTypeSettings- Parameters:
name- runner namerunnerType- type of the runnerparameters- runner parameters- Returns:
- newly created runner
-
addBuildRunner
@NotNull public SBuildRunnerDescriptor addBuildRunner(@NotNull String id, @NotNull String name, @NotNull String runnerType, @NotNull Map<String,String> parameters) throws DuplicateIdException, InvalidIdentifierException, ReadOnlyEntityException
Description copied from interface:BuildTypeSettingsCreates a new build runner with the specified id, name, runner type, and parameters, and adds it to the current build settings.- Specified by:
addBuildRunnerin interfaceBuildTypeSettings- Parameters:
id- the unique id of the build runner (should be unique within all runners of this configuration)name- the name of the build runnerrunnerType- the type of the build runnerparameters- the parameters for the build runner- Returns:
- the newly created build runner descriptor
- Throws:
DuplicateIdException- if the id is already in use by another build runner, runners inherited from templates are not consideredInvalidIdentifierException- if the id is invalid or emptyReadOnlyEntityException- if the settings are read-only and cannot be modified
-
getBuildRunners
@NotNull public List<SBuildRunnerDescriptor> getBuildRunners()
Description copied from interface:BuildTypeSettingsReturns collection of build runners attached to these settings- Specified by:
getBuildRunnersin interfaceBuildTypeSettings- Returns:
- see above
-
getRunnerTypes
@NotNull public Collection<String> getRunnerTypes()
Description copied from interface:BuildTypeSettingsReturns types of the runners attached to these settings- Specified by:
getRunnerTypesin interfaceBuildTypeSettings- Returns:
- see above
-
getOwnRunnerTypes
@NotNull public Collection<String> getOwnRunnerTypes()
- Specified by:
getOwnRunnerTypesin interfaceBuildTypeOwnSettings
-
getRunTypeRequirements
@NotNull public List<Requirement> getRunTypeRequirements()
Description copied from interface:BuildTypeSettingsReturns list of additional agent requirements imposed by configured runners.- Specified by:
getRunTypeRequirementsin interfaceBuildTypeSettings- Returns:
- see above
-
getBuildFeatureRequirements
@NotNull public List<Requirement> getBuildFeatureRequirements()
Description copied from interface:BuildTypeSettingsReturns list of additional agent requirements imposed by configured enabled build features.- Specified by:
getBuildFeatureRequirementsin interfaceBuildTypeSettings- Returns:
- see above
-
getRunnersOrder
@Nullable public String[] getRunnersOrder()
- Specified by:
getRunnersOrderin interfaceBuildTypeSettings- Returns:
- runner ids in their custom order (if such order is set), null otherwise
-
applyRunnersOrder
public void applyRunnersOrder(@NotNull String[] ids)Description copied from interface:BuildTypeSettingsAccepts array of runner identifiers and reorders them according to this array.- Specified by:
applyRunnersOrderin interfaceBuildTypeSettings- Parameters:
ids- runner identifiers
-
applyRunnersOrder
public void applyRunnersOrder(@NotNull String[] ids, boolean alwaysSetCustom)Description copied from interface:BuildTypeSettingsExApply custom order of build steps- Specified by:
applyRunnersOrderin interfaceBuildTypeSettingsEx- Parameters:
ids- the order defined by build step idsalwaysSetCustom- if true, the build configuration stores the new order as a custom order even if there are no templates attached
-
resetRunnersOrder
public void resetRunnersOrder()
Description copied from interface:BuildTypeSettingsResets custom runner order to default.- Specified by:
resetRunnersOrderin interfaceBuildTypeSettings
-
findBuildRunnerById
public SBuildRunnerDescriptor findBuildRunnerById(@NotNull String runnerId)
Description copied from interface:BuildTypeSettingsFinds build runner by its' id- Specified by:
findBuildRunnerByIdin interfaceBuildTypeSettings- Parameters:
runnerId- id of the runner- Returns:
- build runner or null if runner with such id not found
-
findTriggerById
public BuildTriggerDescriptor findTriggerById(@NotNull String triggerId)
Description copied from interface:BuildTypeSettingsFinds build trigger descriptor by its' id- Specified by:
findTriggerByIdin interfaceBuildTypeSettings- Parameters:
triggerId- id of the trigger- Returns:
- build trigger descriptor or null if trigger with such id not found
-
findBuildFeatureById
public SBuildFeatureDescriptor findBuildFeatureById(@NotNull String featureId)
Description copied from interface:BuildTypeSettingsReturns build feature with specified id- Specified by:
findBuildFeatureByIdin interfaceBuildTypeSettings- Parameters:
featureId- id of the feature- Returns:
- see above
-
getBuildFeatures
@NotNull public Collection<SBuildFeatureDescriptor> getBuildFeatures()
Description copied from interface:BuildTypeSettingsReturns build features added to this settings object.- Specified by:
getBuildFeaturesin interfaceBuildTypeSettings- Returns:
- collection of configured build features
-
getOptionDefaultValue
@NotNull public <T> T getOptionDefaultValue(@NotNull Option<T> option)- Specified by:
getOptionDefaultValuein interfaceOptionSupport- Parameters:
option- option whose default value to return- Returns:
- default value for specified option
-
getTypedOption
@NotNull public <T> TypedValue<T> getTypedOption(@NotNull Option<T> option)
Description copied from interface:BuildTypeSettingsGet option extended value. See
TypedValue. When the option is not defined in this Settings TypedValue will contain null in getValue()- Specified by:
getTypedOptionin interfaceBuildTypeSettings- Specified by:
getTypedOptionin interfaceBuildTypeSettingsEx
-
isDeployment
public boolean isDeployment()
- Specified by:
isDeploymentin interfaceBuildTypeSettings- Returns:
- true if this build configuration is doing deployment
-
isCompositeBuildType
public boolean isCompositeBuildType()
- Specified by:
isCompositeBuildTypein interfaceBuildTypeSettings- Returns:
- true if this build type is composite
-
isReadOnly
public boolean isReadOnly()
- Specified by:
isReadOnlyin interfaceBuildTypeSettings- Returns:
- true if these settings are in read only mode
-
getReadOnlyReason
@Nullable public ReadOnlyReason getReadOnlyReason()
- Specified by:
getReadOnlyReasonin interfaceBuildTypeSettings- Returns:
- reason why these settings are in read only state or null if they are not read only
-
getProject
@NotNull public ProjectEx getProject()
Description copied from interface:BuildTypeSettingsExReturns the project this build type entity belongs to.- Specified by:
getProjectin interfaceBuildTypeSettings- Specified by:
getProjectin interfaceBuildTypeSettingsEx- Returns:
- the project this build type entity belongs to.
-
setProject
public void setProject(@NotNull ProjectEx project)Description copied from interface:BuildTypeSettingsExSets new project to settings object- Specified by:
setProjectin interfaceBuildTypeSettingsEx
-
setCheckoutType
public void setCheckoutType(@NotNull BuildTypeDescriptor.CheckoutType checkoutType)Description copied from interface:BuildTypeSettingsSets preferred checkout type for the configuration sources. Actual checkout type may differ, for example, if preferred checkout type is set to ON_AGENT, but there is vcs root which does not support on agent checkout, actual checkout type will be switched to ON_SERVER.BuildTypeDescriptor.CheckoutType.ON_SERVER- checkout sources automatically on the server and snd it to the agent.BuildTypeDescriptor.CheckoutType.ON_AGENT- checkout sources automatically on the agent.BuildTypeDescriptor.CheckoutType.MANUAL- do not check out sources automatically.- Specified by:
setCheckoutTypein interfaceBuildTypeSettings- Parameters:
checkoutType- new checkout type.
-
getCheckoutDirectory
public String getCheckoutDirectory()
Description copied from interface:BuildTypeSettingsReturns build checkout directory - if specified explicitly using
BuildTypeSettings.setCheckoutDirectory(String). Returnsnullif default checkout directory, generated by TeamCity should be used.- Specified by:
getCheckoutDirectoryin interfaceBuildTypeSettings- Returns:
- build checkout directory.
- See Also:
BuildTypeSettings.setCheckoutDirectory(String)
-
setCheckoutDirectory
public void setCheckoutDirectory(String checkoutDirectory)
Description copied from interface:BuildTypeSettingsSets build checkout directory. Set it to null to use default checkout directory.- Specified by:
setCheckoutDirectoryin interfaceBuildTypeSettings- Parameters:
checkoutDirectory- checkout directory
-
setCheckoutRules
public boolean setCheckoutRules(@NotNull VcsRoot root, @NotNull CheckoutRules rules)Description copied from interface:BuildTypeSettingsSets checkout rules for specified VCS root. VCS root must be attached to this build configuration.- Specified by:
setCheckoutRulesin interfaceBuildTypeSettings- Parameters:
root- root to set rules forrules- checkout rules for the VCS root- Returns:
- true if checkout rules were set for the VCS root (if VCS root is attached) and false otherwise
-
setArtifactPaths
public void setArtifactPaths(@Nullable String artifactPaths)Description copied from interface:BuildTypeSettingsSets build artifact paths. Artifact paths are comma separated paths to build artifacts. Support ant-style wildcards and target directories like *.zip => winFiles,unix/dist.tgz => linuxFiles, where winFiles and linuxFiles are target directories. Set to null or empty string to disable artifacts processing.- Specified by:
setArtifactPathsin interfaceBuildTypeSettings- Parameters:
artifactPaths- paths to build artifacts
-
getArtifactPaths
@Nullable public String getArtifactPaths()
Description copied from interface:BuildTypeSettingsReturns build artifact paths.- Specified by:
getArtifactPathsin interfaceBuildTypeSettings- Returns:
- build artifact paths
-
getOwnArtifactDependencies
@NotNull public List<SArtifactDependency> getOwnArtifactDependencies()
- Specified by:
getOwnArtifactDependenciesin interfaceBuildTypeOwnSettings
-
removeArtifactDependency
public void removeArtifactDependency(@NotNull SArtifactDependency dependency)Description copied from interface:BuildTypeSettingsRemoves artifact dependency.- Specified by:
removeArtifactDependencyin interfaceBuildTypeSettings- Parameters:
dependency- artifact dependency
-
removeRequirement
public void removeRequirement(String propertyName)
Description copied from interface:BuildTypeSettingsRemoves first requirement with the specified property name from the configuration.- Specified by:
removeRequirementin interfaceBuildTypeSettings- Parameters:
propertyName- name of the requirement parameter.
-
removeRequirement
public void removeRequirement(Requirement req)
Description copied from interface:BuildTypeSettingsRemoves a requirement from the configuration.- Specified by:
removeRequirementin interfaceBuildTypeSettings- Parameters:
req- requirement to be removed
-
getBuildNumberPattern
@NotNull public String getBuildNumberPattern()
Description copied from interface:BuildTypeSettingsReturns current build number pattern- Specified by:
getBuildNumberPatternin interfaceBuildTypeSettings- Returns:
- see above
-
setBuildNumberPattern
public void setBuildNumberPattern(@NotNull String pattern)Description copied from interface:BuildTypeSettingsSets build number pattern. %build.counter% in the pattern will be replaced with current build number value when build starts- Specified by:
setBuildNumberPatternin interfaceBuildTypeSettings- Parameters:
pattern- pattern to set
-
persist
public void persist()
Description copied from interface:BuildTypeSettingsPersists these settings.- Specified by:
persistin interfaceBuildTypeSettings
-
persist
public void persist(@NotNull ConfigAction cause)- Specified by:
persistin interfaceBuildTypeSettings
-
getOwnRequirements
@NotNull public List<Requirement> getOwnRequirements()
- Specified by:
getOwnRequirementsin interfaceBuildTypeOwnSettings
-
getBuildParameter
public String getBuildParameter(String key)
Description copied from interface:BuildTypeSettingsReturns build parameter by parameter key- Specified by:
getBuildParameterin interfaceBuildTypeSettings- Parameters:
key- parameter key- Returns:
- build parameter by parameter key
-
getOwnVcsRootEntries
@NotNull public List<VcsRootEntry> getOwnVcsRootEntries()
- Specified by:
getOwnVcsRootEntriesin interfaceBuildTypeOwnSettings
-
vcsRootsAccessibleInProject
public boolean vcsRootsAccessibleInProject(@NotNull SProject project)- Specified by:
vcsRootsAccessibleInProjectin interfaceBuildTypeSettingsEx
-
removeVcsRoot
public boolean removeVcsRoot(@NotNull SVcsRoot root)Description copied from interface:BuildTypeSettingsRemoves existing VCS root from the build configuration. If there were checkout rules attached to this VCS root they will be removed too.- Specified by:
removeVcsRootin interfaceBuildTypeSettings- Parameters:
root- VCS root to remove- Returns:
- true if VCS root was actually removed from the build configuration and false if build configuration did not have this vcs root attached
-
addBuildParameter
public void addBuildParameter(Parameter parameter)
Description copied from interface:BuildTypeSettingsAdds build parameter to the configuration. Build parameter is a system or environment variable. Concrete parameter type is being selected by its name prefix.Constants.SYSTEM_PREFIXfor system properties andConstants.ENV_PREFIXfor environment variable.- Specified by:
addBuildParameterin interfaceBuildTypeSettings- Parameters:
parameter- specified parameter.
-
removeBuildParameter
public void removeBuildParameter(String paramName)
Description copied from interface:BuildTypeSettingsRemoves existing build parameter by its name.- Specified by:
removeBuildParameterin interfaceBuildTypeSettings- Parameters:
paramName- specified parameter name.
-
getBuildParameters
@NotNull public Map<String,String> getBuildParameters()
Description copied from interface:BuildTypeSettingsReturn map of build parameters specified by user. Each build parameter has name and value. Name of each parameter starts from a prefix: env. or system. Value may by either simple string, or may contain references to other parameters in form %env.HOME% or %system.os.name% or %system.agent.name%- Specified by:
getBuildParametersin interfaceBuildTypeSettings- Returns:
- see above
-
getBuildParametersCollection
@NotNull public Collection<Parameter> getBuildParametersCollection()
Description copied from interface:BuildTypeSettingsReturns build parameters collection.- Specified by:
getBuildParametersCollectionin interfaceBuildTypeSettings- Returns:
- see above
-
setOption
public <T> void setOption(@NotNull Option<T> option, @NotNull T value)Description copied from interface:OptionSupportSet option value, clears value if it is the same as default- Specified by:
setOptionin interfaceOptionSupport- Parameters:
option- option to set value forvalue- option value
-
getOwnOptions
@NotNull public Collection<Option> getOwnOptions()
Description copied from interface:OptionSupportReturn options defined in this object, i.e. options for which some value has been set usingOptionSupport.setOption(Option, Object)method.- Specified by:
getOwnOptionsin interfaceOptionSupport- Returns:
- see above
-
getChangedOptions
@NotNull public Option[] getChangedOptions()
Description copied from interface:OptionSupportReturn options with changed values, i.e. options with non-default values- Specified by:
getChangedOptionsin interfaceOptionSupport- Returns:
- see above
-
getOption
@NotNull public <T> T getOption(@NotNull Option<T> option)Description copied from interface:OptionSupportGet option value- Specified by:
getOptionin interfaceOptionSupport- Parameters:
option- option to retrieve value for- Returns:
- value of the option. If value wasn't set, Option:getDefaultValue is returned
-
addConfigParameter
public void addConfigParameter(@NotNull Parameter param)Description copied from interface:BuildTypeSettingsAdds configuration parameter. There are three different types of parameters which can be added to build configuration settings:- build parameters - these are parameters passed to agent and then to a build (see
BuildTypeSettings.addBuildParameter(Parameter)), these parameters must have prefix system. or env. - runner parameters - these are parameters of a runner, they are transferred to agent and passed to corresponding build runner plugin
- configuration parameters - these parameters are not transferred to agent or build, but can be referenced in various places (including build & runner parameters and thus can effectively pass to a build)
- Specified by:
addConfigParameterin interfaceBuildTypeSettings- Parameters:
param- configuration parameter
- build parameters - these are parameters passed to agent and then to a build (see
-
removeConfigParameter
public void removeConfigParameter(@NotNull String paramName)Description copied from interface:BuildTypeSettingsRemoves configuration parameters with specified name- Specified by:
removeConfigParameterin interfaceBuildTypeSettings- Parameters:
paramName- parameter name
-
addParameter
public void addParameter(@NotNull Parameter param)Description copied from interface:UserParametersHolderAdds parameter.- Specified by:
addParameterin interfaceUserParametersHolder- Parameters:
param- build or config parameter, the type is determined by parameter prefix
-
removeParameter
public void removeParameter(@NotNull String paramName)Description copied from interface:UserParametersHolderRemoves parameter.- Specified by:
removeParameterin interfaceUserParametersHolder- Parameters:
paramName- build or config parameter name, the type is determined by parameter prefix
-
getParametersCollection
@NotNull public Collection<Parameter> getParametersCollection()
Description copied from interface:ReadOnlyUserParametersReturns build and configuration parameters in single collection.- Specified by:
getParametersCollectionin interfaceInheritableUserParametersHolder- Specified by:
getParametersCollectionin interfaceReadOnlyUserParameters- Returns:
- merged collection of parameters, i.e. all parameters inherited from parent holders and own parameters
-
getParameter
@Nullable public Parameter getParameter(@NotNull String paramName)
- Specified by:
getParameterin interfaceReadOnlyUserParameters
-
getParameters
@NotNull public Map<String,String> getParameters()
Description copied from interface:ReadOnlyUserParametersReturns map of build and configuration parameters.- Specified by:
getParametersin interfaceInheritableUserParametersHolder- Specified by:
getParametersin interfaceReadOnlyUserParameters- Returns:
- merged map of parameters, i.e. all parameters inherited from parent holders and own parameters
-
getParameterValue
@Nullable public String getParameterValue(@NotNull String paramName)
- Specified by:
getParameterValuein interfaceReadOnlyUserParameters- Parameters:
paramName- parameter name- Returns:
- value of the parameter with given name or null if there is no such parameter
-
getOwnParametersCollection
@NotNull public Collection<Parameter> getOwnParametersCollection()
- Specified by:
getOwnParametersCollectionin interfaceInheritableUserParametersHolder- Returns:
- own parameters, without inherited. Yet they would have inherited specs or values (if any).
-
getOwnParameters
@NotNull public Map<String,String> getOwnParameters()
- Specified by:
getOwnParametersin interfaceInheritableUserParametersHolder- Returns:
- own parameters map, without inherited. Yet they would have inherited specs or values (if any).
-
getParametersProvider
@NotNull public ParametersProvider getParametersProvider()
-
getConfigParametersCollection
@NotNull public Collection<Parameter> getConfigParametersCollection()
Description copied from interface:BuildTypeSettingsReturns collection of configuration parameters.- Specified by:
getConfigParametersCollectionin interfaceBuildTypeSettings- Returns:
- see above
-
getConfigParameters
@NotNull public Map<String,String> getConfigParameters()
Description copied from interface:BuildTypeSettingsReturns map of configuration parameters- Specified by:
getConfigParametersin interfaceBuildTypeSettings- Returns:
- see above
-
getUndefinedParameters
@NotNull public List<String> getUndefinedParameters()
Description copied from interface:BuildTypeSettingsReturns collection of parameter names (config and build params) referenced in the build configuration settings but without values provided. I.e. there is a reference to a parameter but such parameter is not defined anywhere.
Parameter value can come from different sources:- build configuration or template settings
- agents
- various extensions
- Specified by:
getUndefinedParametersin interfaceBuildTypeSettings- Returns:
- see above
-
removeBuildRunner
public SBuildRunnerDescriptor removeBuildRunner(@NotNull String runnerId)
Description copied from interface:BuildTypeSettingsRemoves runner descriptor with specified id.- Specified by:
removeBuildRunnerin interfaceBuildTypeSettings- Parameters:
runnerId- descriptor id- Returns:
- removed runner descriptor
-
updateBuildRunner
public boolean updateBuildRunner(@NotNull String runnerId, @NotNull String name, @NotNull String type, @NotNull Map<String,String> params)Description copied from interface:BuildTypeSettingsUpdates parameters in the existing build runner descriptor. Does nothing if there runner with specified id was not found.- Specified by:
updateBuildRunnerin interfaceBuildTypeSettings- Parameters:
runnerId- id of runner descriptorname- new runner nametype- new type of the runnerparams- new runner parameters- Returns:
- true if parameters updated and false otherwise
-
getOwnBuildRunners
@NotNull public List<SBuildRunnerDescriptor> getOwnBuildRunners()
- Specified by:
getOwnBuildRunnersin interfaceBuildTypeOwnSettings
-
removeAllBuildRunners
public void removeAllBuildRunners()
Description copied from interface:BuildTypeSettingsRemoves all build runners from these settings- Specified by:
removeAllBuildRunnersin interfaceBuildTypeSettings
-
findBuildRunnerByType
public SBuildRunnerDescriptor findBuildRunnerByType(@NotNull String runnerType)
Description copied from interface:BuildTypeSettingsFinds build runner by its' type. If there is more than one build runner, returns the first one.- Specified by:
findBuildRunnerByTypein interfaceBuildTypeSettings- Parameters:
runnerType- type of the runner- Returns:
- build runner or null if runner was not found
-
findRunnerParameter
public String findRunnerParameter(@NotNull String paramName)
Description copied from interface:BuildTypeSettingsSearches runner parameter in all build runners and returns value of the first found parameter with given name.- Specified by:
findRunnerParameterin interfaceBuildTypeSettings- Parameters:
paramName- name of the parameter- Returns:
- the first found parameter value or null
-
getRunnerConditions
@NotNull public BuildStepConditions getRunnerConditions(@NotNull SBuildRunnerDescriptor descriptor)
- Specified by:
getRunnerConditionsin interfaceBuildTypeSettings- Returns:
- support for conditions for conditional build steps
-
createParametersProvider
public ParametersProvider createParametersProvider(@NotNull SBuild build)
- Specified by:
createParametersProviderin interfaceBuildTypeSettingsEx
-
dispose
public void dispose()
- Specified by:
disposein interfaceBuildTypeSettingsEx
-
addRunParameter
public void addRunParameter(@NotNull SBuildRunnerDescriptor runner, @NotNull Parameter parameter)- Specified by:
addRunParameterin interfaceBuildTypeSettingsEx
-
getDisabledParameterDescriptorIds
@NotNull public Collection<String> getDisabledParameterDescriptorIds()
- Specified by:
getDisabledParameterDescriptorIdsin interfaceBuildTypeSettingsEx
-
getOwnDisabledParameterDescriptorIds
@NotNull public Collection<String> getOwnDisabledParameterDescriptorIds()
- Specified by:
getOwnDisabledParameterDescriptorIdsin interfaceBuildTypeOwnSettings
-
replaceInValues
public boolean replaceInValues(@NotNull String regexp, @NotNull String replacement)Description copied from interface:BuildTypeSettingsReplaces values according to specified regexp and replacement string in all text parameters of the build configuration- Specified by:
replaceInValuesin interfaceBuildTypeSettings- Parameters:
regexp- regexpreplacement- replacement- Returns:
- true if at least one text value was affected and false otherwise
-
replaceInValues
public boolean replaceInValues(@NotNull Pattern regexpPattern, @NotNull String replacement)Description copied from interface:BuildTypeSettingsReplaces values according to specified pattern and replacement string in all text parameters of the build configuration- Specified by:
replaceInValuesin interfaceBuildTypeSettings- Parameters:
regexpPattern- regexp patternreplacement- replacement- Returns:
- true if at least one text value was affected and false otherwise
-
textValueMatches
public boolean textValueMatches(@NotNull Pattern regexpPattern)Description copied from interface:BuildTypeSettingsReturns true if configuration has value in text parameters which matches specified pattern. Only own parameters are checked - without inherited- Specified by:
textValueMatchesin interfaceBuildTypeSettings- Parameters:
regexpPattern- regexp pattern- Returns:
- true if such value exists and false otherwise
-
getImplicitRequirements
@NotNull public List<Requirement> getImplicitRequirements()
Description copied from interface:BuildTypeSettingsGet list of non-satisfied implicit requirements for build agents. Implicit requirements appear when some build configuration property, or run parameter contains a reference to another parameter in form %<param name>%.- Specified by:
getImplicitRequirementsin interfaceBuildTypeSettings- Returns:
- see above
-
setParametersSupport
public void setParametersSupport(@NotNull ParametersSupport paramsSupport)- Specified by:
setParametersSupportin interfaceBuildTypeSettingsEx
-
addBuildTrigger
public boolean addBuildTrigger(@NotNull BuildTriggerDescriptor triggerDescriptor)Description copied from interface:BuildTypeSettingsAdds new trigger to build configuration settings. UseBuildTriggerDescriptorFactoryto create trigger descriptor.- Specified by:
addBuildTriggerin interfaceBuildTypeSettings- Parameters:
triggerDescriptor- trigger descriptor- Returns:
- true if trigger was added, and false if trigger with such id already exists
-
addBuildTrigger
@NotNull public BuildTriggerDescriptor addBuildTrigger(@NotNull String type, @NotNull Map<String,String> params)
Description copied from interface:BuildTypeSettingsAdds new trigger of specified type and with specified parameters to build configuration settings.- Specified by:
addBuildTriggerin interfaceBuildTypeSettings- Parameters:
type- type of the triggerparams- parameters map- Returns:
- newly created trigger descriptor
-
removeBuildTrigger
public boolean removeBuildTrigger(@NotNull BuildTriggerDescriptor triggerDescriptor)Description copied from interface:BuildTypeSettingsRemoves specified build trigger from the settings- Specified by:
removeBuildTriggerin interfaceBuildTypeSettings- Parameters:
triggerDescriptor- trigger descriptor- Returns:
- true if trigger was actually removed and false otherwise
-
updateBuildTrigger
public boolean updateBuildTrigger(@NotNull String triggerId, @NotNull String newType, @NotNull Map<String,String> newParams)Description copied from interface:BuildTypeSettingsUpdates build trigger descriptor with specified id, changes type and parameters.- Specified by:
updateBuildTriggerin interfaceBuildTypeSettings- Parameters:
triggerId- id of build trigger descriptornewType- type of build trigger descriptornewParams- parameters map- Returns:
- true if parameters of build trigger descriptor were changed (descriptor with such id exists) and false otherwise
-
updateBuildTrigger
public boolean updateBuildTrigger(@NotNull BuildTriggerDescriptor newDescriptor)Description copied from interface:BuildTypeSettingsUpdates build trigger descriptor with id equal to newDescriptor id.- Specified by:
updateBuildTriggerin interfaceBuildTypeSettings- Parameters:
newDescriptor- new settings of the trigger- Returns:
- true if parameters of build trigger descriptor were changed (descriptor with such id exists) and false otherwise
-
getOwnBuildTriggers
@NotNull public List<BuildTriggerDescriptor> getOwnBuildTriggers()
- Specified by:
getOwnBuildTriggersin interfaceBuildTypeOwnSettings
-
getOwnOptionSupport
@NotNull public OptionSupportEx getOwnOptionSupport()
- Specified by:
getOwnOptionSupportin interfaceBuildTypeOwnSettings
-
getOwnSerializableParameters
@NotNull public SerializableParametersCollection getOwnSerializableParameters()
- Specified by:
getOwnSerializableParametersin interfaceBuildTypeOwnSettings
-
getOwnCleanupSupport
@NotNull public CleanupSettingsSupport getOwnCleanupSupport()
- Specified by:
getOwnCleanupSupportin interfaceBuildTypeOwnSettings
-
getCleanupPolicies
@NotNull public Collection<HistoryRetentionPolicy> getCleanupPolicies()
- Specified by:
getCleanupPoliciesin interfaceCleanupSettings- Returns:
- combined cleanup policies, including those inherited from default or parent object
-
getOwnCleanupPolicies
@NotNull public Collection<HistoryRetentionPolicy> getOwnCleanupPolicies()
- Specified by:
getOwnCleanupPoliciesin interfaceCleanupSettings- Returns:
- cleanup policies, specific for this object only
-
getInheritedCleanupPolicies
@NotNull public Collection<HistoryRetentionPolicy> getInheritedCleanupPolicies()
- Specified by:
getInheritedCleanupPoliciesin interfaceCleanupSettings
-
getInheritedCleanupOptions
@NotNull public Map<String,Boolean> getInheritedCleanupOptions()
- Specified by:
getInheritedCleanupOptionsin interfaceCleanupSettings
-
getCleanupOptions
@NotNull public Map<String,Boolean> getCleanupOptions()
- Specified by:
getCleanupOptionsin interfaceCleanupSettings- Returns:
- map of all cleanup options
-
getOwnCleanupOptions
@NotNull public Map<String,Boolean> getOwnCleanupOptions()
- Specified by:
getOwnCleanupOptionsin interfaceCleanupSettings- Returns:
- map of own cleanup options only
-
removeCleanupPolicies
public void removeCleanupPolicies()
Description copied from interface:CleanupSettingsInitRemove all own cleanup policies for the object- Specified by:
removeCleanupPoliciesin interfaceCleanupSettingsInit
-
setCleanupOption
public void setCleanupOption(@NotNull String option, @Nullable Boolean value)Description copied from interface:CleanupSettingsInitSets value for a cleanup option- Specified by:
setCleanupOptionin interfaceCleanupSettingsInit- Parameters:
option- cleanup option (seeCleanupSettingsconstants)value- value to set option to, ornullto remove the option
-
copySettings
public void copySettings(@NotNull BuildTypeSettingsEx source, @NotNull BuildTypeCopySettings copyOptions)Description copied from interface:BuildTypeSettingsExCopies settings, parameters, options etc. from another instance of build type settings.- Specified by:
copySettingsin interfaceBuildTypeSettingsEx- Parameters:
source- source settingscopyOptions- copy options; if empty, the method regenerates setting ids for the settings that clash by ids with the inherited ones in the destination, and copies disabled and inherited settings from the source- See Also:
BuildTypeSettingsCopyOptions
-
copyAllSettings
public void copyAllSettings(@NotNull BuildTypeSettingsEx settingsSource)Description copied from interface:BuildTypeSettingsExCopies all settings, the behaviour is the same as copySettings with empty copyOptions, i.e. it regenerates setting ids for the settings that clash by ids with the inherited ones in the destination, and copies disabled and inherited settings from the source.- Specified by:
copyAllSettingsin interfaceBuildTypeSettingsEx
-
copyOwnSettings
@Deprecated public void copyOwnSettings(@NotNull BuildTypeSettingsEx settingsSource)
Deprecated.- Specified by:
copyOwnSettingsin interfaceBuildTypeSettingsEx
-
copyOverridableSettings
public void copyOverridableSettings(@NotNull BuildTypeSettingsEx settingsSource)- Specified by:
copyOverridableSettingsin interfaceBuildTypeSettingsEx
-
getOwnDependencies
@NotNull public List<Dependency> getOwnDependencies()
- Specified by:
getOwnDependenciesin interfaceBuildTypeOwnSettings
-
removeDependency
public boolean removeDependency(@NotNull Dependency dependOn)Description copied from interface:DependencySettingsRemove dependency on another build configuration- Specified by:
removeDependencyin interfaceDependencySettings- Parameters:
dependOn- dependency to remove- Returns:
- true if dependency was actually removed
-
replaceDependency
public void replaceDependency(@NotNull Dependency orig, @NotNull Dependency newDep)Description copied from interface:BuildTypeSettingsExReplaces original dependency object with another one- Specified by:
replaceDependencyin interfaceBuildTypeSettingsEx
-
replaceDependency
public void replaceDependency(@NotNull SArtifactDependency origDep, @NotNull SArtifactDependency newDep)Description copied from interface:BuildTypeSettingsExReplaces original dependency object with another one- Specified by:
replaceDependencyin interfaceBuildTypeSettingsEx
-
getCompatibilityMap
@NotNull public Map<SBuildAgent,CompatibilityResult> getCompatibilityMap()
Description copied from interface:CompatibleAgentsReturns compatibility map, key is an agent and value is compatibility result.- Specified by:
getCompatibilityMapin interfaceCompatibleAgents- Returns:
- see above
-
getAgentCompatibility
@NotNull public CompatibilityResult getAgentCompatibility(@NotNull AgentDescription agentDescription)
Description copied from interface:CompatibleAgentsFetches compatibility information for given agent description- Specified by:
getAgentCompatibilityin interfaceCompatibleAgents- Parameters:
agentDescription- agent description- Returns:
- compatibility results.
- See Also:
CompatibilityResult
-
getCompatibleAgents
@NotNull public Collection<SBuildAgent> getCompatibleAgents()
Description copied from interface:CompatibleAgentsReturns collection of compatible agents- Specified by:
getCompatibleAgentsin interfaceCompatibleAgents- Returns:
- see above
-
addBuildFeature
@NotNull public SBuildFeatureDescriptor addBuildFeature(@NotNull String type, @NotNull Map<String,String> params)
Description copied from interface:BuildTypeSettingsAdds build feature with specified type and parameters to this settings object.- Specified by:
addBuildFeaturein interfaceBuildTypeSettings- Parameters:
type- build feature typeparams- build feature parameters- Returns:
- build feature descriptor
-
addBuildFeature
public void addBuildFeature(@NotNull SBuildFeatureDescriptor feature)Description copied from interface:BuildTypeSettingsAdds build feature descriptor to this settings object.- Specified by:
addBuildFeaturein interfaceBuildTypeSettings- Parameters:
feature- build feature descriptor
-
getBuildFeaturesOfType
@NotNull public Collection<SBuildFeatureDescriptor> getBuildFeaturesOfType(@NotNull String type)
Description copied from interface:BuildTypeSettingsReturns all build features of specified type.- Specified by:
getBuildFeaturesOfTypein interfaceBuildTypeSettings- Returns:
- see above
-
getOwnBuildFeatures
@NotNull public List<SBuildFeatureDescriptor> getOwnBuildFeatures()
- Specified by:
getOwnBuildFeaturesin interfaceBuildTypeOwnSettings
-
removeBuildFeature
public SBuildFeatureDescriptor removeBuildFeature(@NotNull String featureId)
Description copied from interface:BuildTypeSettingsRemoves build feature with specified id from this settings object.- Specified by:
removeBuildFeaturein interfaceBuildTypeSettings- Parameters:
featureId- id of the feature- Returns:
- removed build feature descriptor or null if there were no feature descriptor with such id
-
updateBuildFeature
public boolean updateBuildFeature(@NotNull String featureId, @NotNull String type, @NotNull Map<String,String> parameters)Description copied from interface:BuildTypeSettingsUpdates build feature descriptor with specified id, changes type and parameters.- Specified by:
updateBuildFeaturein interfaceBuildTypeSettings- Parameters:
featureId- id of build feature descriptortype- type of build feature descriptorparameters- parameters map- Returns:
- true if parameters of build feature descriptor were changed (descriptor with such id exists) and false otherwise
-
setEnabled
public void setEnabled(@NotNull String paramsDescriptorId, boolean enabled)Description copied from interface:BuildTypeSettingsEnables or disables descriptor with specified id in build configuration settings. This method can be used to enable or disable build runners, triggers and build features.- Specified by:
setEnabledin interfaceBuildTypeSettings- Parameters:
paramsDescriptorId- id of build runner, trigger or build featureenabled- true to enable, false to disable
-
isEnabled
public boolean isEnabled(@NotNull String paramsDescriptorId)Description copied from interface:BuildTypeSettingsReturns true if descriptor with specified id (runner, trigger or build feature) is enabled and false otherwise.- Specified by:
isEnabledin interfaceBuildTypeSettings- Parameters:
paramsDescriptorId- id of build runner, trigger or build feature
-
setSecureDataStorage
public void setSecureDataStorage(@NotNull SecureDataStorage secureDataStorage)Description copied from interface:BuildTypeSettingsExSets secure data storage to be used by these settings when they are persisted on disk.- Specified by:
setSecureDataStoragein interfaceBuildTypeSettingsEx- Parameters:
secureDataStorage- secure data storage
-
getSecureDataStorage
@NotNull public SecureDataStorage getSecureDataStorage()
- Specified by:
getSecureDataStoragein interfaceBuildTypeSettingsEx- Returns:
- secure data storage used by these settings
-
getParameterDescriptorState
@NotNull public Map<String,Boolean> getParameterDescriptorState()
- Specified by:
getParameterDescriptorStatein interfaceBuildTypeSettingsEx- Returns:
- map of parameter descriptors states. False means the parameter descriptor is disabled, true means parameter descriptor is enabled, null means parameter descriptor state is not defined here (enabled by default).
-
getBuildSettings
@NotNull public BuildSettings getBuildSettings()
- Specified by:
getBuildSettingsin interfaceBuildTypeSettingsEx
-
getOwnParametersWithoutInheritedSpec
@NotNull public Collection<Parameter> getOwnParametersWithoutInheritedSpec()
- Specified by:
getOwnParametersWithoutInheritedSpecin interfaceInheritableUserParametersHolder- Returns:
- own parameters as is, with own parameters spec.
-
getInheritedParametersCollection
@NotNull public Collection<Parameter> getInheritedParametersCollection()
- Specified by:
getInheritedParametersCollectionin interfaceInheritableUserParametersHolder- Returns:
- collection of inherited parameters.
-
getOwnNonInheritedParameter
public Parameter getOwnNonInheritedParameter(@NotNull String paramName)
Description copied from interface:InheritableUserParametersHolderExOwn parameter without inherited parameter spec.- Specified by:
getOwnNonInheritedParameterin interfaceInheritableUserParametersHolderEx- Returns:
-
createReadOnlySettings
@NotNull public ReadOnlyBuildTypeSettings createReadOnlySettings()
- Specified by:
createReadOnlySettingsin interfaceBuildTypeSettingsEx
-
createCopy
@NotNull public BuildTypeSettingsEx createCopy()
- Specified by:
createCopyin interfaceBuildTypeSettingsEx
-
getOwnParameter
public Parameter getOwnParameter(@NotNull String paramName)
- Specified by:
getOwnParameterin interfaceInheritableUserParametersHolder- Parameters:
paramName- parameter name- Returns:
- own parameter with given name or null if there is no such parameter
-
doApplyRunnersOrder
@NotNull public static <T extends BuildRunnerDescriptor> List<T> doApplyRunnersOrder(@NotNull String[] newOrderIds, @NotNull Collection<T> _currentRunners)
-
getParametersSupport
@NotNull public ContainerWithInherited<String,Parameter> getParametersSupport()
- Specified by:
getParametersSupportin interfaceParameterSupport
-
getOptionSupport
@NotNull public ContainerWithInherited<Option<Object>,OptionValue<Object>> getOptionSupport()
- Specified by:
getOptionSupportin interfaceBuildTypeSettingsSupport
-
getBuildFeatureSupport
@NotNull public ContainerWithDisabled<String,SBuildFeatureDescriptor> getBuildFeatureSupport()
- Specified by:
getBuildFeatureSupportin interfaceBuildTypeSettingsSupport
-
getBuildRunnerSupport
@NotNull public ContainerWithDisabled<String,SBuildRunnerDescriptor> getBuildRunnerSupport()
- Specified by:
getBuildRunnerSupportin interfaceBuildTypeSettingsSupport
-
getBuildTriggersSupport
@NotNull public ContainerWithDisabled<String,BuildTriggerDescriptor> getBuildTriggersSupport()
- Specified by:
getBuildTriggersSupportin interfaceBuildTypeSettingsSupport
-
getRequirementSupport
@NotNull public ContainerWithDisabled<String,Requirement> getRequirementSupport()
- Specified by:
getRequirementSupportin interfaceBuildTypeSettingsSupport
-
getDisabledState
@NotNull public Container<String,Boolean> getDisabledState()
- Specified by:
getDisabledStatein interfaceBuildTypeSettingsSupport
-
-