@ExperimentalApi
public interface PlanConfigImportService
Modifier and Type | Method and Description |
---|---|
com.atlassian.bamboo.specs.api.model.plan.PlanProperties |
convertYamlToPlan(String yaml)
Converts data from a YAML document to top level plan properties.
|
ImmutableTopLevelPlan |
importPlan(com.atlassian.bamboo.specs.api.model.plan.PlanProperties planProperties,
com.atlassian.user.User userForCreation,
RssPermissions rssPermissions)
Validates exported top level plan properties within Bamboo context (e.g.
|
void |
validatePlanProperties(com.atlassian.bamboo.specs.api.model.plan.PlanProperties planProperties,
RssPermissions rssPermissions)
This method performs validation of YAML types and of the properties without Bamboo context (e.g.
|
@NotNull com.atlassian.bamboo.specs.api.model.plan.PlanProperties convertYamlToPlan(@NotNull String yaml) throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException, YamlValidationException
yaml
- YAML String containing definition of top level planYamlValidationException
- if the format of the YAML file is invalidcom.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException
void validatePlanProperties(@NotNull com.atlassian.bamboo.specs.api.model.plan.PlanProperties planProperties, @NotNull RssPermissions rssPermissions) throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException, YamlValidationException, RssPermissionException
planProperties
- top level plan propertiesrssPermissions
- projects which can allowed for modificationYamlValidationException
- if the format of the YAML file is invalidcom.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException
- if the imported properties were not validRssPermissionException
- if RSS is missing access to projects/repositories@NotNull ImmutableTopLevelPlan importPlan(@NotNull com.atlassian.bamboo.specs.api.model.plan.PlanProperties planProperties, @Nullable com.atlassian.user.User userForCreation, @NotNull RssPermissions rssPermissions) throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException, UnauthorisedException, RssPermissionException
planProperties
- top level plan properties to importuserForCreation
- user invoking the importrssPermissions
- projects which can allowed for modification; since 6.2com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException
- if data validation failsRssPermissionException
- if rss doesn't have access to dependant projectUnauthorisedException
- if any other type of permission is missingCopyright © 2018 Atlassian Software Systems Pty Ltd. All rights reserved.