com.logicaldoc.core.security

Interface SecurityManager

All Known Implementing Classes:

SecurityManagerImpl

public interface SecurityManager

Manager on security issues such as users and groups

Since:

3.0

Author:

Marco Meschieri - Logical Objects

Method Summary

Methods

Modifier and Type	Method and Description
void	assignUsersToGroup(Collection<User> users, Group group) Assign a collection of users to a group.
void	assignUserToGroup(User user, Group group) Assign a user to a group.
void	assignUserToGroups(User user, Collection<Group> groups) Assign a user to a collection of groups.
void	assignUserToGroups(User user, long[] groupIds) Assign a user to a collection of groups.
Set<Group>	getAllowedGroups(long menuId) Retrieves the collection of groups that can access the given menu
boolean	isMemberOf(long userId, long groupId) Checks if a given user is member of a particular group
boolean	isMemberOf(long userId, String groupName) Checks if a given user is member of a particular group
void	removeAllUsersFromGroup(Group group) Removes all users from group
void	removeUserFromAllGroups(User user) Removes the specified user from a all groups except it's user's group
void	removeUserFromGroup(User user, Group group) Removes the specified user from a group.
void	removeUsersFromGroup(Collection<User> users, Group group) Removes the specified users from a group.

Method Detail

assignUsersToGroup

void assignUsersToGroup(Collection<User> users,
                      Group group)

Assign a collection of users to a group.

Parameters:

users - The users collection

group - The group

assignUserToGroups

void assignUserToGroups(User user,
                      Collection<Group> groups)

Assign a user to a collection of groups.

Parameters:

user - The user to be assigned

groups - The groups collection

assignUserToGroups

void assignUserToGroups(User user,
                      long[] groupIds)

Assign a user to a collection of groups.

Parameters:

user - The user to be assigned

groupIds - Array of group ids

assignUserToGroup

void assignUserToGroup(User user,
                     Group group)

Assign a user to a group.

Parameters:

user - The user to be assigned

group - The group

removeUsersFromGroup

void removeUsersFromGroup(Collection<User> users,
                        Group group)

Removes the specified users from a group. Users will not removed from their user's groups.

Parameters:

users - The users to be removed

group - The group to be updated

removeUserFromGroup

void removeUserFromGroup(User user,
                       Group group)

Removes the specified user from a group. If the specified group is the user's group no changes are committed.

Parameters:

users - The user to be removed

group - The group to be updated

removeUserFromAllGroups

void removeUserFromAllGroups(User user)

Removes the specified user from a all groups except it's user's group

Parameters:

user - The user to be removed

removeAllUsersFromGroup

void removeAllUsersFromGroup(Group group)

Removes all users from group

Parameters:

group - The group from which all users must be removed

getAllowedGroups

Set<Group> getAllowedGroups(long menuId)

Retrieves the collection of groups that can access the given menu

Parameters:

menuId - The menu to consider

Returns:

The collection of allowed groups

isMemberOf

boolean isMemberOf(long userId,
                 long groupId)

Checks if a given user is member of a particular group

Parameters:

userId - The user identifier

groupId - The group identifier

Returns:

true only if the user belongs to the group

isMemberOf

boolean isMemberOf(long userId,
                 String groupName)

Checks if a given user is member of a particular group

Parameters:

userId - The user identifier

groupName - The group name

Returns:

true only if the user belongs to the group