com.communote.server.core.user

Class UserAuthorityHelper

java.lang.Object

com.communote.server.core.user.UserAuthorityHelper

public abstract class UserAuthorityHelper
extends Object

The Class UserAuthorityHelper contains helper methods for the user authorities and user roles.

TODO Move helper to helper package

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
static boolean	containsRole(Collection<org.springframework.security.core.GrantedAuthority> authorities, UserRole role) Test whether the granted authorities contain a given role.
static Set<UserRole>	getAllRoles() Gets a set of all available user roles.
static UserRole[]	getAssignableRoles(User user) Gets the assignable roles for an user.
static Collection<org.springframework.security.core.GrantedAuthority>	getGrantedAuthorities(User user) Gets the granted Spring Security authorities of an user.
static Set<UserAuthority>	getUserAuthorities(UserRole[] roles) Creates a set of UserAuthority entities from UserRole's.
static Set<UserRole>	getUserRoles(Long userId) Gets the user roles.
static Set<UserRole>	getUserRoles(User user) Gets the user roles.
static boolean	hasAuthority(Long userId, UserRole role) Checks if a user has a given user role.
static boolean	hasAuthority(User user, UserRole role) Checks if a user has a given user role.

Methods inherited from class java.lang.Object

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

Method Detail

containsRole

public static boolean containsRole(Collection<org.springframework.security.core.GrantedAuthority> authorities,
                                   UserRole role)

Test whether the granted authorities contain a given role.

Parameters:

authorities - the granted authorities of a user as returned by getGrantedAuthorities(User)

role - the role to test

Returns:

true if the role is contained in the authorities

getAllRoles

public static Set<UserRole> getAllRoles()

Gets a set of all available user roles.

Returns:

the roles

getAssignableRoles

public static UserRole[] getAssignableRoles(User user)

Gets the assignable roles for an user.

Parameters:

user - the user

Returns:

the assignable roles

getGrantedAuthorities

public static Collection<org.springframework.security.core.GrantedAuthority> getGrantedAuthorities(User user)

Gets the granted Spring Security authorities of an user.

Parameters:

user - the user

Returns:

the granted authorities

getUserAuthorities

public static Set<UserAuthority> getUserAuthorities(UserRole[] roles)

Creates a set of UserAuthority entities from UserRole's.

Parameters:

roles - the roles

Returns:

the set of user authorities

getUserRoles

public static Set<UserRole> getUserRoles(User user)

Gets the user roles.

Parameters:

user - the user

Returns:

the user roles

getUserRoles

public static Set<UserRole> getUserRoles(Long userId)

Gets the user roles.

Parameters:

userId - the ID of the user

Returns:

the user roles

hasAuthority

public static boolean hasAuthority(User user,
                                   UserRole role)

Checks if a user has a given user role.

Parameters:

user - the user

role - the role

Returns:

true, if the user has the authority

hasAuthority

public static boolean hasAuthority(Long userId,
                                   UserRole role)

Checks if a user has a given user role.

Parameters:

userId - ID of the user

role - the role

Returns:

true, if the user has the authority