KickJava   Java API By Example, From Geeks To Geeks.

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


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2002 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
65 package com.jcorporate.expresso.services.job;
66
67 import com.jcorporate.expresso.core.controller.Controller;
68 import com.jcorporate.expresso.core.controller.ControllerRequest;
69 import com.jcorporate.expresso.core.controller.ControllerResponse;
70 import com.jcorporate.expresso.core.controller.Output;
71 import com.jcorporate.expresso.core.job.Job;
72 import com.jcorporate.expresso.core.job.ServerException;
73 import com.jcorporate.expresso.core.misc.ConfigManager;
74 import com.jcorporate.expresso.core.misc.StringUtil;
75
76 import java.util.Enumeration JavaDoc;
77 import java.util.Hashtable JavaDoc;
78 import java.util.Iterator JavaDoc;
79
80
81 /**
82  * ControllerJob provides a Job "wrapper" for any Controller
83  * object. It uses the parameters to the Job to invoke the
84  * specified state of the controller, and includes the
85  * controller's outputs in the email notification to the requestor
86  *
87  * @author Michael Nash
88  */
89 public class ControllerJob
90         extends Job {
91
92     /**
93      * REtrieve the job title
94      *
95      * @return java.lang.String
96      */
97     public String JavaDoc getTitle() {
98         return "ControllerJob";
99     } /* getTitle() */
100
101     /**
102      * Instantiate the specified Controller, transition to the appropriate state (if
103      * given, else call newState("") to transition to default state) then send any
104      * outputs generated in the "finish" email.
105      */
106     public void run() {
107         super.run();
108         try {
109             StringBuffer JavaDoc mailMsg = new StringBuffer JavaDoc("");
110             String JavaDoc controllerName = StringUtil.notNull(getJobParameter(Controller.CONTROLLER_PARAM_KEY));
111
112             if (controllerName.equals("")) {
113                 throw new ServerException("Parameter 'controller' " +
114                         "must be specified");
115             }
116
117             Controller myController = ConfigManager.getControllerFactory().getController(controllerName);
118             ControllerRequest cparams = new ControllerRequest();
119
120             // add all job params as controller params
121 Hashtable JavaDoc names = getParameterNamesAndDescriptions();
122             Hashtable JavaDoc namesValues = new Hashtable JavaDoc(names.size());
123             for (Iterator JavaDoc iterator = names.keySet().iterator(); iterator.hasNext();) {
124                 String JavaDoc name = (String JavaDoc) iterator.next();
125                 namesValues.put(name, getJobParameter(name));
126             }
127             cparams.setParameters(namesValues);
128
129             String JavaDoc newState = StringUtil.notNull(getJobParameter(Controller.STATE_PARAM_KEY));
130             ControllerResponse myResponse = myController.newState(newState,
131                     cparams);
132             Output oneOutput = null;
133
134             for (Enumeration JavaDoc ov = myResponse.getOutputs().elements();
135                  ov.hasMoreElements();) {
136                 oneOutput = (Output) ov.nextElement();
137                 mailMsg.append("\n" + oneOutput.getContent());
138             }
139
140             finish(mailMsg.toString());
141         } catch (Exception JavaDoc de) {
142             log.error("Error handling job", de);
143             finish(getString("Test_Job_Failed"), de);
144         }
145     } /* run() */
146
147 } /* ControllerJob */
148
Popular Tags