blob: 5501ad0f840b2e77d90ee3f15e224ac061e33925 [file] [log] [blame]
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 org.apache.turbine.util.security.PermissionSet;
import org.apache.turbine.util.security.TurbineSecurityException;
/**
* This class represents a role played by the User associated with the
* current Session.
*
* @author <a href="mailto:frank.kim@clearink.com">Frank Y. Kim</a>
* @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a>
* @author <a href="mailto:bmclaugh@algx.net">Brett McLaughlin</a>
* @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
* @version $Id$
*/
public interface Role extends SecurityEntity
{
/**
* Returns the set of Permissions associated with this Role.
*
* @return A PermissionSet.
* @exception Exception A generic exception.
*/
PermissionSet getPermissions()
throws Exception;
/**
* Sets the Permissions associated with this Role.
*
* @param permissionSet A PermissionSet.
*/
void setPermissions(PermissionSet permissionSet);
// These following methods are wrappers around TurbineSecurity
/**
* Creates a new Role in the system.
*
* @param name The name of the new Role.
* @return An object representing the new Role.
* @throws TurbineSecurityException if the Role could not be created.
*/
Role create(String name)
throws TurbineSecurityException;
/**
* Makes changes made to the Role attributes permanent.
*
* @throws TurbineSecurityException if there is a problem while
* saving data.
*/
void save()
throws TurbineSecurityException;
/**
* Removes a role from the system.
*
* @throws TurbineSecurityException if the Role could not be removed.
*/
void remove()
throws TurbineSecurityException;
/**
* Renames the role.
*
* @param name The new Role name.
* @throws TurbineSecurityException if the Role could not be renamed.
*/
void rename(String name)
throws TurbineSecurityException;
/**
* Grants a Permission to this Role.
*
* @param permission A Permission.
* @throws TurbineSecurityException if there is a problem while assigning
* the Permission.
*/
void grant(Permission permission)
throws TurbineSecurityException;
/**
* Grants Permissions from a PermissionSet to this Role.
*
* @param permissionSet A PermissionSet.
* @throws TurbineSecurityException if there is a problem while assigning
* the Permissions.
*/
void grant(PermissionSet permissionSet)
throws TurbineSecurityException;
/**
* Revokes a Permission from this Role.
*
* @param permission A Permission.
* @throws TurbineSecurityException if there is a problem while unassigning
* the Permission.
*/
void revoke(Permission permission)
throws TurbineSecurityException;
/**
* Revokes Permissions from a PermissionSet from this Role.
*
* @param permissionSet A PermissionSet.
* @throws TurbineSecurityException if there is a problem while unassigning
* the Permissions.
*/
void revoke(PermissionSet permissionSet)
throws TurbineSecurityException;
}