001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2003 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: package com.jcorporate.expresso.services.job;
065:
066: import com.jcorporate.expresso.core.db.DBConnection;
067: import com.jcorporate.expresso.core.dbobj.SecuredDBObject;
068: import com.jcorporate.expresso.services.dbobj.ValidationQueue;
069: import org.apache.log4j.Logger;
070:
071: import java.util.ArrayList;
072:
073: /**
074: * This job clears all expired validation queue entries. It is typically run
075: * once a week or so to clean out unwanted validation items to keep the size of
076: * the table down and remove any potential referential integrity issues.
077: * <p>A Job is an asynchronous task that is performed, run and the results of the
078: * job are eventually mailed to the queuing user.</p>
079: *
080: * @author Michael Rimov
081: * @since Expresso 5.3
082: */
083: public class ClearOldValidation extends
084: com.jcorporate.expresso.core.job.Job {
085:
086: /**
087: * Convenience string for creating error messages.
088: */
089: private static final String THIS_CLASS = ClearOldValidation.class
090: .getName()
091: + ".";
092:
093: /**
094: * The log4j logging system.
095: */
096: private static final transient Logger log = Logger
097: .getLogger(ClearOldValidation.class);
098:
099: /**
100: * Creates an instance of ClearOldValidation. Call setRequestingUid() and setDataContext()
101: * before using.
102: *
103: * @see com.jcorporate.expresso.core.dbobj.SecuredDBObject#SecuredDBObject
104: */
105: public ClearOldValidation() {
106: super ();
107:
108: this
109: .setSchema(com.jcorporate.expresso.core.ExpressoSchema.class
110: .getName());
111: }
112:
113: /**
114: * Deletes all expired validation queue entries.
115: */
116: public void run() {
117: super .run();
118: try {
119: if (log.isInfoEnabled()) {
120: log.info("Beginning job " + THIS_CLASS);
121: }
122: int recordsDeleted = 0;
123:
124: ValidationQueue vq = new ValidationQueue(
125: SecuredDBObject.SYSTEM_ACCOUNT);
126: vq.setDataContext(this .getDataContext());
127: ArrayList al = new ArrayList();
128: DBConnection connection = vq.createAndExecuteSearch(al);
129:
130: ValidationQueue oneEntry = new ValidationQueue(
131: SecuredDBObject.SYSTEM_ACCOUNT);
132: oneEntry.setDataContext(this .getDataContext());
133: while (connection.next()) {
134: oneEntry.clear();
135: vq.loadFromConnection(oneEntry, connection, al);
136: if (oneEntry.isExpired()) {
137: if (log.isDebugEnabled()) {
138: log.debug("Deleting validation entry: "
139: + vq.getKey());
140: }
141:
142: oneEntry.delete(true);
143: recordsDeleted++;
144: }
145: }
146:
147: finish("Validation Queue Clearance Complete.\n\n\t+ "
148: + recordsDeleted
149: + " expired validation entries were deleted.");
150: } catch (Throwable t) {
151: log
152: .error("Caught exception finishing job "
153: + THIS_CLASS, t);
154: finish("Error finishing job " + THIS_CLASS, t);
155: }
156: }
157:
158: /**
159: * Retrieve the friendly title name of the job
160: *
161: * @return java.lang.String for the title.
162: */
163: public String getTitle() {
164: return "Clear old validation entries";
165: }
166:
167: }
|