com.atlassian.bitbucket.settingsrestriction

Interface ProjectSettingsRestrictionService

public interface ProjectSettingsRestrictionService

Service for managing project settings restrictions.

Since:

8.10

Method Summary

Modifier and Type	Method and Description
ProjectSettingsRestriction	create(ProjectSettingsRestrictionCreateRequest restrictionRequest) Creates a new restriction.
void	delete(Project project, SettingsKey settingsKey) Deletes the specified restriction, if it exists.
Optional<ProjectSettingsRestriction>	get(Project project, SettingsKey settingsKey) Retrieves a restriction by it's project and settings key, if one exists.
Set<ProjectSettingsRestriction>	getAll(Project project, String namespace, String featureKey) Retrieves all restrictions by their project with a matching namespace and feature key.
boolean	hasRestriction(Project project, SettingsKey settingsKey) Retrieves a flag indicating whether a restriction exists, specified by its projects and settings key.
boolean	hasRestrictions(Collection<Project> projects, SettingsKey settingsKey) Retrieves a flag indicating whether any restrictions exists for the provided projects, matching the provided settings key.
<T> T	withRestriction(Project project, SettingsKey settingsKey, ProjectSettingsRestrictionAction action, Supplier<T> operation) A wrapper method for the specified operation that updates the restriction for the specified project and settingsKey.

Method Detail

create

@Nonnull
ProjectSettingsRestriction create(@Nonnull
                                           ProjectSettingsRestrictionCreateRequest restrictionRequest)

Creates a new restriction.

Parameters:

restrictionRequest - the request containing the information to store

Returns:

the created project settings restriction

Throws:

AuthorisationException - if the currently authenticated user does not have Permission.PROJECT_ADMIN permission for the provided project

IntegrityException - if a project settings restriction matching the request already exists

delete

void delete(@Nonnull
            Project project,
            @Nonnull
            SettingsKey settingsKey)

Deletes the specified restriction, if it exists. If no restriction exists for the given key and project no operation is taken and no error is reported.

Parameters:

project - the project to check the restriction for

settingsKey - the settings key to check the restriction for

Throws:

ArgumentValidationException - if the project is a personal project

AuthorisationException - if the currently authenticated user does not have Permission.PROJECT_ADMIN permission for the provided project

UnprocessedProjectSettingsRestrictionException - if the project setting restriction is unprocessed

get

@Nonnull
Optional<ProjectSettingsRestriction> get(@Nonnull
                                                  Project project,
                                                  @Nonnull
                                                  SettingsKey settingsKey)

Retrieves a restriction by it's project and settings key, if one exists.

Parameters:

project - the project to check the restriction for

settingsKey - the settings key to check the restriction for

Returns:

an optional containing the restriction, or Optional.empty() if the restriction does not exist

Throws:

AuthorisationException - if the currently authenticated user does not have Permission.PROJECT_VIEW permission for the provided project

getAll

@Nonnull
Set<ProjectSettingsRestriction> getAll(@Nonnull
                                                Project project,
                                                @Nonnull
                                                String namespace,
                                                @Nonnull
                                                String featureKey)

Retrieves all restrictions by their project with a matching namespace and feature key.

This method will return all matching restrictions including restrictions with or without component keys.

Parameters:

project - the project to check the restrictions for

namespace - the namespace of the settings key to check restrictions for

featureKey - the feature key of the settings key to check restrictions for

Returns:

a set containing all matching restrictions

Throws:

AuthorisationException - if the currently authenticated user does not have Permission.PROJECT_VIEW permission for the provided project

hasRestriction

boolean hasRestriction(@Nonnull
                       Project project,
                       @Nonnull
                       SettingsKey settingsKey)

Retrieves a flag indicating whether a restriction exists, specified by its projects and settings key.

This method will only return true if a restriction is found for the specified project that matches all of SettingsKey.getNamespace(), SettingsKey.getFeatureKey() and SettingsKey.getComponentKey().

Parameters:

project - the project to check restrictions for

settingsKey - the settings key to check restrictions for

Returns:

true if the project has a restriction for the specified settings key, otherwise false

Throws:

AuthorisationException - if the currently authenticated user does not have Permission.PROJECT_VIEW permission for the provided project

hasRestrictions

boolean hasRestrictions(@Nonnull
                        Collection<Project> projects,
                        @Nonnull
                        SettingsKey settingsKey)

Retrieves a flag indicating whether any restrictions exists for the provided projects, matching the provided settings key.

This method will only return true if a restriction is found for the specified project that matches all of SettingsKey.getNamespace(), SettingsKey.getFeatureKey() and SettingsKey.getComponentKey().

Parameters:

projects - the projects to check restrictions for

settingsKey - the settings key to check restrictions for

Returns:

true if at least one project has a restriction for the specified settings key, otherwise false

Throws:

AuthorisationException - if the currently authenticated user does not have Permission.PROJECT_VIEW permission for the provided projects

withRestriction

@Nonnull
<T> T withRestriction(@Nonnull
                               Project project,
                               @Nonnull
                               SettingsKey settingsKey,
                               @Nonnull
                               ProjectSettingsRestrictionAction action,
                               @Nonnull
                               Supplier<T> operation)

A wrapper method for the specified operation that updates the restriction for the specified project and settingsKey.

Type Parameters:

T - the return type of the supplied operation

Parameters:

project - the project that the restriction will be applied to

settingsKey - the settings key that the restriction will be applied to

action - the restriction update action to perform

operation - the operation that is executed

Returns:

the result of the supplied operation