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.core.dbobj;
066:
067: import com.jcorporate.expresso.core.db.DBConnection;
068: import com.jcorporate.expresso.core.db.DBException;
069: import com.jcorporate.expresso.core.misc.DateTime;
070: import com.jcorporate.expresso.kernel.util.ClassLocator;
071:
072: import java.util.Iterator;
073:
074: /**
075: * HistAuditSecuredDBObject is an object that is audited
076: * (as in the AuditedSecuredDBObject) and is also archived in a history table
077: * that stores the entire record on either ADD or UPDATE.
078: * <p/>
079: * A HistAuditSecuredDBObject MUST have the following fields defined:
080: * <p/>
081: * <SOMEKEY>
082: * ...<ALL FIELDS IN THE MATCHING TABLE>
083: * AUDITLOG_ID
084: * HISTORY_DATE
085: * <p/>
086: * So for example, if you have a table called Vendor that you want to have
087: * history kept for, you would do this:
088: * <p/>
089: * HistAuditSecuredDBObject Vendor fields:
090: * <p/>
091: * VENDOR_ID
092: * VENDOR_NAME
093: * AUDITLOG_ID (because this is also a AuditedSecuredDBObject).
094: * <p/>
095: * There must then be a DBObject called "VendorHistory" with the following
096: * fields:
097: * <p/>
098: * VENDOR_HISTORY_ID (auto-inc)
099: * VENDOR_ID
100: * VENDOR_NAME
101: * AUDITLOG_ID
102: * HISTORY_DATE
103: * <p/>
104: * It is a good idea to set all of the fields in the VendorHistory object as
105: * readonly, and do not have any referential integrity set on any of the fields
106: * (for example, the VENDOR_ID column is the key in the Vendor object, but will
107: * probably repeat in the VendorHistory table).
108: * <p/>
109: * We should probably enhance this by creating a base HISTORY table DBObject
110: * that enforces/automates this.
111: *
112: * @author Adam Rossi, PlatinumSolutions
113: */
114: public class HistAuditSecuredDBObject extends AuditedSecuredDBObject {
115: //private String historyTableClassName = null;
116: /**
117: * Construct an audit secured DBObject
118: */
119: public HistAuditSecuredDBObject() throws DBException {
120: super ();
121: }
122:
123: /**
124: * Constructor
125: *
126: * @param theConnection Database connection to
127: * communicate with the database
128: * @throws DBException If the new object cannot be
129: * created
130: */
131: public HistAuditSecuredDBObject(DBConnection theConnection)
132: throws DBException {
133: super (theConnection);
134: }
135:
136: /**
137: * Method to write an entry to the History table.
138: */
139: private void writeRecordToHistory() throws DBException {
140:
141: //recurse through fields and write a copy to the corresponding
142: //history table
143: try {
144: Class clazz = ClassLocator
145: .loadClass(getHistoryTableClassName());
146: SecuredDBObject histObject = (SecuredDBObject) clazz
147: .newInstance();
148:
149: if (histObject == null) {
150: throw new DBException("The history object is null.");
151: }
152:
153: Iterator fieldsIterator = this .getJDBCMetaData()
154: .getFieldListArray().iterator();
155: String fieldName = null;
156:
157: while (fieldsIterator.hasNext()) {
158: fieldName = (String) fieldsIterator.next();
159: histObject
160: .setField(fieldName, this .getField(fieldName));
161: }
162:
163: histObject.setField("HISTORY_DATE", DateTime
164: .getDateTimeForDB(this .getDataContext()));
165: histObject.add();
166: } catch (Exception e) {
167: throw new DBException(
168: "An error occured while trying to write to the history table: "
169: + e.toString());
170: }
171: }
172:
173: /**
174: * The assumption here is that the history table DBObject is called
175: * objectname + "History", such as "VendorHistory" for the DBObject "Vendor".
176: *
177: * @return the class name of the history table as a <code>java.lang.String</code>
178: */
179: public String getHistoryTableClassName() {
180: return this .getClass().getName() + "History";
181: }
182:
183: /**
184: * On the add method, always write an entry to the history table.
185: *
186: * @throws DBException upon error
187: */
188: public synchronized void add() throws DBException {
189: super .add();
190: this .writeRecordToHistory();
191: }
192:
193: /**
194: * On the update method, always write an entry to the history table.
195: */
196: public synchronized void update() throws DBException {
197: super.update();
198: this.writeRecordToHistory();
199: }
200: }
|