| package org.apache.turbine.om.security; |
| |
| /* ==================================================================== |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 2001-2003 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Apache" and "Apache Software Foundation" and |
| * "Apache Turbine" must not be used to endorse or promote products |
| * derived from this software without prior written permission. For |
| * written permission, please contact apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * "Apache Turbine", nor may "Apache" appear in their name, without |
| * prior written permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation. For more |
| * information on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| */ |
| |
| import java.sql.Connection; |
| import java.util.Iterator; |
| |
| import org.apache.turbine.services.security.TurbineSecurity; |
| import org.apache.turbine.util.security.RoleSet; |
| import org.apache.turbine.util.security.TurbineSecurityException; |
| |
| /** |
| * This class represents a Group of Users in the system that are associated |
| * with specific entity or resource. The users belonging to the Group may have |
| * various Roles. The Permissions to perform actions upon the resource depend |
| * on the Roles in the Group that they are assigned. |
| * |
| * <a name="global"> |
| * <p> Certain Roles that the Users may have in the system may are not related |
| * to any specific resource nor entity. |
| * They are assigned within a special group named 'global' that can be |
| * referenced in the code as {@link #GLOBAL_GROUP_NAME}. |
| * <br> |
| * |
| * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a> |
| * @version $Id$ |
| */ |
| public class TurbineGroup extends SecurityObject implements Group |
| { |
| /** |
| * Constructs a new Group. |
| */ |
| public TurbineGroup() |
| { |
| super(); |
| } |
| |
| /** |
| * Constructs a new Group with the specified name. |
| * |
| * @param name The name of the new object. |
| */ |
| public TurbineGroup(String name) |
| { |
| super(name); |
| } |
| |
| // These following methods are wrappers around TurbineSecurity |
| |
| /** |
| * Makes changes made to the Group attributes permanent. |
| * |
| * @throws TurbineSecurityException if there is a problem while saving data. |
| */ |
| public void save() throws TurbineSecurityException |
| { |
| TurbineSecurity.saveGroup(this); |
| } |
| |
| /** |
| * not implemented |
| * |
| * @param conn |
| * @throws Exception |
| */ |
| public void save(Connection conn) throws Exception |
| { |
| throw new Exception("not implemented"); |
| } |
| |
| /** |
| * not implemented |
| * |
| * @param dbname |
| * @throws Exception |
| */ |
| public void save(String dbname) throws Exception |
| { |
| throw new Exception("not implemented"); |
| } |
| |
| /** |
| * Removes a group from the system. |
| * |
| * @throws TurbineSecurityException if the Group could not be removed. |
| */ |
| public void remove() throws TurbineSecurityException |
| { |
| TurbineSecurity.removeGroup(this); |
| } |
| |
| /** |
| * Renames the role. |
| * |
| * @param name The new Group name. |
| * @throws TurbineSecurityException if the Group could not be renamed. |
| */ |
| public void rename(String name) throws TurbineSecurityException |
| { |
| TurbineSecurity.renameGroup(this, name); |
| } |
| |
| /** |
| * Grants a Role in this Group to an User. |
| * |
| * @param user An User. |
| * @param role A Role. |
| * @throws TurbineSecurityException if there is a problem while assigning |
| * the Role. |
| */ |
| public void grant(User user, Role role) throws TurbineSecurityException |
| { |
| TurbineSecurity.grant(user, this, role); |
| } |
| |
| /** |
| * Grants Roles in this Group to an User. |
| * |
| * @param user An User. |
| * @param roleSet A RoleSet. |
| * @throws TurbineSecurityException if there is a problem while assigning |
| * the Roles. |
| */ |
| public void grant(User user, RoleSet roleSet) |
| throws TurbineSecurityException |
| { |
| for (Iterator roles = roleSet.iterator(); roles.hasNext();) |
| { |
| TurbineSecurity.grant(user, this, (Role) roles.next()); |
| } |
| } |
| |
| /** |
| * Revokes a Role in this Group from an User. |
| * |
| * @param user An User. |
| * @param role A Role. |
| * @throws TurbineSecurityException if there is a problem while unassigning |
| * the Role. |
| */ |
| public void revoke(User user, Role role) throws TurbineSecurityException |
| { |
| TurbineSecurity.revoke(user, this, role); |
| } |
| |
| /** |
| * Revokes Roles in this group from an User. |
| * |
| * @param user An User. |
| * @param roleSet a RoleSet. |
| * @throws TurbineSecurityException if there is a problem while unassigning |
| * the Roles. |
| */ |
| public void revoke(User user, RoleSet roleSet) |
| throws TurbineSecurityException |
| { |
| for (Iterator roles = roleSet.iterator(); roles.hasNext();) |
| { |
| TurbineSecurity.revoke(user, this, (Role) roles.next()); |
| } |
| } |
| } |