Package com.activeviam.tech.mvcc.api.security.impl

Class BranchPermissionsManager

java.lang.Object

com.activeviam.tech.mvcc.api.security.impl.BranchPermissionsManager

All Implemented Interfaces:

IBranchPermissionsManager

public final class BranchPermissionsManager
extends Object
implements IBranchPermissionsManager

Simple implementation of the IBranchPermissionsManager, with a map associating a BranchPermissions to each branch name.

Author:

ActiveViam

Constructor Summary

Constructors

Constructor	Description
BranchPermissionsManager(Set<String> allowedBranchCreators, Set<String> defaultOwnerPermissions, Set<String> defaultReaderPermissions)	Constructor of BranchPermissionsManager.

Method Summary

Modifier and Type	Method	Description
boolean	canCreateBranch(Set<String> userNameAndRoles)	Given their username and their roles, returns true if the current user can create a branch, false otherwise.
static BranchPermissionsManager	forTests()	Gets a BranchPermissionsManager which allows all users to create, read and edit all branches.
IBranchPermissions	getBranchPermissions(String branchName)	Gets the permissions of a specific branch.
Set<String>	getOwnedBranches(Set<String> userRoles)	Gets the set of branches (registered in this service) that the user with the given roles own.
Set<String>	getReadableBranches(Set<String> userRoles)	Gets the set of branches (registered in this service) that the given roles can read.
void	registerBranchPermissionsListener(IBranchPermissionsListener branchPermissionsListener)	Registers a listener for the permissions of a set of branches.
void	removeBranchPermissions(String branchName)	Removes the branch's permissions from the service.
void	setBranchPermissions(String branchName, IBranchPermissions permissions)	Sets the permissions of a specific branch.
void	unregisterBranchPermissionsListener(IBranchPermissionsListener branchPermissionsListener)	Unregisters a listener for the permissions of a set of branches.
static BranchPermissionsManager	withoutRestrictions()	Gets a BranchPermissionsManager which allows all users to create, read and edit all branches.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.activeviam.tech.mvcc.api.security.IBranchPermissionsManager

canDeleteBranch, canEditBranch, canReadBranch

Constructor Details

BranchPermissionsManager

public BranchPermissionsManager(Set<String> allowedBranchCreators,
 Set<String> defaultOwnerPermissions,
 Set<String> defaultReaderPermissions)

Constructor of BranchPermissionsManager. Null values or empty sets are interpreted as "no user has the permission for [...]"; use IBranchPermissions.ALL_USERS_ALLOWED for "all users have the permission for [...]".

Parameters:

allowedBranchCreators - the set of users and roles allowed to create branches, use IBranchPermissions.ALL_USERS_ALLOWED to allow all users to create branches

defaultOwnerPermissions - the default set of users who own branches, it is the fallback to retrieve user write permissions in the case where a branch exists but was not registered in this manager, use IBranchPermissions.ALL_USERS_ALLOWED to allow all users to edit branches

defaultReaderPermissions - the default set of users who can read branches, it is the fallback to retrieve user read permissions in the case where a branch exists but was not registered in this manager, use IBranchPermissions.ALL_USERS_ALLOWED to allow all users to read branches

Method Details

withoutRestrictions

public static BranchPermissionsManager withoutRestrictions()

Gets a BranchPermissionsManager which allows all users to create, read and edit all branches.

forTests

public static BranchPermissionsManager forTests()

Gets a BranchPermissionsManager which allows all users to create, read and edit all branches.

Returns:

a new BranchPermissionsManager with all users allowed for all operations

canCreateBranch

public boolean canCreateBranch(Set<String> userNameAndRoles)

Description copied from interface: IBranchPermissionsManager

Given their username and their roles, returns true if the current user can create a branch, false otherwise.

Specified by:

canCreateBranch in interface IBranchPermissionsManager

Parameters:

userNameAndRoles - the current user's set of roles/name

Returns:

true if the current user can create a branch, false otherwise

removeBranchPermissions

public void removeBranchPermissions(String branchName)

Description copied from interface: IBranchPermissionsManager

Removes the branch's permissions from the service. The default permissions for this manager will become the new permissions of this branch.

Specified by:

removeBranchPermissions in interface IBranchPermissionsManager

Parameters:

branchName - the name of the branch which will be removed

getBranchPermissions

public IBranchPermissions getBranchPermissions(String branchName)

Description copied from interface: IBranchPermissionsManager

Gets the permissions of a specific branch.

Specified by:

getBranchPermissions in interface IBranchPermissionsManager

Parameters:

branchName - the name of the branch of which we want to know the permissions

Returns:

the permissions for this branch

getOwnedBranches

public Set<String> getOwnedBranches(Set<String> userRoles)

Description copied from interface: IBranchPermissionsManager

Gets the set of branches (registered in this service) that the user with the given roles own.

Specified by:

getOwnedBranches in interface IBranchPermissionsManager

Parameters:

userRoles - the given user's authorized roles

Returns:

the set of branches (registered in this service) that the user with the given roles owns

getReadableBranches

public Set<String> getReadableBranches(Set<String> userRoles)

Description copied from interface: IBranchPermissionsManager

Gets the set of branches (registered in this service) that the given roles can read.

Specified by:

getReadableBranches in interface IBranchPermissionsManager

Parameters:

userRoles - the given user's authorized roles

Returns:

the set of branches (registered in this service) that the given user can read

setBranchPermissions

public void setBranchPermissions(String branchName,
 IBranchPermissions permissions)

Description copied from interface: IBranchPermissionsManager

Sets the permissions of a specific branch.

Specified by:

setBranchPermissions in interface IBranchPermissionsManager

Parameters:

branchName - the name of the branch of which we want to edit the permissions

permissions - the updated permissions for this branch

registerBranchPermissionsListener

public void registerBranchPermissionsListener(IBranchPermissionsListener branchPermissionsListener)

Description copied from interface: IBranchPermissionsManager

Registers a listener for the permissions of a set of branches.

Specified by:

registerBranchPermissionsListener in interface IBranchPermissionsManager

Parameters:

branchPermissionsListener - the listener which should be registered

unregisterBranchPermissionsListener

public void unregisterBranchPermissionsListener(IBranchPermissionsListener branchPermissionsListener)

Description copied from interface: IBranchPermissionsManager

Unregisters a listener for the permissions of a set of branches.

Specified by:

unregisterBranchPermissionsListener in interface IBranchPermissionsManager

Parameters:

branchPermissionsListener - the listener which should be unregistered