Package com.atlassian.bamboo.project

Class ProjectConfigurationServiceImpl

java.lang.Object

com.atlassian.bamboo.project.ProjectConfigurationServiceImpl

All Implemented Interfaces:

ProjectConfigurationService

public class ProjectConfigurationServiceImpl
extends Object
implements ProjectConfigurationService

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROJECT_DESCRIPTION_FIELD
static String	PROJECT_KEY_FIELD
static String	PROJECT_NAME_FIELD

Constructor Summary

Constructors

Constructor	Description
ProjectConfigurationServiceImpl(PlanManager planManager, ProjectManager projectManager, com.atlassian.struts.TextProvider textProvider, ValidationService validationService, AuditLogService auditLogService, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method	Description
@NotNull Project	createProject(@NotNull String projectKey, @NotNull String projectName, @Nullable String projectDescription, boolean grantAllUsersReadAccess)	Creates and persists a new Project, throwing an exception on invalid data.
void	markProjectForDeletion(@NotNull Project project)	Marks a project for deletion.
void	updateProject(@NotNull Project project, @NotNull String projectName, @Nullable String projectDescription)	Updates and persists changes for an existing Project, throwing exception on invalid data.
@NotNull ErrorCollection	validateProjectForCreation(@NotNull String projectKeyField, @Nullable String projectKey, @NotNull String projectNameField, @Nullable String projectName, @NotNull String projectDescriptionField, @Nullable String projectDescription)	Perform validation of data for creation of a new Project.
@NotNull ErrorCollection	validateProjectForCreation(@Nullable String projectKey, @Nullable String projectName, @Nullable String projectDescription)	Perform validation of data for creation of a new Project.
@NotNull ErrorCollection	validateProjectForUpdate(@NotNull String projectKey, @NotNull String projectNameField, @Nullable String projectName, @NotNull String projectDescriptionField, @Nullable String projectDescription)	Perform validation of data for updating details of an existing Project.
@NotNull ErrorCollection	validateProjectForUpdate(@NotNull String projectKey, @Nullable String projectName, @Nullable String projectDescription)	Perform validation of data for updating details of an existing Project.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.project.ProjectConfigurationService

createProject

Field Detail

PROJECT_KEY_FIELD

public static final String PROJECT_KEY_FIELD

PROJECT_NAME_FIELD

public static final String PROJECT_NAME_FIELD

PROJECT_DESCRIPTION_FIELD

public static final String PROJECT_DESCRIPTION_FIELD

Constructor Detail

ProjectConfigurationServiceImpl

@Autowired
public ProjectConfigurationServiceImpl(PlanManager planManager,
                                       ProjectManager projectManager,
                                       com.atlassian.struts.TextProvider textProvider,
                                       ValidationService validationService,
                                       AuditLogService auditLogService,
                                       com.atlassian.event.api.EventPublisher eventPublisher)

Method Detail

validateProjectForCreation

@NotNull
public @NotNull ErrorCollection validateProjectForCreation(@Nullable
                                                           @Nullable String projectKey,
                                                           @Nullable
                                                           @Nullable String projectName,
                                                           @Nullable
                                                           @Nullable String projectDescription)

Description copied from interface: ProjectConfigurationService

Perform validation of data for creation of a new Project.

Specified by:

validateProjectForCreation in interface ProjectConfigurationService

Parameters:

projectKey - key of the project

projectName - project name

projectDescription - project description

Returns:

collection of all validation errors, empty if validation was successful

validateProjectForCreation

@NotNull
public @NotNull ErrorCollection validateProjectForCreation(@NotNull
                                                           @NotNull String projectKeyField,
                                                           @Nullable
                                                           @Nullable String projectKey,
                                                           @NotNull
                                                           @NotNull String projectNameField,
                                                           @Nullable
                                                           @Nullable String projectName,
                                                           @NotNull
                                                           @NotNull String projectDescriptionField,
                                                           @Nullable
                                                           @Nullable String projectDescription)

Description copied from interface: ProjectConfigurationService

Perform validation of data for creation of a new Project.

This is a more specific version of ProjectConfigurationService.validateProjectForCreation(String, String, String), allowing configuration of field names to generate more accurate ErrorCollection.

Specified by:

validateProjectForCreation in interface ProjectConfigurationService

Parameters:

projectKeyField - field used to configure project key

projectKey - key of the project

projectNameField - field used to configure project name

projectName - project name

projectDescriptionField - field used to configure project description

projectDescription - project description

Returns:

collection of all validation errors, empty if validation was successful

createProject

@NotNull
public @NotNull Project createProject(@NotNull
                                      @NotNull String projectKey,
                                      @NotNull
                                      @NotNull String projectName,
                                      @Nullable
                                      @Nullable String projectDescription,
                                      boolean grantAllUsersReadAccess)
                               throws WebValidationException

Description copied from interface: ProjectConfigurationService

Creates and persists a new Project, throwing an exception on invalid data. Prior to calling this method data should be validated by calling ProjectConfigurationService.validateProjectForCreation(String, String, String).

Specified by:

createProject in interface ProjectConfigurationService

Parameters:

projectKey - key of the project

projectName - project name

projectDescription - project description

grantAllUsersReadAccess - grant anonymous and logged-in users READ permissions

Returns:

new instance of the project, after persisting it to the database

Throws:

WebValidationException - in case of validation errors

validateProjectForUpdate

@NotNull
public @NotNull ErrorCollection validateProjectForUpdate(@NotNull
                                                         @NotNull String projectKey,
                                                         @Nullable
                                                         @Nullable String projectName,
                                                         @Nullable
                                                         @Nullable String projectDescription)

Description copied from interface: ProjectConfigurationService

Perform validation of data for updating details of an existing Project.

Specified by:

validateProjectForUpdate in interface ProjectConfigurationService

Parameters:

projectKey - key of the project

projectName - new project name

projectDescription - new project description

Returns:

collection of all validation errors, empty if validation was successful

validateProjectForUpdate

@NotNull
public @NotNull ErrorCollection validateProjectForUpdate(@NotNull
                                                         @NotNull String projectKey,
                                                         @NotNull
                                                         @NotNull String projectNameField,
                                                         @Nullable
                                                         @Nullable String projectName,
                                                         @NotNull
                                                         @NotNull String projectDescriptionField,
                                                         @Nullable
                                                         @Nullable String projectDescription)

Description copied from interface: ProjectConfigurationService

Perform validation of data for updating details of an existing Project.

This is a more specific version of ProjectConfigurationService.validateProjectForUpdate(String, String, String), allowing configuration of field names to generate more accurate ErrorCollection.

Specified by:

validateProjectForUpdate in interface ProjectConfigurationService

Parameters:

projectKey - key of the project

projectNameField - field used to configure project name

projectName - new project name

projectDescriptionField - field used to configure project description

projectDescription - new project description

Returns:

collection of all validation errors, empty if validation was successful

updateProject

public void updateProject(@NotNull
                          @NotNull Project project,
                          @NotNull
                          @NotNull String projectName,
                          @Nullable
                          @Nullable String projectDescription)
                   throws WebValidationException

Description copied from interface: ProjectConfigurationService

Updates and persists changes for an existing Project, throwing exception on invalid data. Prior to calling this method data should be validated by calling ProjectConfigurationService.validateProjectForUpdate(String, String, String).

Specified by:

updateProject in interface ProjectConfigurationService

Parameters:

project - project to update

projectName - new project name

projectDescription - new project description

Throws:

WebValidationException - in case of validation errors

markProjectForDeletion

public void markProjectForDeletion(@NotNull
                                   @NotNull Project project)

Description copied from interface: ProjectConfigurationService

Marks a project for deletion. Project will be deleted from the database according to background deletion schedule. Project must be empty prior to calling this method (there can't be any plans within the project that are not marked for deletion).

Specified by:

markProjectForDeletion in interface ProjectConfigurationService

Parameters:

project - project to delete