001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by Jcorporate Ltd.
021: * (http://www.jcorporate.com/)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. "Jcorporate" and product names such as "Expresso" must
026: * not be used to endorse or promote products derived from this
027: * software without prior written permission. For written permission,
028: * please contact info@jcorporate.com.
029: *
030: * 5. Products derived from this software may not be called "Expresso",
031: * or other Jcorporate product names; nor may "Expresso" or other
032: * Jcorporate product names appear in their name, without prior
033: * written permission of Jcorporate Ltd.
034: *
035: * 6. No product derived from this software may compete in the same
036: * market space, i.e. framework, without prior written permission
037: * of Jcorporate Ltd. For written permission, please contact
038: * partners@jcorporate.com.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
044: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
045: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
046: * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Jcorporate Ltd. Contributions back
056: * to the project(s) are encouraged when you make modifications.
057: * Please send them to support@jcorporate.com. For more information
058: * on Jcorporate Ltd. and its products, please see
059: * <http://www.jcorporate.com/>.
060: *
061: * Portions of this software are based upon other open source
062: * products and are subject to their respective licenses.
063: */
064:
065: package com.jcorporate.expresso.services.dbobj;
066:
067: import com.jcorporate.expresso.core.controller.ControllerRequest;
068: import com.jcorporate.expresso.core.db.DBException;
069: import com.jcorporate.expresso.core.security.User;
070: import com.jcorporate.expresso.core.security.UserListener;
071:
072: import java.util.Iterator;
073:
074: /**
075: * A User Preference is a stored value or attribute that is related
076: * to a particular user. This value set a preference or customizes the
077: * behaviour of a particular application when used by this user.
078: *
079: * @author Michael Nash
080: */
081: public class UserPreference extends SecurityDBObject implements
082: UserListener {
083:
084: public static final String PREF_CODE = "PrefCode";
085: public static final String PREF_VALUE = "PrefValue";
086: public static final String CLASS_NAME = "ClassName";
087: public static final String EXPUID = "ExpUid";
088:
089: static {
090: try {
091: User.addListener(new UserPreference());
092: } catch (Exception e) {
093: e.printStackTrace();
094: System.err.println(e.getMessage());
095: }
096:
097: }
098:
099: /**
100: * @see com.jcorporate.expresso.core.dbobj.SecuredDBObject#SecuredDBObject
101: */
102: public UserPreference() throws DBException {
103: } /* UserPreference() */
104:
105: /**
106: * Use over (String) constructor. Initializes the object in the context
107: * of the user who's uid belongs to the parameter.
108: *
109: * @param uid of the user context
110: * @throws DBException if there's an initialization problem
111: */
112: public UserPreference(int uid) throws DBException {
113: super (uid);
114: }
115:
116: /**
117: * For using DBObjects within Controllers. Initializes based upon the current
118: * user and the requested db. [Of course this can be modified later]
119: *
120: * @param request - The controller request handed to you by the framework.
121: */
122: public UserPreference(ControllerRequest request) throws DBException {
123: super (request);
124: }
125:
126: public void addedUser(User user) throws DBException {
127: }
128:
129: /**
130: * Extends the checkAllRefs method to check for valid UserGroup
131: *
132: * @throws DBException If a referential integrity violation is found
133: */
134: protected void checkAllRefs() throws DBException {
135: checkRef("ClassName;PrefCode", new UserPreferenceDef(),
136: "Invalid Preference Code");
137: } /* checkAllRefs() */
138:
139: public void deletedUser(User user) throws DBException {
140: UserPreference u = new UserPreference();
141: u.setDataContext(user.getDataContext());
142: u.setField(EXPUID, user.getUid());
143:
144: UserPreference onePreference = null;
145:
146: for (Iterator e = u.searchAndRetrieveList().iterator(); e
147: .hasNext();) {
148: onePreference = (UserPreference) e.next();
149: onePreference.delete();
150: }
151: }
152:
153: public void loggedOffUser(User user) throws DBException {
154: }
155:
156: public void loggedOnUser(User user) throws DBException {
157: }
158:
159: public void modifiedUser(User user) throws DBException {
160: }
161:
162: /**
163: * @see com.jcorporate.expresso.core.dbobj.SecuredDBObject#setupFields
164: * Note that valid values for PREF_VALUE may be specified in UserPreferenceVal,
165: * depending on the preference.
166: */
167: public void setupFields() throws DBException {
168: setTargetTable("USERPREF");
169: setDescription("DBuserPref");
170: setCharset("ISO-8859-1");
171: addField(EXPUID, "int", 0, false, "userId");
172: addVirtualField("LoginName", "char", 30, "loginName");
173: addField(CLASS_NAME, "varchar", 128, false, "className");
174: addField(PREF_CODE, "varchar", 30, false, "prefCode");
175: addField(PREF_VALUE, "varchar", 80, false, "prefValue");
176: setStringFilter(CLASS_NAME, "stripFilter");
177: setStringFilter(PREF_CODE, "stripFilter");
178: setStringFilter("PrefValue", "rawFilter");
179:
180: addKey(EXPUID);
181: addKey(CLASS_NAME);
182: addKey(PREF_CODE);
183:
184: setLookupObject(EXPUID,
185: "com.jcorporate.expresso.core.security.User");
186: } /* setupFields() */
187:
188: public String getField(String fieldName) throws DBException {
189: if (fieldName.equals("LoginName")) {
190: User u = new User();
191: u.setUid(getFieldInt(EXPUID));
192: u.setDataContext(this .getDataContext());
193:
194: if (u.find()) {
195: return u.getLoginName();
196: }
197:
198: return "No such user";
199: }
200:
201: return super .getField(fieldName);
202: }
203: } /* UserPreferece */
|