1 /** 2 * This file Copyright (c) 2003-2014 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 java.io.Serializable; 37 38 import info.magnolia.cms.util.UrlPattern; 39 40 41 /** 42 * A permission is a collection of rights and can match paths. Defines various permission constants which can be used to build right bitsets. 43 * 44 * @version $Id$ 45 */ 46 public interface Permission extends Serializable { 47 48 // list of permissions 49 50 long NONE = 0; 51 52 long ADD = 1; 53 54 long SET = 2; 55 56 long REMOVE = 4; 57 58 long READ = 8; 59 60 long EXECUTE = 16; 61 62 long SYNDICATE = 32; 63 64 // permission names are not localized, they are never displayed in the GUI but only used for exception messages 65 66 String PERMISSION_NAME_ADD = "Add"; 67 68 String PERMISSION_NAME_SET = "Set"; 69 70 String PERMISSION_NAME_REMOVE = "Remove"; 71 72 String PERMISSION_NAME_READ = "Read"; 73 74 String PERMISSION_NAME_EXECUTE = "Execute"; 75 76 String PERMISSION_NAME_SYNDICATE = "Syndicate"; 77 78 String PERMISSION_NAME_ALL = "(Add, Set, Read, Execute, Syndicate)"; 79 80 String PERMISSION_NAME_WRITE = "(Add, Set, Read)"; 81 82 /** 83 * All permissions combined. 84 */ 85 long ALL = ADD | REMOVE | SET | READ | EXECUTE | SYNDICATE; 86 87 /** 88 * All write permissions. 89 */ 90 long WRITE = ADD | SET | READ; 91 92 void setPattern(UrlPattern value); 93 94 UrlPattern getPattern(); 95 96 void setPermissions(long value); 97 98 long getPermissions(); 99 100 /** 101 * True if this permission matches the path. 102 */ 103 boolean match(String path); 104 }