1 package org.apache.fulcrum.security.entity; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Turbine" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * "Apache Turbine", nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>. 55 */ 56 57 import org.apache.fulcrum.security.util.TurbineSecurityException; 58 59 /** 60 * This class represents the permissions that a Role has to access 61 * certain pages/functions within the system. The class implements 62 * Comparable so that when Permissions are added to a Set, they will 63 * be in alphabetical order by name. 64 * 65 * @author <a HREF="mailto:frank.kim@clearink.com">Frank Y. Kim</a> 66 * @author <a HREF="mailto:jmcnally@collab.net">John D. McNally</a> 67 * @author <a HREF="mailto:bmclaugh@algx.net">Brett McLaughlin</a> 68 * @version $Id: Permission.java,v 1.1 2004/11/12 10:25:51 epugh Exp $ 69 */ 70 public interface Permission extends SecurityEntity 71 { 72 /** 73 * Makes changes made to the Permission attributes permanent. 74 * 75 * @throws TurbineSecurityException if there is a problem while 76 * saving data. 77 */ 78 void save() 79 throws TurbineSecurityException; 80 81 /** 82 * Removes a permission from the system. 83 * 84 * @throws TurbineSecurityException if the Permission could not be removed. 85 */ 86 void remove() 87 throws TurbineSecurityException; 88 89 /** 90 * Renames the permission. 91 * 92 * @param name The new Permission name. 93 * @throws TurbineSecurityException if the Permission could not be renamed. 94 */ 95 void rename(String name) 96 throws TurbineSecurityException; 97 } 98