com.atlassian.bamboo.configuration.external

Interface SpecsConsumer

@ExperimentalApi
public interface SpecsConsumer

Consumer used for importing Specs execution results

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SpecsConsumer.PlanPropertiesSupplier

Method Summary

Modifier and Type	Method and Description
void	importDeploymentPermissions(com.atlassian.bamboo.specs.api.model.permission.DeploymentPermissionsProperties deploymentPermissions, RssPermissions rssPermissions) Import deployment permission properties
void	importDeploymentProperties(com.atlassian.bamboo.specs.api.model.deployment.DeploymentProperties deploymentProperties, RssPermissions rssPermissions, boolean noChangesInProperties) Import deployment properties
void	importEnvironmentPermissions(com.atlassian.bamboo.specs.api.model.permission.EnvironmentPermissionsProperties environmentPermissions, RssPermissions rssPermissions) Import environment permission properties
void	importEnvironmentPermissions(String deploymentName, com.atlassian.bamboo.specs.api.model.BambooOidProperties deploymentOid, List<com.atlassian.bamboo.specs.api.model.permission.EnvironmentPermissionsProperties> environmentsPermissions, com.atlassian.bamboo.specs.api.model.permission.PermissionsProperties defaultEnvironmentPermissions, RssPermissions rssPermissions) Bulk import environment permission properties
void	importPlanPermissions(RssPermissions rssPermissions, com.atlassian.bamboo.specs.api.model.permission.PlanPermissionsProperties planPermissions) Import plan permission properties
void	importPlanProperties(SpecsConsumer.PlanPropertiesSupplier topLevelPlanPropertiesSupplier, RssPermissions rssPermissions, VcsRepositoryData vcsRepositoryData, List<CommitContext> commits, com.atlassian.utils.process.OutputHandler stdout, SpecsType specsType, boolean noChangesInPlanProperties) Import plan properties
SpecsConsumer	mergeConsumers(SpecsConsumer other) Merge this consumer with another one, creating consumer that will create/update all affected objects exactly once.
void	onError(VcsRepositoryData vcsRepositoryData, List<CommitContext> commits, VcsBambooSpecsSource specsSource, RssPermissions rssPermissions, com.atlassian.utils.process.OutputHandler stdout, Throwable throwable) Handle problem with specs import
void	onSpecsRevisionNotFound() Handle the state when there's no revision that contains specs on the repository branch.
void	onSuccess(VcsRepositoryData vcsRepositoryData, List<CommitContext> commits, VcsLocationBambooSpecsState specsState, RssPermissions rssPermissions, VcsLocationBambooSpecsState bambooSpecsState, com.atlassian.utils.process.OutputHandler stdout) Handle specs execution success
void	onYamlValidationError(VcsRepositoryData vcsRepositoryData, List<CommitContext> commits, VcsBambooSpecsSource specsSource, RssPermissions rssPermissions, com.atlassian.utils.process.OutputHandler stdout, Exception throwable) Handle problem with yaml validation
boolean	processSpecsDirectoryRemoval(VcsRepositoryData repository, VcsLocationBambooSpecsState specsState, List<CommitContext> commits, RssPermissions rssPermissions, com.atlassian.utils.process.OutputHandler stdout) Handle situation where no Specs have been found in the repository (for the current revision)

Method Detail

importPlanProperties

void importPlanProperties(@NotNull
                          SpecsConsumer.PlanPropertiesSupplier topLevelPlanPropertiesSupplier,
                          @NotNull
                          RssPermissions rssPermissions,
                          @NotNull
                          VcsRepositoryData vcsRepositoryData,
                          @NotNull
                          List<CommitContext> commits,
                          @NotNull
                          com.atlassian.utils.process.OutputHandler stdout,
                          @NotNull
                          SpecsType specsType,
                          boolean noChangesInPlanProperties)

Import plan properties

importPlanPermissions

void importPlanPermissions(@NotNull
                           RssPermissions rssPermissions,
                           @NotNull
                           com.atlassian.bamboo.specs.api.model.permission.PlanPermissionsProperties planPermissions)

Import plan permission properties

importDeploymentProperties

void importDeploymentProperties(@NotNull
                                com.atlassian.bamboo.specs.api.model.deployment.DeploymentProperties deploymentProperties,
                                @NotNull
                                RssPermissions rssPermissions,
                                boolean noChangesInProperties)

Import deployment properties

importDeploymentPermissions

void importDeploymentPermissions(@NotNull
                                 com.atlassian.bamboo.specs.api.model.permission.DeploymentPermissionsProperties deploymentPermissions,
                                 @NotNull
                                 RssPermissions rssPermissions)

Import deployment permission properties

importEnvironmentPermissions

void importEnvironmentPermissions(@NotNull
                                  com.atlassian.bamboo.specs.api.model.permission.EnvironmentPermissionsProperties environmentPermissions,
                                  @NotNull
                                  RssPermissions rssPermissions)

Import environment permission properties

importEnvironmentPermissions

void importEnvironmentPermissions(@NotNull
                                  String deploymentName,
                                  @NotNull
                                  com.atlassian.bamboo.specs.api.model.BambooOidProperties deploymentOid,
                                  @NotNull
                                  List<com.atlassian.bamboo.specs.api.model.permission.EnvironmentPermissionsProperties> environmentsPermissions,
                                  @NotNull
                                  com.atlassian.bamboo.specs.api.model.permission.PermissionsProperties defaultEnvironmentPermissions,
                                  @NotNull
                                  RssPermissions rssPermissions)

Bulk import environment permission properties

processSpecsDirectoryRemoval

boolean processSpecsDirectoryRemoval(@NotNull
                                     VcsRepositoryData repository,
                                     @NotNull
                                     VcsLocationBambooSpecsState specsState,
                                     @NotNull
                                     List<CommitContext> commits,
                                     @NotNull
                                     RssPermissions rssPermissions,
                                     @NotNull
                                     com.atlassian.utils.process.OutputHandler stdout)

Handle situation where no Specs have been found in the repository (for the current revision)

onSpecsRevisionNotFound

void onSpecsRevisionNotFound()

Handle the state when there's no revision that contains specs on the repository branch.

onError

void onError(@NotNull
             VcsRepositoryData vcsRepositoryData,
             @NotNull
             List<CommitContext> commits,
             @NotNull
             VcsBambooSpecsSource specsSource,
             @NotNull
             RssPermissions rssPermissions,
             @NotNull
             com.atlassian.utils.process.OutputHandler stdout,
             @NotNull
             Throwable throwable)

Handle problem with specs import

onYamlValidationError

void onYamlValidationError(@NotNull
                           VcsRepositoryData vcsRepositoryData,
                           @NotNull
                           List<CommitContext> commits,
                           @NotNull
                           VcsBambooSpecsSource specsSource,
                           @NotNull
                           RssPermissions rssPermissions,
                           @NotNull
                           com.atlassian.utils.process.OutputHandler stdout,
                           @NotNull
                           Exception throwable)

Handle problem with yaml validation

onSuccess

void onSuccess(@NotNull
               VcsRepositoryData vcsRepositoryData,
               @NotNull
               List<CommitContext> commits,
               @NotNull
               VcsLocationBambooSpecsState specsState,
               @NotNull
               RssPermissions rssPermissions,
               @NotNull
               VcsLocationBambooSpecsState bambooSpecsState,
               @NotNull
               com.atlassian.utils.process.OutputHandler stdout)

Handle specs execution success

mergeConsumers

SpecsConsumer mergeConsumers(@NotNull
                             SpecsConsumer other)

Merge this consumer with another one, creating consumer that will create/update all affected objects exactly once.