1 package org.apache.turbine.om.security;
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.turbine.util.security.PermissionSet;
58 import org.apache.turbine.util.security.TurbineSecurityException;
59
60 /***
61 * This class represents a role played by the User associated with the
62 * current Session.
63 *
64 * @author <a href="mailto:frank.kim@clearink.com">Frank Y. Kim</a>
65 * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a>
66 * @author <a href="mailto:bmclaugh@algx.net">Brett McLaughlin</a>
67 * @version $Id: Role.java,v 1.1.1.1 2001/08/16 05:08:42 jvanzyl Exp $
68 */
69 public interface Role extends SecurityEntity
70 {
71 /***
72 * Returns the set of Permissions associated with this Role.
73 *
74 * @return A PermissionSet.
75 * @exception Exception, a generic exception.
76 */
77 public PermissionSet getPermissions()
78 throws Exception;
79
80 /***
81 * Sets the Permissions associated with this Role.
82 *
83 * @param permissionSet A PermissionSet.
84 */
85 public void setPermissions(PermissionSet permissionSet);
86
87 // These following methods are wrappers around TurbineSecurity
88
89 /***
90 * Creates a new Role in the system.
91 *
92 * @param name The name of the new Role.
93 * @return An object representing the new Role.
94 * @throws TurbineSecurityException if the Role could not be created.
95 */
96 public Role create( String name )
97 throws TurbineSecurityException;
98
99 /***
100 * Makes changes made to the Role attributes permanent.
101 *
102 * @throws TurbineSecurityException if there is a problem while
103 * saving data.
104 */
105 public void save()
106 throws TurbineSecurityException;
107
108 /***
109 * Removes a role from the system.
110 *
111 * @throws TurbineSecurityException if the Role could not be removed.
112 */
113 public void remove()
114 throws TurbineSecurityException;
115
116 /***
117 * Renames the role.
118 *
119 * @param name The new Role name.
120 * @throws TurbineSecurityException if the Role could not be renamed.
121 */
122 public void rename(String name)
123 throws TurbineSecurityException;
124
125 /***
126 * Grants a Permission to this Role.
127 *
128 * @param permission A Permission.
129 * @throws TurbineSecurityException if there is a problem while assigning
130 * the Permission.
131 */
132 public void grant(Permission permission)
133 throws TurbineSecurityException;
134
135 /***
136 * Grants Permissions from a PermissionSet to this Role.
137 *
138 * @param permissionSet A PermissionSet.
139 * @throws TurbineSecurityException if there is a problem while assigning
140 * the Permissions.
141 */
142 public void grant(PermissionSet permissionSet)
143 throws TurbineSecurityException;
144
145 /***
146 * Revokes a Permission from this Role.
147 *
148 * @param permission A Permission.
149 * @throws TurbineSecurityException if there is a problem while unassigning
150 * the Permission.
151 */
152 public void revoke(Permission permission)
153 throws TurbineSecurityException;
154
155 /***
156 * Revokes Permissions from a PermissionSet from this Role.
157 *
158 * @param permissionSet A PermissionSet.
159 * @throws TurbineSecurityException if there is a problem while unassigning
160 * the Permissions.
161 */
162 public void revoke(PermissionSet permissionSet)
163 throws TurbineSecurityException;
164 }
This page was automatically generated by Maven