|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.basedb.core.UserPermissions
public class UserPermissions
This class is used to specify permissions to share an item to users. It is a three-step procedure:
ItemKey
using this object as one of the
input parameters to ItemKey.getNewOrExisting(DbControl, UserPermissions, GroupPermissions)
Shareable.setItemKey(ItemKey)
ItemKey
,
GroupPermissions
,
ProjectPermissions
Field Summary | |
---|---|
private Map<UserData,Integer> |
originalPermissions
|
private Map<UserData,Integer> |
userPermissions
|
Constructor Summary | |
---|---|
UserPermissions()
Create a new empty object. |
|
UserPermissions(ItemKey itemKey)
Create a new object, and initialise it with the permissions from a ItemKey . |
Method Summary | |
---|---|
void |
addPermissions(User user,
Set<Permission> permissions)
Grant permissions to a user, keeping those that have already been set. |
(package private) Map<UserData,Integer> |
getOriginalPermissions()
Get the internal representation of the original permissions. |
Set<Permission> |
getOriginalPermissions(User user)
Get the original permissions for a user if this object was created with the UserPermissions(ItemKey) constructor. |
Set<Permission> |
getPermissions(User user)
Get the permissions for a user. |
(package private) Map<UserData,Integer> |
getUserPermissions()
Get the internal representation of the permissions. |
boolean |
hasChanged(User user)
Check if the current permissions for the user has been changed from the original permissions. |
void |
merge(ItemKey itemKey)
Merge the permissions for all users from the given item key with the permissions in this object. |
void |
setPermissions(User user,
Set<Permission> permissions)
Grant permissions to a user. |
int |
size()
Get the number of entries. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private final Map<UserData,Integer> userPermissions
private final Map<UserData,Integer> originalPermissions
Constructor Detail |
---|
public UserPermissions()
public UserPermissions(ItemKey itemKey) throws InvalidDataException
ItemKey
.
itemKey
- The item key from which we take the current permissions
InvalidDataException
- If the item key is nullMethod Detail |
---|
public void merge(ItemKey itemKey)
itemKey
- An item key (if null, this method simply returns)public void setPermissions(User user, Set<Permission> permissions) throws InvalidDataException
Set
or null
to remove all permissions for the user.
user
- The User
permissions
- The permissions to grant
InvalidDataException
- If the user is nullPermission
public void addPermissions(User user, Set<Permission> permissions) throws InvalidDataException
user
- The User
permissions
- The permissions to grant
InvalidDataException
- If the user is nullPermission
public Set<Permission> getPermissions(User user) throws InvalidDataException
user
- The User
for which we want to get the permission
Set
containing the granted permissions, or an
empty set if no permissions have been granted
InvalidDataException
- If the user is nullgetOriginalPermissions(User)
,
Permission
public Set<Permission> getOriginalPermissions(User user)
UserPermissions(ItemKey)
constructor.
user
- The User
for which we want to get the permission
Set
containing the original permissions, or an
empty set
InvalidDataException
- If the user is nullgetPermissions(User)
public boolean hasChanged(User user)
getPermissions(User)
returns a set with the same permissions getOriginalPermissions(User)
.
user
- The user to check
InvalidDataException
- If the user is nullpublic int size()
final Map<UserData,Integer> getUserPermissions()
final Map<UserData,Integer> getOriginalPermissions()
|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |