001: /*
002: * NEMESIS-FORUM.
003: * Copyright (C) 2002 David Laurent(lithium2@free.fr). All rights reserved.
004: *
005: * Copyright (c) 2000 The Apache Software Foundation. All rights reserved.
006: *
007: * Copyright (C) 2001 Yasna.com. All rights reserved.
008: *
009: * Copyright (C) 2000 CoolServlets.com. All rights reserved.
010: *
011: * NEMESIS-FORUM. is free software; you can redistribute it and/or
012: * modify it under the terms of the Apache Software License, Version 1.1,
013: * or (at your option) any later version.
014: *
015: * NEMESIS-FORUM core framework, NEMESIS-FORUM backoffice, NEMESIS-FORUM frontoffice
016: * application are parts of NEMESIS-FORUM and are distributed under
017: * same terms of licence.
018: *
019: *
020: * NEMESIS-FORUM includes software developed by the Apache Software Foundation (http://www.apache.org/)
021: * and software developed by CoolServlets.com (http://www.coolservlets.com).
022: * and software developed by Yasna.com (http://www.yasna.com).
023: *
024: */
025:
026: package org.nemesis.forum;
027:
028: import org.nemesis.forum.config.Constants;
029: import org.nemesis.forum.util.cache.CacheSizes;
030: import org.nemesis.forum.util.cache.Cacheable;
031:
032: /**
033: * Defines a set of permissions for objects in the forum system that
034: * users can be granted. Forum permissions are used by the protection
035: * proxy objects defined for each major component of the system.
036: */
037: public class ForumPermissions implements Cacheable {
038:
039: private boolean[] values = new boolean[8];
040:
041: /**
042: * Factory method to create full permissions.
043: */
044: public static ForumPermissions full() {
045: return new ForumPermissions(true, true, true, true, true, true,
046: true, true);
047: }
048:
049: /**
050: * Factory method to create an object with no permissions.
051: */
052: public static ForumPermissions none() {
053: return new ForumPermissions(false, false, false, false, false,
054: false, false, false);
055: }
056:
057: /**
058: * Factory method to create an object with read-only permissions.
059: */
060: public static ForumPermissions readOnly() {
061: return new ForumPermissions(true, false, false, false, false,
062: false, false, false);
063: }
064:
065: /**
066: * Create a new permissions object with the specified permissions.
067: */
068: public ForumPermissions(boolean READ, boolean SYSTEM_ADMIN,
069: boolean FORUM_ADMIN, boolean USER_ADMIN,
070: boolean GROUP_ADMIN, boolean MODERATOR,
071: boolean CREATE_THREAD, boolean CREATE_MESSAGE) {
072: values[0] = READ;
073: values[1] = SYSTEM_ADMIN;
074: values[2] = FORUM_ADMIN;
075: values[3] = USER_ADMIN;
076: values[4] = GROUP_ADMIN;
077: values[5] = MODERATOR;
078: values[6] = CREATE_THREAD;
079: values[7] = CREATE_MESSAGE;
080: }
081:
082: /**
083: * Creates a new ForumPermission object by combining two permissions
084: * objects. The higher permission of each permission type will be used.
085: */
086: public ForumPermissions(ForumPermissions perm1,
087: ForumPermissions perm2) {
088: values[0] = perm1.get(0) || perm2.get(0);
089: values[1] = perm1.get(1) || perm2.get(1);
090: values[2] = perm1.get(2) || perm2.get(2);
091: values[3] = perm1.get(3) || perm2.get(3);
092: values[4] = perm1.get(4) || perm2.get(4);
093: values[5] = perm1.get(5) || perm2.get(5);
094: values[6] = perm1.get(6) || perm2.get(6);
095: values[7] = perm1.get(7) || perm2.get(7);
096: }
097:
098: public ForumPermissions(boolean[] permissions) {
099: this .values = permissions;
100: }
101:
102: public String toString() {
103: StringBuffer buf = new StringBuffer();
104: for (int i = 0; i < values.length - 1; i++) {
105: buf.append(values[i]).append(",");
106: }
107: buf.append(values[values.length - 1]);
108: return buf.toString();
109: }
110:
111: /**
112: * Returns true if the permission of a particular type is allowed.
113: */
114: public boolean get(int type) {
115: if (type < 0 || type > 7) {
116: return false;
117: }
118: return values[type];
119: }
120:
121: /**
122: * Returns true if the permissions include system or forum admin
123: * permissions.
124: */
125: public boolean isSystemOrForumAdmin() {
126: return (values[Constants.FORUM_ADMIN] || values[Constants.SYSTEM_ADMIN]);
127: }
128:
129: //FROM THE CACHEABLE INTERFACE//
130:
131: public int getSize() {
132: //Approximate the size of the object in bytes by calculating the size
133: //of each field.
134: int size = 0;
135: size += CacheSizes.sizeOfObject(); //overhead of object
136: size += CacheSizes.sizeOfObject(); //ref to array
137: size += CacheSizes.sizeOfBoolean() * 8; //boolean array vals
138: return size;
139: }
140: }
|