fr.paris.lutece.portal.web.rbac

Class RoleManagementJspBean

java.lang.Object

fr.paris.lutece.portal.web.admin.AdminFeaturesPageJspBean

fr.paris.lutece.portal.web.rbac.RoleManagementJspBean

All Implemented Interfaces:

Serializable

public class RoleManagementJspBean
extends AdminFeaturesPageJspBean

This class provides methods for role management.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	RIGHT_MANAGE_ROLES Right to manage RBAC

Constructor Summary

Constructors

Constructor and Description
RoleManagementJspBean()

Method Summary

Modifier and Type	Method and Description
String	doAssignUsers(javax.servlet.http.HttpServletRequest request) Process the data capture form for assign users to a role
String	doConfirmRemoveControlFromRole(javax.servlet.http.HttpServletRequest request) Get the confirmation page before deletion of a control
String	doConfirmRemoveRole(javax.servlet.http.HttpServletRequest request) Get the confirmation page before deletion of a role
String	doCreateRole(javax.servlet.http.HttpServletRequest request) Perform the role creation.
String	doModifyRole(javax.servlet.http.HttpServletRequest request) Performs the modification of the role's key and description.
String	doRemoveControlFromRole(javax.servlet.http.HttpServletRequest request) Perform the role deletion.
String	doRemoveRole(javax.servlet.http.HttpServletRequest request) Perform the role deletion.
String	doSelectPermissions(javax.servlet.http.HttpServletRequest request) Perform the checks on the permission selection and redirects to the description of the role if ok.
String	doSelectResources(javax.servlet.http.HttpServletRequest request) Perform the checks on the resource selection method and perform the suitable redirection.
String	doSelectResourcesFromIdsList(javax.servlet.http.HttpServletRequest request) Perform the check on the resource id list selected on the specific id selection page perform the suitable redirection.
String	doUnAssignUser(javax.servlet.http.HttpServletRequest request) unassigns user from role
String	getAddControlToRole(javax.servlet.http.HttpServletRequest request) Get the first page of the control addition to a role.
String	getAssignUsers(javax.servlet.http.HttpServletRequest request) Returns the users assignation form
String	getCreateRole(javax.servlet.http.HttpServletRequest request) Get the role creation page.
String	getManageRoles(javax.servlet.http.HttpServletRequest request) Get the roles management page.
String	getSelectPermissions(javax.servlet.http.HttpServletRequest request) Get the permission selection page.
String	getSelectSpecificIds(javax.servlet.http.HttpServletRequest request) Get the list of ids corresponding to the current resource type.
String	getViewRoleDescription(javax.servlet.http.HttpServletRequest request) Get the page describing a role and the resource associated

Methods inherited from class fr.paris.lutece.portal.web.admin.AdminFeaturesPageJspBean

getAdminPage, getFeatureIcon, getHomeUrl, getLocale, getPageTitle, getUser, init, setFeatureGroup, setFeatureIcon, setPageTitleProperty, validate, validate, validate

Methods inherited from class java.lang.Object

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

Field Detail

RIGHT_MANAGE_ROLES

public static final String RIGHT_MANAGE_ROLES

Right to manage RBAC

See Also:

Constant Field Values

Constructor Detail

RoleManagementJspBean

public RoleManagementJspBean()

Method Detail

getManageRoles

public String getManageRoles(javax.servlet.http.HttpServletRequest request)

Get the roles management page. This page provides the list of all existing roles.

Parameters:

request - the http request

Returns:

the html code for the role management page

getCreateRole

public String getCreateRole(javax.servlet.http.HttpServletRequest request)

Get the role creation page. This page provides a form to enter basic information about the new role.

Parameters:

request - the http request

Returns:

the html code for the role creation page

doCreateRole

public String doCreateRole(javax.servlet.http.HttpServletRequest request)
                    throws AccessDeniedException

Perform the role creation. The role key entered should not already exist. The role key is mandatory.

Parameters:

request - the http request

Returns:

the url to forward to

Throws:

AccessDeniedException - if the security token is invalid

doModifyRole

public String doModifyRole(javax.servlet.http.HttpServletRequest request)
                    throws AccessDeniedException

Performs the modification of the role's key and description. The role key entered should not already exist. The role key is mandatory. It should update the key for all the entries in the role-resource association list.

Parameters:

request - the http request

Returns:

the url to forward to

Throws:

AccessDeniedException - if the security token is invalid

doConfirmRemoveRole

public String doConfirmRemoveRole(javax.servlet.http.HttpServletRequest request)

Get the confirmation page before deletion of a role

Parameters:

request - the HTTP request

Returns:

the url of the confirmation page

doRemoveRole

public String doRemoveRole(javax.servlet.http.HttpServletRequest request)
                    throws AccessDeniedException

Perform the role deletion. Also delete the resources linked to this role

Parameters:

request - the http request

Returns:

the url of the role management page

Throws:

AccessDeniedException - if the security token is invalid

getViewRoleDescription

public String getViewRoleDescription(javax.servlet.http.HttpServletRequest request)

Get the page describing a role and the resource associated

Parameters:

request - the HTTP request

Returns:

the HTML code for the description page

doConfirmRemoveControlFromRole

public String doConfirmRemoveControlFromRole(javax.servlet.http.HttpServletRequest request)

Get the confirmation page before deletion of a control

Parameters:

request - the http request

Returns:

the url of the confirmation page

doRemoveControlFromRole

public String doRemoveControlFromRole(javax.servlet.http.HttpServletRequest request)
                               throws AccessDeniedException

Perform the role deletion. Also delete the resources linked to this role

Parameters:

request - the http request

Returns:

the url of the role management page

Throws:

AccessDeniedException - if the security token is invalid

getAddControlToRole

public String getAddControlToRole(javax.servlet.http.HttpServletRequest request)

Get the first page of the control addition to a role. This page provides choice for resource selection. 2 methods are provided :

• wildcard selection : all resources of this type are selected.
• specific selection : a page with the list of resource ids available is provided next for user choice.

Parameters:

request - the HTTP request

Returns:

the HTML content for the resource selection method choice

doSelectResources

public String doSelectResources(javax.servlet.http.HttpServletRequest request)

Perform the checks on the resource selection method and perform the suitable redirection.

• If selection method is global (wilcard selection - parameter "all"), the user is redirected to the permission selection page.
• If selection method is specific (id selection - parameter "choose"), the user is redirected to the resource id selection page.
• If no selection method is found, or if it's neither parameter "all" nor "choose", the user is redirected to a error page.

Parameters:

request - the http request

Returns:

the url of the page to be redirected to

getSelectSpecificIds

public String getSelectSpecificIds(javax.servlet.http.HttpServletRequest request)

Get the list of ids corresponding to the current resource type. This allows to provide the selection of resource ids that should be controlled for the current role.

Parameters:

request - the http request

Returns:

the html code for the list of ids to select

doSelectResourcesFromIdsList

public String doSelectResourcesFromIdsList(javax.servlet.http.HttpServletRequest request)

Perform the check on the resource id list selected on the specific id selection page perform the suitable redirection.

• If selection method is specific (id selection - parameter "choose"),
  • if at least one id as been selected, the user is redirected to the permission selection page.
  • if no id as been selected, the user is redirected to an error page.
• If selection method is global (wilcard selection - parameter "all"), the user is redirected to the permission selection page (This check could be avoided as is should not happen).
• If no selection method is found, or if it's neither parameter "all" nor "choose", the user is redirected to a error page.

Parameters:

request - the http request

Returns:

the url of the page to be redirected to

getSelectPermissions

public String getSelectPermissions(javax.servlet.http.HttpServletRequest request)

Get the permission selection page. 2 methods are provided :

• wildcard selection : all permissions for this type are selected.
• specific selection : the choice is to be made by the user in the list of available permissions.

Parameters:

request - the http request

Returns:

the html code for the permission selection page.

doSelectPermissions

public String doSelectPermissions(javax.servlet.http.HttpServletRequest request)
                           throws AccessDeniedException

Perform the checks on the permission selection and redirects to the description of the role if ok.

• If selection method is global (wilcard selection - parameter "all"), the corresponding entry is stored as a control for all resources previously selected. The user is redirected to the role description page.
• If selection method is specific (id selection - parameter "choose"),
  • if no permission is found, the user is redirected to an error page.
  • if at least one permission is found, the corresponding entry is stored as a control for all resources previously selected. The user is redirected to the role description page.
• If no selection method is found, or if it's neither parameter "all" nor "choose", the user is redirected to a error page.

Parameters:

request - the http request

Returns:

the url of the page to be redirected to

Throws:

AccessDeniedException - if the security token is invalid

getAssignUsers

public String getAssignUsers(javax.servlet.http.HttpServletRequest request)

Returns the users assignation form

Parameters:

request - The Http request

Returns:

the html code for display the modes list

doAssignUsers

public String doAssignUsers(javax.servlet.http.HttpServletRequest request)
                     throws AccessDeniedException

Process the data capture form for assign users to a role

Parameters:

request - The HTTP Request

Returns:

The Jsp URL of the process result

Throws:

AccessDeniedException - if the security token is invalid

doUnAssignUser

public String doUnAssignUser(javax.servlet.http.HttpServletRequest request)
                      throws AccessDeniedException

unassigns user from role

Parameters:

request - The HttpRequest

Returns:

the HTML code of list assignations

Throws:

AccessDeniedException - if the security token is invalid