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.services.security.TurbineSecurity;
58 import org.apache.turbine.util.security.TurbineSecurityException;
59
60 /***
61 * This class represents the permissions that a Role has to access
62 * certain pages/functions within the system. The class implements
63 * Comparable so that when Permissions are added to a Set, they will
64 * be in alphabetical order by name.
65 *
66 * @author <a href="mailto:frank.kim@clearink.com">Frank Y. Kim</a>
67 * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a>
68 * @author <a href="mailto:bmclaugh@algx.net">Brett McLaughlin</a>
69 * @version $Id: TurbinePermission.java,v 1.2.4.3 2001/06/01 01:33:38 jvanzyl Exp $
70 */
71 public class TurbinePermission extends SecurityObject implements Permission
72 {
73 /***
74 * Constructs a new TurbinePermission.
75 */
76 public TurbinePermission()
77 {
78 super();
79 }
80
81 /***
82 * Constructs a new TurbinePermission with the sepcified name.
83 *
84 * @param name The name of the new object.
85 */
86 public TurbinePermission( String name )
87 {
88 super(name);
89 }
90
91 /***
92 * Creates a new Permission in the system.
93 *
94 * @param name The name of the new Permission.
95 * @return An object representing the new Permission.
96 * @throws TurbineSecurityException if the Permission could not be created.
97 * @deprecated Please use the createPermission method in TurbineSecurity.
98 */
99 public static Permission create( String name )
100 throws TurbineSecurityException
101 {
102 return TurbineSecurity.createPermission(name);
103 }
104
105 /***
106 * Makes changes made to the Permission attributes permanent.
107 *
108 * @throws TurbineSecurityException if there is a problem while
109 * saving data.
110 */
111 public void save()
112 throws TurbineSecurityException
113 {
114 TurbineSecurity.savePermission(this);
115 }
116
117 /***
118 * Removes a permission from the system.
119 *
120 * @throws TurbineSecurityException if the Permission could not be removed.
121 */
122 public void remove()
123 throws TurbineSecurityException
124 {
125 TurbineSecurity.removePermission(this);
126 }
127
128 /***
129 * Renames the permission.
130 *
131 * @param name The new Permission name.
132 * @throws TurbineSecurityException if the Permission could not be renamed.
133 */
134 public void rename(String name)
135 throws TurbineSecurityException
136 {
137 TurbineSecurity.renamePermission(this, name);
138 }
139 }
This page was automatically generated by Maven