Package jetbrains.buildServer.serverSide.impl.auth

Class SecuredVersionedSettingsManager

java.lang.Object

jetbrains.buildServer.serverSide.impl.auth.SecuredVersionedSettingsManager

All Implemented Interfaces:

VersionedSettingsManager

public class SecuredVersionedSettingsManager
extends Object
implements VersionedSettingsManager

Constructor Summary

Constructors

Constructor	Description
SecuredVersionedSettingsManager(VersionedSettingsManager delegate, SecurityContextEx securityContext)

Method Summary

Modifier and Type	Method	Description
ConfigAction	createEnableConfigActionAfterUpgrade(int prevVersion, int curVersion)
boolean	enableVersionedSettings()	Globally enable versioned settings on the server, if the enabling process is not running yet.
TriggerRules	excludeSettingRoots(String rules, Collection<SBuildType> buildTypes)	Returns trigger rules which exclude unattached settings VCS roots used in given buildTypes.
ProjectSettingsGenerator	findGenerator(String format)	Returns the project settings generator for the specified format or null if no such generator exist
List<String>	generateSettingsZip(SProject project, File dst, String format, ProjectSettingsGeneratorConfig config)	Generates zip with project settings in the specified format and writes it to the given dst file.
String	getCredentialsStorageType(SProject project)	Returns type of the CredentialsStorage which should be used for versioned settings of the specified project.
VersionedSettingsConfig	getEffectiveBuildSettingsConfig(SBuildType buildType)	Returns build settings config of a project where versioned settings VCS root is configured for given buildType's project.
VersionedSettingsConfig	getEffectiveBuildSettingsConfig(SProject project)	Returns settings config of a project where versioned settings VCS root is configured for the given project.
VersionedSettingsConfig.BuildSettingsMode	getEffectiveBuildSettingsMode(SBuildType buildType)	Returns build settings mode of a project where versioned settings VCS root is configured for given buildType's project.
VersionedSettingsConfig.BuildSettingsMode	getEffectiveBuildSettingsMode(SProject project)	Returns build settings mode for given project or null if versioned settings are not configured for given project
String	getEffectiveFormat(SProject project)	Returns effective settings format for the given project or null if versioned settings are not configured in the project
ProjectSettingsGenerator	getEffectiveGenerator(SProject project)	Returns effective settings generator for given project or default generator if versioned settings are not configured for given project
ProjectSettingsGenerator	getEffectiveGeneratorOrNull(SProject project)	Returns effective settings generator for given project or default generator if versioned settings are not configured for given project, returns null if the generator specified in project settings is not found.
Pair<SProject,VersionedSettingsConfig>	getEffectiveProjectConfig(SProject project)	Returns project and settings config of a project where versioned settings VCS root is configured for the given project.
ProjectSettingsPaths	getEffectiveProjectSettingsPaths(SProject project)	Returns effective Versioned Settings Files Paths for the given project.
Collection<ProjectSettingsGenerator>	getGenerators()	Returns all registered project settings generators
VersionedSettingsOptions	getOptions()
SVcsRoot	getOwnVersionedSettingsVcsRoot(SProject project)	Returns versioned settings root configured for given project ignoring settings inherited from parent project.
Set<SProject>	getProjectsByOwnSettingsRoot(VcsRoot root)	Returns all projects which explicitly use the given VCS root for storing settings ignoring the settings inherited from parent project
Set<SProject>	getProjectsByOwnSettingsRootInstance(VcsRootInstance root)	Returns all projects which explicitly use the given VCS root instance for storing settings, ignoring the settings inherited from the parent project
Set<SProject>	getProjectsBySettingsRoot(VcsRoot root)	Returns all projects which use the given VCS root for storing settings
Set<SProject>	getProjectsBySettingsRootInstance(VcsRootInstance root)	Returns all projects which use the given VCS root instance for storing settings
Set<SProject>	getProjectsWithOwnVersionedSettings()	Returns set of projects where versioned settings are explicitly enabled (does not include projects with 'same as parent' settings).
Map<SBuildType,CheckoutRules>	getSettingsRootCheckoutRules(Collection<SBuildType> buildTypes, VcsRootInstance settingsRoot)	Returns settings VCS root checkout rules for a collection of build types if versioned settings are not configured for the build type's project or if different root is used to store settings then returned map will not contain entry for this build type
CheckoutRules	getSettingsRootCheckoutRules(SBuildType buildType, VcsRootInstance root)	Returns settings VCS root checkout rules for given build type or null if versioned settings are not configured for the build type's project or if different root is used to store settings
BuildRevision	getSettingsRootRevision(BuildPromotionEx buildPromotion)	Returns a revision of a settings VCS root for the given build promotion or null if build promotion does not have version settings enabled or checking for changes is not done yet.
Set<SProject>	getSubProjectsWithSameSettings(SProject project)	Returns transitive sub-projects of the given project which use 'same as parent' versioned settings
SProject	getVersionedSettingsProject(SProject project)	Returns a project where versioned settings VCS root is configured for given project.
SVcsRoot	getVersionedSettingsVcsRoot(SProject project)	For given project returns VCS root where project settings are stored.
VcsRootInstance	getVersionedSettingsVcsRootInstance(SProject project)	For given project finds VCS root where project settings are stored, then resolves it's parameters using given project as a context.
VcsRootInstanceEntry	getVersionedSettingsVcsRootInstanceEntry(SBuildType buildType)	Returns settings VCS root entry for the given build type or null if versioned settings are not configured for the build type's project
boolean	hasVersionedSettings(SProject project)	Returns true if the specified project stores settings in VCS, false otherwise
boolean	isEnableSettingsActionAfterUpgrade(ConfigAction configAction)
boolean	isProjectWithCustomSettingsFormat(SProject project)	Returns true if the specified project uses custom settings format, returns false otherwise
boolean	isProjectWithReadOnlySettingsFormat(SProject project)	Returns true if the specified project uses read-only settings format, returns false otherwise or when configured format is not found
boolean	isShowBranchesFromVersionedSettingsVcsRoot(SBuildType buildType)	Returns true if branches from the versioned settings VCS root should be shown in the context of the build configuration.
boolean	isShowSettingsChanges(SProject project)	Returns true if settings changes should be shown in builds in the given project
VersionedSettingsConfig	readConfig(SProject project)
void	setContextParameters(SProject project, Map<String,String> parameters)
boolean	shouldTakeSettingsFromVcs(SBuildType buildType, BuildPromotionEx promotion)	Returns true if the given promotion should take settings from VCS, takes buildType's and promotion's options into account.
void	visitProjectsInSettingsRootInstance(VcsRootInstance root, BiConsumer<SProject,VersionedSettingsConfig> consumer)	Visits projects storing settings in the given VCS root instance
void	writeConfig(ConfigAction cause, SProject project, VersionedSettingsConfig config)

Methods inherited from class java.lang.Object

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

Constructor Detail

SecuredVersionedSettingsManager

public SecuredVersionedSettingsManager(@NotNull
                                       VersionedSettingsManager delegate,
                                       @NotNull
                                       SecurityContextEx securityContext)

Method Detail

getVersionedSettingsVcsRoot

@Nullable
public SVcsRoot getVersionedSettingsVcsRoot(@NotNull
                                            SProject project)

Description copied from interface: VersionedSettingsManager

For given project returns VCS root where project settings are stored. Returns null if versioned settings are not configured for given project.

Specified by:

getVersionedSettingsVcsRoot in interface VersionedSettingsManager

Returns:

getOwnVersionedSettingsVcsRoot

@Nullable
public SVcsRoot getOwnVersionedSettingsVcsRoot(@NotNull
                                               SProject project)

Description copied from interface: VersionedSettingsManager

Returns versioned settings root configured for given project ignoring settings inherited from parent project.

Specified by:

getOwnVersionedSettingsVcsRoot in interface VersionedSettingsManager

Parameters:

project - project of interest

Returns:

see above

getProjectsWithOwnVersionedSettings

@NotNull
public Set<SProject> getProjectsWithOwnVersionedSettings()

Description copied from interface: VersionedSettingsManager

Returns set of projects where versioned settings are explicitly enabled (does not include projects with 'same as parent' settings).

Specified by:

getProjectsWithOwnVersionedSettings in interface VersionedSettingsManager

Returns:

see above

getVersionedSettingsVcsRootInstance

@Nullable
public VcsRootInstance getVersionedSettingsVcsRootInstance(@NotNull
                                                           SProject project)

Description copied from interface: VersionedSettingsManager

For given project finds VCS root where project settings are stored, then resolves it's parameters using given project as a context. Returns null if versioned settings are not configured for given project.

Specified by:

getVersionedSettingsVcsRootInstance in interface VersionedSettingsManager

Returns:

getProjectsBySettingsRoot

@NotNull
public Set<SProject> getProjectsBySettingsRoot(@NotNull
                                               VcsRoot root)

Description copied from interface: VersionedSettingsManager

Returns all projects which use the given VCS root for storing settings

Specified by:

getProjectsBySettingsRoot in interface VersionedSettingsManager

Parameters:

root - VCS root of interest

Returns:

see above

getProjectsByOwnSettingsRoot

@NotNull
public Set<SProject> getProjectsByOwnSettingsRoot(@NotNull
                                                  VcsRoot root)

Description copied from interface: VersionedSettingsManager

Returns all projects which explicitly use the given VCS root for storing settings ignoring the settings inherited from parent project

Specified by:

getProjectsByOwnSettingsRoot in interface VersionedSettingsManager

Parameters:

root - VCS root of interest

Returns:

see above

getProjectsByOwnSettingsRootInstance

@NotNull
public Set<SProject> getProjectsByOwnSettingsRootInstance(@NotNull
                                                          VcsRootInstance root)

Description copied from interface: VersionedSettingsManager

Returns all projects which explicitly use the given VCS root instance for storing settings, ignoring the settings inherited from the parent project

Specified by:

getProjectsByOwnSettingsRootInstance in interface VersionedSettingsManager

Parameters:

root - VCS root instance of interest

Returns:

see above

getProjectsBySettingsRootInstance

@NotNull
public Set<SProject> getProjectsBySettingsRootInstance(@NotNull
                                                       VcsRootInstance root)

Description copied from interface: VersionedSettingsManager

Returns all projects which use the given VCS root instance for storing settings

Specified by:

getProjectsBySettingsRootInstance in interface VersionedSettingsManager

Parameters:

root - VCS root instance of interest

Returns:

see above

visitProjectsInSettingsRootInstance

public void visitProjectsInSettingsRootInstance(@NotNull
                                                VcsRootInstance root,
                                                @NotNull
                                                BiConsumer<SProject,VersionedSettingsConfig> consumer)

Description copied from interface: VersionedSettingsManager

Visits projects storing settings in the given VCS root instance

Specified by:

visitProjectsInSettingsRootInstance in interface VersionedSettingsManager

Parameters:

root - VCS root instance of interest

consumer - is called for every visited project and its config

getVersionedSettingsVcsRootInstanceEntry

@Nullable
public VcsRootInstanceEntry getVersionedSettingsVcsRootInstanceEntry(@NotNull
                                                                     SBuildType buildType)

Description copied from interface: VersionedSettingsManager

Returns settings VCS root entry for the given build type or null if versioned settings are not configured for the build type's project

Specified by:

getVersionedSettingsVcsRootInstanceEntry in interface VersionedSettingsManager

Parameters:

buildType - build type of interest

Returns:

see above

getSettingsRootCheckoutRules

@Nullable
public CheckoutRules getSettingsRootCheckoutRules(@NotNull
                                                  SBuildType buildType,
                                                  @NotNull
                                                  VcsRootInstance root)

Description copied from interface: VersionedSettingsManager

Returns settings VCS root checkout rules for given build type or null if versioned settings are not configured for the build type's project or if different root is used to store settings

Specified by:

getSettingsRootCheckoutRules in interface VersionedSettingsManager

Parameters:

buildType - build type of interest

root - settings root

Returns:

see above

getSettingsRootCheckoutRules

@NotNull
public Map<SBuildType,CheckoutRules> getSettingsRootCheckoutRules(@NotNull
                                                                        Collection<SBuildType> buildTypes,
                                                                        @NotNull
                                                                        VcsRootInstance settingsRoot)

Description copied from interface: VersionedSettingsManager

Returns settings VCS root checkout rules for a collection of build types if versioned settings are not configured for the build type's project or if different root is used to store settings then returned map will not contain entry for this build type

Specified by:

getSettingsRootCheckoutRules in interface VersionedSettingsManager

Parameters:

buildTypes - build types of interest

settingsRoot - settings root

Returns:

see above

getEffectiveGenerator

@NotNull
public ProjectSettingsGenerator getEffectiveGenerator(@NotNull
                                                      SProject project)
                                               throws IllegalArgumentException

Description copied from interface: VersionedSettingsManager

Returns effective settings generator for given project or default generator if versioned settings are not configured for given project

Specified by:

getEffectiveGenerator in interface VersionedSettingsManager

Parameters:

project - project of interest

Returns:

see above

Throws:

IllegalArgumentException - if generator is not found for settings format used in project

getEffectiveGeneratorOrNull

@Nullable
public ProjectSettingsGenerator getEffectiveGeneratorOrNull(@NotNull
                                                            SProject project)

Description copied from interface: VersionedSettingsManager

Returns effective settings generator for given project or default generator if versioned settings are not configured for given project, returns null if the generator specified in project settings is not found.

Specified by:

getEffectiveGeneratorOrNull in interface VersionedSettingsManager

Parameters:

project - project of interest

Returns:

see above

getEffectiveFormat

@Nullable
public String getEffectiveFormat(@NotNull
                                 SProject project)

Description copied from interface: VersionedSettingsManager

Returns effective settings format for the given project or null if versioned settings are not configured in the project

Specified by:

getEffectiveFormat in interface VersionedSettingsManager

Parameters:

project - project of interest

Returns:

see above

isProjectWithCustomSettingsFormat

public boolean isProjectWithCustomSettingsFormat(@NotNull
                                                 SProject project)

Description copied from interface: VersionedSettingsManager

Returns true if the specified project uses custom settings format, returns false otherwise

Specified by:

isProjectWithCustomSettingsFormat in interface VersionedSettingsManager

Parameters:

project - project of interest

Returns:

see above

isProjectWithReadOnlySettingsFormat

public boolean isProjectWithReadOnlySettingsFormat(@NotNull
                                                   SProject project)

Description copied from interface: VersionedSettingsManager

Returns true if the specified project uses read-only settings format, returns false otherwise or when configured format is not found

Specified by:

isProjectWithReadOnlySettingsFormat in interface VersionedSettingsManager

Parameters:

project - project of interest

Returns:

see above

getGenerators

@NotNull
public Collection<ProjectSettingsGenerator> getGenerators()

Description copied from interface: VersionedSettingsManager

Returns all registered project settings generators

Specified by:

getGenerators in interface VersionedSettingsManager

Returns:

see above

findGenerator

@Nullable
public ProjectSettingsGenerator findGenerator(@NotNull
                                              String format)

Description copied from interface: VersionedSettingsManager

Returns the project settings generator for the specified format or null if no such generator exist

Specified by:

findGenerator in interface VersionedSettingsManager

Parameters:

format - format of interest

Returns:

see above

getVersionedSettingsProject

@Nullable
public SProject getVersionedSettingsProject(@NotNull
                                            SProject project)

Description copied from interface: VersionedSettingsManager

Returns a project where versioned settings VCS root is configured for given project. Returns null if versioned settings are not configured for given project.

Specified by:

getVersionedSettingsProject in interface VersionedSettingsManager

Returns:

hasVersionedSettings

public boolean hasVersionedSettings(@NotNull
                                    SProject project)

Description copied from interface: VersionedSettingsManager

Returns true if the specified project stores settings in VCS, false otherwise

Specified by:

hasVersionedSettings in interface VersionedSettingsManager

Parameters:

project - project of interest

Returns:

see above

readConfig

@NotNull
public VersionedSettingsConfig readConfig(@NotNull
                                          SProject project)

Specified by:

readConfig in interface VersionedSettingsManager

getEffectiveBuildSettingsMode

@Nullable
public VersionedSettingsConfig.BuildSettingsMode getEffectiveBuildSettingsMode(@NotNull
                                                                               SBuildType buildType)

Description copied from interface: VersionedSettingsManager

Returns build settings mode of a project where versioned settings VCS root is configured for given buildType's project. Returns null if versioned settings are not configured for given buildType's project.

Specified by:

getEffectiveBuildSettingsMode in interface VersionedSettingsManager

Parameters:

buildType - buildType of interest

Returns:

see above

getEffectiveBuildSettingsConfig

@Nullable
public VersionedSettingsConfig getEffectiveBuildSettingsConfig(@NotNull
                                                               SBuildType buildType)

Description copied from interface: VersionedSettingsManager

Returns build settings config of a project where versioned settings VCS root is configured for given buildType's project. Returns null if versioned settings are not configured for given buildType's project.

Specified by:

getEffectiveBuildSettingsConfig in interface VersionedSettingsManager

Parameters:

buildType - buildType of interest

Returns:

see above

getEffectiveBuildSettingsConfig

@Nullable
public VersionedSettingsConfig getEffectiveBuildSettingsConfig(@NotNull
                                                               SProject project)

Description copied from interface: VersionedSettingsManager

Returns settings config of a project where versioned settings VCS root is configured for the given project. Returns null if versioned settings are not configured for the given project.

Specified by:

getEffectiveBuildSettingsConfig in interface VersionedSettingsManager

Returns:

see above

getEffectiveProjectConfig

@Nullable
public Pair<SProject,VersionedSettingsConfig> getEffectiveProjectConfig(@NotNull
                                                                              SProject project)

Description copied from interface: VersionedSettingsManager

Returns project and settings config of a project where versioned settings VCS root is configured for the given project. Returns null if versioned settings are not configured for the given project

Specified by:

getEffectiveProjectConfig in interface VersionedSettingsManager

Parameters:

project - project of interest

Returns:

see above

getEffectiveBuildSettingsMode

@Nullable
public VersionedSettingsConfig.BuildSettingsMode getEffectiveBuildSettingsMode(@NotNull
                                                                               SProject project)

Description copied from interface: VersionedSettingsManager

Returns build settings mode for given project or null if versioned settings are not configured for given project

Specified by:

getEffectiveBuildSettingsMode in interface VersionedSettingsManager

Parameters:

project - project of interest

Returns:

see above

writeConfig

public void writeConfig(@NotNull
                        ConfigAction cause,
                        @NotNull
                        SProject project,
                        @NotNull
                        VersionedSettingsConfig config)

Specified by:

writeConfig in interface VersionedSettingsManager

setContextParameters

public void setContextParameters(@NotNull
                                 SProject project,
                                 @NotNull
                                 Map<String,String> parameters)

Specified by:

setContextParameters in interface VersionedSettingsManager

excludeSettingRoots

@NotNull
public TriggerRules excludeSettingRoots(@Nullable
                                        String rules,
                                        @NotNull
                                        Collection<SBuildType> buildTypes)

Description copied from interface: VersionedSettingsManager

Returns trigger rules which exclude unattached settings VCS roots used in given buildTypes. If the rules contain a rule for a settings VCS root, then this rule is not modified and no new rules for this root are added

Specified by:

excludeSettingRoots in interface VersionedSettingsManager

Parameters:

rules - trigger rules string representation

buildTypes - buildTypes to process

Returns:

see above

isShowSettingsChanges

public boolean isShowSettingsChanges(@NotNull
                                     SProject project)

Description copied from interface: VersionedSettingsManager

Returns true if settings changes should be shown in builds in the given project

Specified by:

isShowSettingsChanges in interface VersionedSettingsManager

Parameters:

project - project of interest

Returns:

see above

isShowBranchesFromVersionedSettingsVcsRoot

public boolean isShowBranchesFromVersionedSettingsVcsRoot(@NotNull
                                                          SBuildType buildType)

Description copied from interface: VersionedSettingsManager

Returns true if branches from the versioned settings VCS root should be shown in the context of the build configuration. Currently, these branches are shown if versioned settings are enabled in the build configuration project and the "Build settings mode" is either "use VCS" or "prefer VCS".

Specified by:

isShowBranchesFromVersionedSettingsVcsRoot in interface VersionedSettingsManager

Returns:

see above

getCredentialsStorageType

@Nullable
public String getCredentialsStorageType(@NotNull
                                        SProject project)

Description copied from interface: VersionedSettingsManager

Returns type of the CredentialsStorage which should be used for versioned settings of the specified project. Returns null, if credentials should be stored in scrambled form in project configuration files.

Specified by:

getCredentialsStorageType in interface VersionedSettingsManager

Parameters:

project - project of interest

Returns:

see above

getSubProjectsWithSameSettings

@NotNull
public Set<SProject> getSubProjectsWithSameSettings(@NotNull
                                                    SProject project)

Description copied from interface: VersionedSettingsManager

Returns transitive sub-projects of the given project which use 'same as parent' versioned settings

Specified by:

getSubProjectsWithSameSettings in interface VersionedSettingsManager

Parameters:

project - project of interest

Returns:

see above

getOptions

@NotNull
public VersionedSettingsOptions getOptions()

Specified by:

getOptions in interface VersionedSettingsManager

shouldTakeSettingsFromVcs

public boolean shouldTakeSettingsFromVcs(@NotNull
                                         SBuildType buildType,
                                         @NotNull
                                         BuildPromotionEx promotion)

Description copied from interface: VersionedSettingsManager

Returns true if the given promotion should take settings from VCS, takes buildType's and promotion's options into account.

Specified by:

shouldTakeSettingsFromVcs in interface VersionedSettingsManager

Parameters:

buildType - build's buildType

promotion - build promotion of interest

Returns:

see above

generateSettingsZip

@NotNull
public List<String> generateSettingsZip(@NotNull
                                        SProject project,
                                        @NotNull
                                        File dst,
                                        @NotNull
                                        String format,
                                        @NotNull
                                        ProjectSettingsGeneratorConfig config)
                                 throws IOException

Description copied from interface: VersionedSettingsManager

Generates zip with project settings in the specified format and writes it to the given dst file. Includes settings of the project and all its subprojects with same versioned settings as in parent recursively.

Specified by:

generateSettingsZip in interface VersionedSettingsManager

Parameters:

project - project of interest

dst - destination zip archive file

format - format

config - config for generation

Returns:

list of errors detected during generation

Throws:

IOException

createEnableConfigActionAfterUpgrade

@NotNull
public ConfigAction createEnableConfigActionAfterUpgrade(int prevVersion,
                                                         int curVersion)

Specified by:

createEnableConfigActionAfterUpgrade in interface VersionedSettingsManager

isEnableSettingsActionAfterUpgrade

public boolean isEnableSettingsActionAfterUpgrade(@NotNull
                                                  ConfigAction configAction)

Specified by:

isEnableSettingsActionAfterUpgrade in interface VersionedSettingsManager

enableVersionedSettings

public boolean enableVersionedSettings()

Description copied from interface: VersionedSettingsManager

Globally enable versioned settings on the server, if the enabling process is not running yet.

Specified by:

enableVersionedSettings in interface VersionedSettingsManager

Returns:

true if versioned settings were enabled as a result of this call

getEffectiveProjectSettingsPaths

@NotNull
public ProjectSettingsPaths getEffectiveProjectSettingsPaths(@NotNull
                                                             SProject project)

Description copied from interface: VersionedSettingsManager

Returns effective Versioned Settings Files Paths for the given project.

Specified by:

getEffectiveProjectSettingsPaths in interface VersionedSettingsManager

Returns:

see above

getSettingsRootRevision

@Nullable
public BuildRevision getSettingsRootRevision(@NotNull
                                             BuildPromotionEx buildPromotion)

Description copied from interface: VersionedSettingsManager

Returns a revision of a settings VCS root for the given build promotion or null if build promotion does not have version settings enabled or checking for changes is not done yet.

Specified by:

getSettingsRootRevision in interface VersionedSettingsManager

Returns:

see above