org.jbei.ice.lib.access

Class PermissionsController

java.lang.Object

org.jbei.ice.lib.access.PermissionsController

public class PermissionsController
extends Object

Controller for permissions

Author:

Hector Plahar

Constructor Summary

Constructors

Constructor and Description
PermissionsController()

Method Summary

Modifier and Type	Method and Description
boolean	accountHasReadPermission(Account account, Set<Folder> folders)
boolean	accountHasWritePermission(Account account, Set<Folder> folders)
protected Permission	addPermission(AccessPermission access, Entry entry, Folder folder, BulkUpload upload)
Permission	addPermission(String userId, AccessPermission access)
boolean	groupHasReadPermission(List<Group> groups, Set<Folder> folders)
boolean	groupHasWritePermission(List<Group> groups, Set<Folder> folders)
boolean	hasWritePermission(String userId, Folder folder)
boolean	isPubliclyVisible(Entry entry) Determines whether an entry has assigned public privileges either directly or by virtue of being in a folder that has public privileges assigned
boolean	isPublicVisible(Folder folder)
boolean	propagateFolderPermissions(String userId, Folder folder, boolean add) Propagates the permissions for the folder to the contained entries
void	removePermission(String userId, AccessPermission access)
List<AccessPermission>	retrieveSetFolderPermission(Folder folder, boolean includePublic) Retrieves permissions that have been explicitly set for the folders with the exception of the public read permission if specified in the parameter.
FolderDetails	setFolderPermissions(String userId, long folderId, List<AccessPermission> permissions)

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionsController

public PermissionsController()

Method Detail

addPermission

public Permission addPermission(String userId,
                                AccessPermission access)

addPermission

protected Permission addPermission(AccessPermission access,
                                   Entry entry,
                                   Folder folder,
                                   BulkUpload upload)

removePermission

public void removePermission(String userId,
                             AccessPermission access)

accountHasReadPermission

public boolean accountHasReadPermission(Account account,
                                        Set<Folder> folders)

accountHasWritePermission

public boolean accountHasWritePermission(Account account,
                                         Set<Folder> folders)

groupHasWritePermission

public boolean groupHasWritePermission(List<Group> groups,
                                       Set<Folder> folders)

isPubliclyVisible

public boolean isPubliclyVisible(Entry entry)

Determines whether an entry has assigned public privileges either directly or by virtue of being in a folder that has public privileges assigned

Parameters:

entry - entry being checked for public read privileges

Returns:

true if the entry has public read privileges, false otherwise

isPublicVisible

public boolean isPublicVisible(Folder folder)

groupHasReadPermission

public boolean groupHasReadPermission(List<Group> groups,
                                      Set<Folder> folders)

hasWritePermission

public boolean hasWritePermission(String userId,
                                  Folder folder)

retrieveSetFolderPermission

public List<AccessPermission> retrieveSetFolderPermission(Folder folder,
                                                          boolean includePublic)

Retrieves permissions that have been explicitly set for the folders with the exception of the public read permission if specified in the parameter. The call for that is a separate method

Parameters:

folder - folder whose permissions are being retrieved

includePublic - whether to include public access if set

Returns:

list of permissions that have been found for the specified folder

propagateFolderPermissions

public boolean propagateFolderPermissions(String userId,
                                          Folder folder,
                                          boolean add)

Propagates the permissions for the folder to the contained entries

Parameters:

userId - unique identifier for account of user requesting action that led to this call

folder - folder user permissions are being propagated

add - true if folder is to be added, false otherwise

Returns:

true if action permission was scheduled to be propagated

setFolderPermissions

public FolderDetails setFolderPermissions(String userId,
                                          long folderId,
                                          List<AccessPermission> permissions)