KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > turbine > om > security > Permission


1 package org.apache.turbine.om.security;
2
3 /*
4  * Copyright 2001-2004 The Apache Software Foundation.
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License")
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18
19 import org.apache.turbine.util.security.TurbineSecurityException;
20
21 /**
22  * This class represents the permissions that a Role has to access
23  * certain pages/functions within the system. The class implements
24  * Comparable so that when Permissions are added to a Set, they will
25  * be in alphabetical order by name.
26  *
27  * @author <a HREF="mailto:frank.kim@clearink.com">Frank Y. Kim</a>
28  * @author <a HREF="mailto:john.mcnally@clearink.com">John D. McNally</a>
29  * @author <a HREF="mailto:bmclaugh@algx.net">Brett McLaughlin</a>
30  * @author <a HREF="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
31  * @version $Id: Permission.java,v 1.4.2.2 2004/05/20 03:05:17 seade Exp $
32  */
33 public interface Permission extends SecurityEntity
34 {
35     /**
36      * Makes changes made to the Permission attributes permanent.
37      *
38      * @throws TurbineSecurityException if there is a problem while
39      * saving data.
40      */
41     void save()
42         throws TurbineSecurityException;
43
44     /**
45      * Removes a permission from the system.
46      *
47      * @throws TurbineSecurityException if the Permission could not be removed.
48      */
49     void remove()
50         throws TurbineSecurityException;
51
52     /**
53      * Renames the permission.
54      *
55      * @param name The new Permission name.
56      * @throws TurbineSecurityException if the Permission could not be renamed.
57      */
58     void rename(String JavaDoc name)
59         throws TurbineSecurityException;
60 }
61
Popular Tags