001: /***************************************************************
002: * This file is part of the [fleXive](R) project.
003: *
004: * Copyright (c) 1999-2008
005: * UCS - unique computing solutions gmbh (http://www.ucs.at)
006: * All rights reserved
007: *
008: * The [fleXive](R) project is free software; you can redistribute
009: * it and/or modify it under the terms of the GNU General Public
010: * License as published by the Free Software Foundation;
011: * either version 2 of the License, or (at your option) any
012: * later version.
013: *
014: * The GNU General Public License can be found at
015: * http://www.gnu.org/copyleft/gpl.html.
016: * A copy is found in the textfile GPL.txt and important notices to the
017: * license from the author are found in LICENSE.txt distributed with
018: * these libraries.
019: *
020: * This library is distributed in the hope that it will be useful,
021: * but WITHOUT ANY WARRANTY; without even the implied warranty of
022: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
023: * GNU General Public License for more details.
024: *
025: * For further information about UCS - unique computing solutions gmbh,
026: * please see the company website: http://www.ucs.at
027: *
028: * For further information about [fleXive](R), please see the
029: * project website: http://www.flexive.org
030: *
031: *
032: * This copyright notice MUST APPEAR in all copies of the file!
033: ***************************************************************/package com.flexive.shared.security;
034:
035: import com.flexive.shared.AbstractSelectableObjectWithName;
036: import com.flexive.shared.ObjectWithColor;
037:
038: import java.io.Serializable;
039:
040: /**
041: * A group of users
042: *
043: * @author Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
044: * @author Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
045: * @author Gregor Schober (gregor.schober@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
046: */
047: public class UserGroup extends AbstractSelectableObjectWithName
048: implements Serializable, ObjectWithColor {
049: private static final long serialVersionUID = 8672395090967024861L;
050:
051: /**
052: * Undefined group
053: */
054: public static final long GROUP_UNDEFINED = 0;
055:
056: /**
057: * Group in which every user is in (including USER_GUEST).
058: * This group may not be assigned to users.
059: */
060: public static final long GROUP_EVERYONE = 1;
061:
062: /**
063: * Group for special ACL permissions.
064: * This group may not be assigned to roles. A ACLAssignment using this
065: * group defines that its permissions are granted to the CREATOR of an object,
066: * not to the users within the GROUP_OWNER.
067: */
068: public static final long GROUP_OWNER = 2;
069:
070: /**
071: * Dummy group (Id if a null value cannot be applied)
072: */
073: public static final long GROUP_NULL = 3;
074:
075: private long id = -1;
076: private long mandator = -1;
077: private long autoMandator = -1;
078: private boolean system = false;
079: private String name = null;
080: private String color = null;
081:
082: /**
083: * Ctor
084: *
085: * @param id id
086: * @param name name
087: * @param mandator mandator id
088: * @param color color
089: */
090: public UserGroup(long id, String name, long mandator, String color) {
091: this .id = id;
092: this .mandator = mandator;
093: this .name = name;
094: this .color = color;
095: }
096:
097: /**
098: * Ctor
099: *
100: * @param id id
101: * @param mandator mandator id
102: * @param autoMandator mandator id for auto generated system groups only, else <code>-1</code>
103: * @param system is this an auto generated system group?
104: * @param name name of the group
105: * @param color color
106: */
107: public UserGroup(long id, long mandator, long autoMandator,
108: boolean system, String name, String color) {
109: this .id = id;
110: this .mandator = mandator;
111: this .autoMandator = autoMandator;
112: this .system = system;
113: this .name = name;
114: this .color = color;
115: }
116:
117: /**
118: * Getter for the group id
119: *
120: * @return group id
121: */
122: public long getId() {
123: return id;
124: }
125:
126: /**
127: * Getter for the mandator id
128: *
129: * @return mandator id
130: */
131: public long getMandatorId() {
132: return mandator;
133: }
134:
135: /**
136: * Get the id of the mandator this group is maintained for if it is a system group, else <code>-1</code>
137: *
138: * @return id of the mandator this group is maintained for if it is a system group, else <code>-1</code>
139: */
140: public long getAutoMandator() {
141: return autoMandator;
142: }
143:
144: /**
145: * Is this an auto generated system group?
146: *
147: * @return auto generated system group?
148: */
149: public boolean isSystem() {
150: return system;
151: }
152:
153: /**
154: * Getter for the name
155: *
156: * @return name
157: */
158: public String getName() {
159: return name;
160: }
161:
162: /**
163: * Getter for the displayed color
164: *
165: * @return color
166: */
167: public String getColor() {
168: return color;
169: }
170:
171: /**
172: * Setter for the name
173: *
174: * @param name group name
175: */
176: public void setName(String name) {
177: this .name = name;
178: }
179:
180: /**
181: * Setter for the color
182: *
183: * @param color color
184: */
185: public void setColor(String color) {
186: this .color = color;
187: }
188:
189: /**
190: * Returns true if the caller may see the group and its roles and assignments.
191: *
192: * @param ticket the caller
193: * @return true if the caller may see the group its roles and assignments
194: */
195: public boolean mayAccessGroup(UserTicket ticket) {
196: return ticket.isGlobalSupervisor() || id == GROUP_EVERYONE
197: || id == GROUP_OWNER
198: || mandator == ticket.getMandatorId();
199: }
200:
201: /**
202: * {@inheritDoc}
203: */
204: @Override
205: public String toString() {
206: return getName() + "(id:" + getId() + ", mandator: "
207: + getMandatorId() + ")";
208: }
209: }
|