Interface PlanPermissionService
-
- All Known Implementing Classes:
PlanPermissionServiceImpl
@ExperimentalApi public interface PlanPermissionService
Service to import/export plan permissions.- Since:
- 6.1.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @NotNull com.atlassian.bamboo.specs.api.model.permission.PlanPermissionsProperties
convertYamlToPlanPermission(@NotNull String yaml)
Converts data from a YAML document to plan permission properties.com.atlassian.bamboo.specs.api.model.permission.PlanPermissionsProperties
exportPlanPermission(com.atlassian.bamboo.specs.api.model.plan.PlanIdentifierProperties planIdentifier)
Export plan permission asPlanPermissionsProperties
identified byPlanIdentifierProperties
void
importPlanPermission(com.atlassian.bamboo.specs.api.model.permission.PlanPermissionsProperties planPermissionProperties, RssPermissions rssPermissions)
ImportPlanPermissionsProperties
-
-
-
Method Detail
-
convertYamlToPlanPermission
@NotNull @NotNull com.atlassian.bamboo.specs.api.model.permission.PlanPermissionsProperties convertYamlToPlanPermission(@NotNull @NotNull String yaml) throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException, YamlValidationException
Converts data from a YAML document to plan permission properties. This method performs validation of YAML types and of the properties.- Parameters:
yaml
- YAML String containing definition of plan permission- Returns:
- plan permission properties
- Throws:
YamlValidationException
- if the format of the YAML file is invalidcom.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException
- if the imported properties were not valid
-
importPlanPermission
void importPlanPermission(com.atlassian.bamboo.specs.api.model.permission.PlanPermissionsProperties planPermissionProperties, RssPermissions rssPermissions) throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException, UnauthorisedException
ImportPlanPermissionsProperties
- Parameters:
planPermissionProperties
- plan permissionsrssPermissions
- permissions granted for this operation; since 6.2.0- Throws:
com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException
- if properties are invalidUnauthorisedException
- when user is not allowed to create or update plan permission
-
exportPlanPermission
com.atlassian.bamboo.specs.api.model.permission.PlanPermissionsProperties exportPlanPermission(com.atlassian.bamboo.specs.api.model.plan.PlanIdentifierProperties planIdentifier)
Export plan permission asPlanPermissionsProperties
identified byPlanIdentifierProperties
- Parameters:
planIdentifier
-- Returns:
- plan permission
-
-