KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > services > job > ClearOldValidation


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2003 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */
64 package com.jcorporate.expresso.services.job;
65
66 import com.jcorporate.expresso.core.db.DBConnection;
67 import com.jcorporate.expresso.core.dbobj.SecuredDBObject;
68 import com.jcorporate.expresso.services.dbobj.ValidationQueue;
69 import org.apache.log4j.Logger;
70
71 import java.util.ArrayList JavaDoc;
72
73 /**
74  * This job clears all expired validation queue entries. It is typically run
75  * once a week or so to clean out unwanted validation items to keep the size of
76  * the table down and remove any potential referential integrity issues.
77  * <p>A Job is an asynchronous task that is performed, run and the results of the
78  * job are eventually mailed to the queuing user.</p>
79  *
80  * @author Michael Rimov
81  * @since Expresso 5.3
82  */
83 public class ClearOldValidation extends com.jcorporate.expresso.core.job.Job {
84
85     /**
86      * Convenience string for creating error messages.
87      */
88     private static final String JavaDoc THIS_CLASS = ClearOldValidation.class.getName() + ".";
89
90     /**
91      * The log4j logging system.
92      */
93     private static final transient Logger log = Logger.getLogger(ClearOldValidation.class);
94
95
96     /**
97      * Creates an instance of ClearOldValidation. Call setRequestingUid() and setDataContext()
98      * before using.
99      *
100      * @see com.jcorporate.expresso.core.dbobj.SecuredDBObject#SecuredDBObject
101      */
102     public ClearOldValidation() {
103         super();
104
105         this.setSchema(com.jcorporate.expresso.core.ExpressoSchema.class.getName());
106     }
107
108
109     /**
110      * Deletes all expired validation queue entries.
111      */
112     public void run() {
113         super.run();
114         try {
115             if (log.isInfoEnabled()) {
116                 log.info("Beginning job " + THIS_CLASS);
117             }
118             int recordsDeleted = 0;
119
120             ValidationQueue vq = new ValidationQueue(SecuredDBObject.SYSTEM_ACCOUNT);
121             vq.setDataContext(this.getDataContext());
122             ArrayList JavaDoc al = new ArrayList JavaDoc();
123             DBConnection connection = vq.createAndExecuteSearch(al);
124
125             ValidationQueue oneEntry = new ValidationQueue(SecuredDBObject.SYSTEM_ACCOUNT);
126             oneEntry.setDataContext(this.getDataContext());
127             while (connection.next()) {
128                 oneEntry.clear();
129                 vq.loadFromConnection(oneEntry, connection, al);
130                 if (oneEntry.isExpired()) {
131                     if (log.isDebugEnabled()) {
132                         log.debug("Deleting validation entry: " + vq.getKey());
133                     }
134
135                     oneEntry.delete(true);
136                     recordsDeleted++;
137                 }
138             }
139
140             finish("Validation Queue Clearance Complete.\n\n\t+ " + recordsDeleted
141                     + " expired validation entries were deleted.");
142         } catch (Throwable JavaDoc t) {
143             log.error("Caught exception finishing job " + THIS_CLASS, t);
144             finish("Error finishing job " + THIS_CLASS, t);
145         }
146     }
147
148
149     /**
150      * Retrieve the friendly title name of the job
151      *
152      * @return java.lang.String for the title.
153      */
154     public String JavaDoc getTitle() {
155         return "Clear old validation entries";
156     }
157
158 }
159
Popular Tags