fr.paris.lutece.portal.service.rbac

Class RBACService

java.lang.Object

fr.paris.lutece.portal.service.rbac.RBACService

public final class RBACService
extends Object

This class provides the main methods to control the access to a resource depending on the user's roles

Method Summary

Modifier and Type	Method and Description
static <E extends fr.paris.lutece.portal.service.rbac.RBACAction> Collection<E>	getAuthorizedActionsCollection(Collection<E> collection, fr.paris.lutece.portal.service.rbac.RBACResource resource, AdminUser user) Filter a collection of RBACAction for a given user
static <E extends fr.paris.lutece.portal.service.rbac.RBACResource> Collection<E>	getAuthorizedCollection(Collection<E> collection, String strPermission, AdminUser user) Filter a collection of resources for a given user
static ReferenceList	getAuthorizedReferenceList(ReferenceList listResources, String strResourceType, String strPermission, AdminUser user) Filter a Reference List for a given user
static boolean	isAuthorized(fr.paris.lutece.portal.service.rbac.RBACResource resource, String strPermission, AdminUser user) Check that a given user is allowed to access a resource for a given permission
static boolean	isAuthorized(String strResourceTypeCode, String strResourceId, String strPermission, AdminUser user) Check that a given user is allowed to access a resource for a given permission
static boolean	isUserInRole(AdminUser user, String strRole) Check that a given user is in the given role

Methods inherited from class java.lang.Object

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

Method Detail

isAuthorized

public static boolean isAuthorized(String strResourceTypeCode,
                                   String strResourceId,
                                   String strPermission,
                                   AdminUser user)

Check that a given user is allowed to access a resource for a given permission

Parameters:

strResourceTypeCode - the key of the resource type being considered

strResourceId - the id of the resource being considered

strPermission - the permission needed

user - the user trying to access the ressource

Returns:

true if the user can access the given resource with the given permission, false otherwise

isAuthorized

public static boolean isAuthorized(fr.paris.lutece.portal.service.rbac.RBACResource resource,
                                   String strPermission,
                                   AdminUser user)

Check that a given user is allowed to access a resource for a given permission

Parameters:

resource - the resource object being considered

strPermission - the permission needed

user - the user trying to access the ressource

Returns:

true if the user can access the given resource with the given permission, false otherwise

isUserInRole

public static boolean isUserInRole(AdminUser user,
                                   String strRole)

Check that a given user is in the given role

Parameters:

user - The user

strRole - The role

Returns:

true if the user has the given role, false otherwise

getAuthorizedCollection

public static <E extends fr.paris.lutece.portal.service.rbac.RBACResource> Collection<E> getAuthorizedCollection(Collection<E> collection,
                                                                                                                 String strPermission,
                                                                                                                 AdminUser user)

Filter a collection of resources for a given user

Type Parameters:

E - The RBAC resource

Parameters:

collection - The collection to filter

strPermission - Permission to check

user - The user

Returns:

A filtered collection of resources

getAuthorizedReferenceList

public static ReferenceList getAuthorizedReferenceList(ReferenceList listResources,
                                                       String strResourceType,
                                                       String strPermission,
                                                       AdminUser user)

Filter a Reference List for a given user

Parameters:

listResources - The list to filter

strResourceType - The resource type

strPermission - The permission to check

user - The user

Returns:

The filtered collection

getAuthorizedActionsCollection

public static <E extends fr.paris.lutece.portal.service.rbac.RBACAction> Collection<E> getAuthorizedActionsCollection(Collection<E> collection,
                                                                                                                      fr.paris.lutece.portal.service.rbac.RBACResource resource,
                                                                                                                      AdminUser user)

Filter a collection of RBACAction for a given user

Type Parameters:

E - The RBAC resource

Parameters:

collection - The collection to filter

resource - The resource

user - The user

Returns:

The filtered collection