1 /** 2 * This file Copyright (c) 2003-2013 Magnolia International 3 * Ltd. (http://www.magnolia-cms.com). All rights reserved. 4 * 5 * 6 * This file is dual-licensed under both the Magnolia 7 * Network Agreement and the GNU General Public License. 8 * You may elect to use one or the other of these licenses. 9 * 10 * This file is distributed in the hope that it will be 11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the 12 * implied warranty of MERCHANTABILITY or FITNESS FOR A 13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT. 14 * Redistribution, except as permitted by whichever of the GPL 15 * or MNA you select, is prohibited. 16 * 17 * 1. For the GPL license (GPL), you can redistribute and/or 18 * modify this file under the terms of the GNU General 19 * Public License, Version 3, as published by the Free Software 20 * Foundation. You should have received a copy of the GNU 21 * General Public License, Version 3 along with this program; 22 * if not, write to the Free Software Foundation, Inc., 51 23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 24 * 25 * 2. For the Magnolia Network Agreement (MNA), this file 26 * and the accompanying materials are made available under the 27 * terms of the MNA which accompanies this distribution, and 28 * is available at http://www.magnolia-cms.com/mna.html 29 * 30 * Any modifications to this file must keep this entire header 31 * intact. 32 * 33 */ 34 package info.magnolia.cms.security; 35 36 import info.magnolia.cms.security.auth.ACL; 37 38 import java.util.Map; 39 40 /** 41 * Manages roles, roles are identified by name and can be organized in folders. The name is globally unique regardless 42 * of their organisation in folders. 43 * 44 * @see Role 45 */ 46 public interface RoleManager { 47 48 /** 49 * Creates a new role in the root folder without any security restrictions. 50 * 51 * @throws IllegalArgumentException if the name is not valid or if a group with this name already exists 52 * @throws UnsupportedOperationException in case the role manager does not support this operation 53 */ 54 public Role createRole(String name) throws UnsupportedOperationException, Exception; 55 56 public Role createRole(String path, String name) throws AccessDeniedException; 57 58 /** 59 * Get the specific role. 60 * 61 * @throws UnsupportedOperationException in case the role manager does not support this operation 62 */ 63 public Role getRole(String name) throws UnsupportedOperationException; 64 65 /** 66 * Obtain list of ACLs defined for specified role. 67 * 68 * @throws UnsupportedOperationException in case the role manager does not support this operation 69 */ 70 public Map<String, ACL> getACLs(String role) throws UnsupportedOperationException; 71 72 /** 73 * Add permission to the specified role, assuming current user has enough rights to perform such operation. 74 */ 75 public void addPermission(Role role, String workspaceName, String path, long permission); 76 77 /** 78 * Remove permission from the specified role. 79 */ 80 public void removePermission(Role role, String workspace, String path, long permission); 81 82 /** 83 * Retrieve role name by its identifier. 84 */ 85 public String getRoleNameById(String string); 86 87 }