KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fulcrum > security > impl > db > entity > TurbinePermission


1 package org.apache.fulcrum.security.impl.db.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.TurbineSecurity;
58 import org.apache.fulcrum.security.entity.Permission;
59 import org.apache.fulcrum.security.entity.SecurityEntity;
60 import org.apache.fulcrum.security.util.TurbineSecurityException;
61
62 /**
63  * This class represents the permissions that a Role has to access
64  * certain pages/functions within the system. The class implements
65  * Comparable so that when Permissions are added to a Set, they will
66  * be in alphabetical order by name.
67  *
68  * @author <a HREF="mailto:frank.kim@clearink.com">Frank Y. Kim</a>
69  * @author <a HREF="mailto:jmcnally@collab.net">John D. McNally</a>
70  * @author <a HREF="mailto:bmclaugh@algx.net">Brett McLaughlin</a>
71  * @author <a HREF="mailto:mpoeschl@marmot.at">Martin Poeschl</a>
72  * @version $Id: TurbinePermission.java,v 1.1 2004/11/12 10:25:43 epugh Exp $
73  */
74 public class TurbinePermission
75     extends org.apache.fulcrum.security.impl.db.entity.BaseTurbinePermission
76     implements Permission, Comparable JavaDoc
77 {
78
79     /**
80      * Constructs a new TurbinePermission.
81      */
82     public TurbinePermission()
83     {
84     }
85
86     /**
87      * Constructs a new TurbinePermission with the sepcified name.
88      *
89      * @param name The name of the new object.
90      */
91     public TurbinePermission(String JavaDoc name)
92     {
93         this.setName(name);
94     }
95
96     /**
97      * Creates a new Permission in the system.
98      *
99      * @param name The name of the new Permission.
100      * @return An object representing the new Permission.
101      * @throws TurbineSecurityException if the Permission could not be created.
102      * @deprecated Please use the createPermission method in TurbineSecurity.
103      */
104     public static Permission create(String JavaDoc name)
105         throws TurbineSecurityException
106     {
107         return TurbineSecurity.createPermission(name);
108     }
109
110     /**
111      * Makes changes made to the Permission attributes permanent.
112      *
113      * @throws TurbineSecurityException if there is a problem while
114      * saving data.
115      */
116     public void save()
117         throws TurbineSecurityException
118     {
119         TurbineSecurity.savePermission(this);
120     }
121
122     /**
123      * Removes a permission from the system.
124      *
125      * @throws TurbineSecurityException if the Permission could not be removed.
126      */
127     public void remove()
128         throws TurbineSecurityException
129     {
130         TurbineSecurity.removePermission(this);
131     }
132
133     /**
134      * Renames the permission.
135      *
136      * @param name The new Permission name.
137      * @throws TurbineSecurityException if the Permission could not be renamed.
138      */
139     public void rename(String JavaDoc name)
140         throws TurbineSecurityException
141     {
142         TurbineSecurity.renamePermission(this, name);
143     }
144
145     /**
146      * Used for ordering SecurityObjects.
147      *
148      * @param obj The Object to compare to.
149      * @return -1 if the name of the other object is lexically greater than this
150      * group, 1 if it is lexically lesser, 0 if they are equal.
151      */
152     public int compareTo(Object JavaDoc obj)
153     {
154         if (this.getClass() != obj.getClass())
155         {
156             throw new ClassCastException JavaDoc();
157         }
158         String JavaDoc name1 = ((SecurityEntity)obj).getName();
159         String JavaDoc name2 = this.getName();
160         return name2.compareTo(name1);
161     }
162
163 }
164
Popular Tags