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.db.DBConnection;
068: import com.jcorporate.expresso.core.db.DBException;
069: import com.jcorporate.expresso.core.dbobj.RequestContext;
070: import com.jcorporate.expresso.core.dbobj.SecuredDBObject;
071: import com.jcorporate.expresso.core.misc.EventHandler;
072: import com.jcorporate.expresso.core.security.User;
073: import com.jcorporate.expresso.core.security.UserListener;
074: import org.apache.log4j.Logger;
075:
076: import java.util.Iterator;
077:
078: /**
079: * Whenever you create a DBObject to be used for Registration, you need to
080: * derive it from this class. What this does is make sure that the registration
081: * information is deleted when a User is deleted.
082: *
083: * @author Michael Rimov
084: */
085: abstract public class RegistrationDBObject extends SecuredDBObject
086: implements UserListener {
087:
088: static private final String this Class = RegistrationDBObject.class
089: .getName();
090: static private Logger log = Logger
091: .getLogger(RegistrationDBObject.class);
092:
093: /**
094: * Constructor
095: *
096: * @throws DBException on error
097: */
098: public RegistrationDBObject() throws DBException {
099: super ();
100: addAsUserListener(this );
101: } /* User() */
102:
103: /**
104: * Constructor
105: *
106: * @param myConnection The DBConnection retrieved from the ConnectionPool
107: */
108: public RegistrationDBObject(DBConnection myConnection)
109: throws DBException {
110: super (myConnection);
111: addAsUserListener(this );
112: } /* User(String) */
113:
114: /**
115: * <p/>
116: * Constructor that sets a connection as the object is created - typically
117: * this is used when a particular DBConnection is required for the purposes of
118: * maintaining a database transaction. If a specific connection is not used,
119: * there is no way to use commit() and rollback() in the event of failure, as a
120: * different DBConnection might be used for each phase of the transaction.
121: * Critial sections should therefore explicity request a DBConnection from the
122: * connection pool and pass it to each of the DB objects in that section.
123: * </p>
124: * <p>This constructor is neceesary to work with otherDBMap and transaction
125: * capabilities</p>
126: *
127: * @param dbConnection The DBConnection to utilize
128: * @param securityContext The data context that contains the setup (and
129: * security) tables for this object
130: * @throws DBException upon initialization error
131: */
132: public RegistrationDBObject(DBConnection dbConnection,
133: String securityContext) throws DBException {
134: super (dbConnection, securityContext);
135: addAsUserListener(this );
136: } /* CommitterRegistration(DBConnection) */
137:
138: /**
139: * Use over (String) constructor. Initializes the object in the context
140: * of the user who's uid belongs to the parameter.
141: *
142: * @param uid the Uid of the user context
143: * @throws DBException if there's an initialization problem
144: */
145: public RegistrationDBObject(int uid) throws DBException {
146: super (uid);
147: addAsUserListener(this );
148: }
149:
150: /**
151: * For using DBObjects within Controllers. Initializes based upon the current
152: * user and the requested db. [Of course this can be modified later]
153: *
154: * @param request - The controller request handed to you by the framework.
155: */
156: public RegistrationDBObject(RequestContext request)
157: throws DBException {
158: super (request);
159: addAsUserListener(this );
160: }
161:
162: /**
163: * Whenever a user is deleted, we must delete all of their registration
164: * records for security reasons.
165: *
166: * @param user the User that was deleted
167: */
168: public void deletedUser(User user) throws DBException {
169: RegistrationDBObject regobj = null;
170: try {
171: regobj = (RegistrationDBObject) Class.forName(
172: this .getClass().getName()).newInstance();
173: } catch (Exception e) {
174: throw new DBException(this Class
175: + ".deletedUser() Error instantiating class: "
176: + this .getClass().getName());
177: }
178: regobj.setDataContext(user.getDataContext());
179:
180: // coder MAY have used custom UidField name
181: String uidFieldName = getUidFieldName(user);
182:
183: try {
184: regobj.setField(uidFieldName, user.getUid());
185: } catch (Exception e) {
186: // coder may not have realized that expresso objects (also in map) use 'ExpUid'
187: regobj.setField("ExpUid", user.getUid()); // ok to throw
188: }
189:
190: RegistrationDBObject oneMember = null;
191:
192: for (Iterator e = regobj.searchAndRetrieveList().iterator(); e
193: .hasNext();) {
194: oneMember = (RegistrationDBObject) e.next();
195:
196: try {
197: oneMember.delete();
198: } catch (DBException dbe) {
199: String msg = "Error deleting registration info for class: "
200: + this .getClass().getName()
201: + " please delete these records manually as soon as possible";
202:
203: log.error(msg, dbe);
204:
205: EventHandler.Event(user.getDataContext(), "SYSERROR",
206: msg, false);
207: }
208: } /* for each group member listing */
209:
210: }
211:
212: private String getUidFieldName(User user) throws DBException {
213: String uidFieldName = "ExpUid";
214: RegistrationDomain rd = new RegistrationDomain();
215: rd.setDataContext(user.getDataContext());
216: rd.setField("Name", user.getRegistrationDomain());
217:
218: if (!rd.find()) {
219: throw new DBException("User '+ " + user.getLoginName()
220: + " specifies registration domain name = '"
221: + user.getRegistrationDomain()
222: + "' but cannot find this domain.");
223: }
224:
225: RegistrationObjectMap rom = new RegistrationObjectMap(
226: SecuredDBObject.SYSTEM_ACCOUNT);
227: rom.setDataContext(user.getDataContext());
228: rom.setField("RegDomId", rd.getField("RegDomId"));
229:
230: if (rom.find()) {
231: uidFieldName = rom.getField("UidField");
232: }
233: return uidFieldName;
234: }
235:
236: protected synchronized static void addAsUserListener(UserListener ul) {
237: if (!User.isListener(ul)) {
238: User.addListener(ul);
239: }
240: }
241:
242: public void addedUser(User user) throws DBException {
243: return;
244: }
245:
246: public void loggedOffUser(User user) throws DBException {
247: return;
248: }
249:
250: public void loggedOnUser(User user) throws DBException {
251: return;
252: }
253:
254: public void modifiedUser(User user) throws DBException {
255: return;
256: }
257: }
|