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 java.util.Collections;
58 import java.util.HashMap;
59 import java.util.Map;
60 import org.apache.torque.om.BaseObject;
61
62 /***
63 * This class represents a generic object used in the Access Control Lists.
64 *
65 * @author <a href="mailto:frank.kim@clearink.com">Frank Y. Kim</a>
66 * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a>
67 * @author <a href="mailto:bmclaugh@algx.net">Brett McLaughlin</a>
68 * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a>
69 * @version $Id: SecurityObject.java,v 1.2 2002/07/11 07:34:30 mpoeschl Exp $
70 */
71 public abstract class SecurityObject extends BaseObject implements Comparable
72 {
73 /*** The name of this object. */
74 private String name;
75
76 /*** The attributes of this object. */
77 private Map attributes;
78
79 /***
80 * Constructs a new SecurityObject
81 */
82 public SecurityObject()
83 {
84 this("");
85 }
86
87 /***
88 * Constructs a new SecurityObject with the specified name.
89 *
90 * @param name The name of the new object.
91 */
92 public SecurityObject( String name )
93 {
94 setName(name);
95 setAttributes(Collections.synchronizedMap(new HashMap()));
96 }
97
98 /***
99 * Returns a Map containing this object's attributes.
100 *
101 * @return the object's attributes.
102 */
103 public Map getAttributes()
104 {
105 return attributes;
106 }
107
108 /***
109 * Replaces this object's attributes with the specified Map.
110 *
111 * @param attributes The new attributes of the object.
112 */
113 public void setAttributes( Map attributes )
114 {
115 this.attributes = attributes;
116 }
117
118 /***
119 * Retrieves the value of specific attribute of this object.
120 *
121 * @param name the name of the attribute
122 * @return the value of the attribute
123 */
124 public Object getAttribute( String name )
125 {
126 return attributes.get(name);
127 }
128
129 /***
130 * Sets the value of specific attribute of this object.
131 *
132 * @param name the name of the attribute
133 * @return the value of the attribute
134 */
135 public void setAttribute( String name, Object value )
136 {
137 attributes.put(name, value);
138 }
139
140 /***
141 * Returns the name of this object.
142 *
143 * @return The name of the object.
144 */
145 public String getName()
146 {
147 return name;
148 }
149
150 /***
151 * Sets the name of this object.
152 *
153 * @param name The name of the object.
154 */
155 public void setName(String name)
156 {
157 this.name = name;
158 }
159
160 /***
161 * Used for ordering SecurityObjects.
162 *
163 * @param obj The Object to compare to.
164 * @return -1 if the name of the other object is lexically greater than this
165 * group, 1 if it is lexically lesser, 0 if they are equal.
166 */
167 public int compareTo(Object obj)
168 {
169 if(this.getClass() != obj.getClass())
170 throw new ClassCastException();
171 String name1 = ((SecurityObject)obj).getName();
172 String name2 = this.getName();
173
174 return name2.compareTo(name1);
175 }
176
177 /***
178 * Returns a textual representation of this object, consisted by
179 * it's name and attributes.
180 *
181 * @return a textual representation of this group.
182 */
183 public String toString()
184 {
185 return (getName() + ':' + getAttributes().toString());
186 }
187 }
This page was automatically generated by Maven