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.job;
066:
067: import com.jcorporate.expresso.core.db.DBException;
068: import com.jcorporate.expresso.core.job.Job;
069: import com.jcorporate.expresso.services.dbobj.Event;
070: import com.jcorporate.expresso.services.dbobj.JobQueue;
071: import com.jcorporate.expresso.services.validation.AuthValidationException;
072: import com.jcorporate.expresso.services.validation.ValidationEntry;
073: import com.jcorporate.expresso.services.validation.ValidationHandler;
074: import org.apache.log4j.Logger;
075:
076: import java.util.List;
077:
078: /**
079: * This class implements an Expresso Job, which is a background task, to
080: * decouple the user selecting some action that requires validation, from
081: * the mechanics of storing the user/application-selected parameters and
082: * starting the processing. The primary reason for using a Job here is
083: * to allow load-balancing if required, and also to make the UI appear
084: * much faster (since otherwise the user would have to wait until the
085: * entire function finished).
086: * <p/>
087: * The submission of the job is done using the ValidationEntry class.
088: *
089: * @author Shash Chatterjee
090: * @version $Revision: 1.13 $ $Date: 2004/11/17 20:48:18 $
091: */
092: public class ValidationJob extends Job {
093:
094: //Handle to the logging class
095: private static Logger log = Logger.getLogger(ValidationJob.class);
096:
097: /**
098: * The default constructor for instantiating a new job.
099: * <p/>
100: * Creation date: (9/23/2001 9:25:23 AM)
101: * Author: Shash Chatterjee
102: */
103: public ValidationJob() {
104: super ();
105: setSchema("com.jcorporate.expresso.core.ExpressoSchema");
106: }
107:
108: /**
109: * Notification of job failires
110: * Creation date: (9/23/2001 9:29:24 AM)
111: * Author: Shash Chatterjee
112: *
113: * @param msg The message to send in an Expresso SYSERROR event in case this job fails
114: */
115: private void errorNotify(String msg) {
116: try {
117:
118: // will email
119: new Event(getJobQueueEntry().getDataContext(), "SYSERROR",
120: getClass().getName()
121: + ":Unable to run validation job:" + msg
122: + " Job:" + getJobNumber() + " User:"
123: + getUser(), false);
124: } catch (Exception e) {
125: log.error(e);
126: }
127: } /* errorNotify */
128:
129: /**
130: * The name of this Job, used typically in UI screens
131: * Creation date: (9/23/2001 9:30:54 AM)
132: * Author: Shash Chatterjee
133: *
134: * @return The title
135: */
136: public String getTitle() {
137: return "Validation Job";
138: }
139:
140: /**
141: * This method initializes the job, currently all it does is to log a message.
142: * Creation date: (9/23/2001 9:31:39 AM)
143: * Author: Shash Chatterjee
144: *
145: * @throws AuthValidationException If there is a DB error getting job queue entry id
146: */
147: protected void initialize() throws AuthValidationException {
148: if (log.isDebugEnabled()) {
149: try {
150: log.debug("Running validation job, job id="
151: + getJobQueueEntry().getField("ServerID"));
152: } catch (DBException dbe) {
153: throw new AuthValidationException(
154: "DB error getting job queue entry", dbe);
155: }
156: }
157: }
158:
159: /**
160: * This method actually implements the "meat" of the Job.
161: * It's purpose is to take the parameters given the job when
162: * it was submitted and then store them into the validation
163: * subsystem. It also invokes a application-specific
164: * "validation handler" to allow the application to do all its
165: * unique things for whatever validation task it is requesting.
166: * <p/>
167: * Creation date: (9/23/2001 9:33:35 AM)
168: * Author: Shash Chatterjee
169: */
170: public void run() {
171: super .run();
172:
173: //This is the default description of the job, we try to get a more specific one later
174: String desc = getTitle();
175:
176: try {
177:
178: // Guess what this does....
179: initialize();
180:
181: // These are the params passed to the job from the ValidationEntry.submit()
182: List paramsVector = this .getJobParameterList();
183:
184: // All the information about this job
185: JobQueue jq = getJobQueueEntry();
186:
187: // Create a more specific description for this job
188: desc = jq.getParamValue(ValidationEntry.PRM_VAL_TITLE)
189: + "("
190: + jq.getParamValue(ValidationEntry.PRM_VAL_DESC)
191: + ")";
192:
193: // Create a new ValidationEntry using the Job parameters provided, this
194: // actually permamnently stores the validation parameters.
195: ValidationEntry ve = new ValidationEntry(getDataContext(),
196: paramsVector, jq);
197:
198: // The application-specific "job handler"
199: ValidationHandler vh = ve.instantiateHandler();
200:
201: // Notify the "validator" of what he needs to do...
202: vh.notify(ve.getParams(), ve.validationURL());
203: ve.setStatus("W");
204:
205: // Done with this job ... success
206: finish(desc + ":succeeded");
207: } catch (Exception e) {
208:
209: // Something went wrong....
210: finish(desc + ":failed", e);
211: } finally {
212:
213: // Done with this job, mark it so that it can be cleaned up
214: try {
215: getJobQueueEntry().delete();
216: } catch (DBException de2) {
217: errorNotify(de2.getMessage());
218: }
219: }
220: }
221:
222: }
|