JobHandlerControl


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.dbobj;
66  
67  import com.jcorporate.expresso.core.db.DBException;
68  import com.jcorporate.expresso.core.dbobj.RequestContext;
69  import com.jcorporate.expresso.core.dbobj.SecuredDBObject;
70  import com.jcorporate.expresso.core.dbobj.ValidValue;
71  import com.jcorporate.expresso.core.misc.ConfigManager;
72  import com.jcorporate.expresso.core.misc.DateTime;
73  
74  import java.util.Vector  ;
75  
76  /**
77   * applies operations (commands) to all jobs running on a server.
78   * For example, cause all jobs to stop or restart.
79   *
80   * @author Mike Dubman
81   */
82  public class JobHandlerControl
83          extends SecuredDBObject {
84      public static final String   FLD_REQUEST_TIME = "RequestTime";
85      /**
86       * command to apply to all jobs on server. currently, only restart and stop are available
87       */
88      public static final String   FLD_COMMAND = "Command";
89      public static final String   FLD_UID = "ExpUid";
90      public static final String   FLD_STATUS_CODE = "Status";
91      public static final String   FLD_SERVERID = "ServerID";
92      public static final String   FLD_COMMAND_ID = "CommandId";
93      public static final String   JOB_STATUS_NEW = "N";
94      public static final String   JOB_STATUS_AVAILABLE = "A";
95      public static final String   JOB_STATUS_COMPLETED = "C";
96      public static final String   JOB_STATUS_RUNNING = "R";
97  
98      public static final String   RESTART_COMMAND = "restart";
99      public static final String   STOP_COMMAND = "stop";
100 
101     /**
102      * @throws DBException
103      */
104     public JobHandlerControl()
105             throws DBException {
106     } /* JobHandlerControl() */
107 
108 
109     /**
110      * @param uid the Expresso user id
111      * @throws DBException upon initialization error
112      */
113     public JobHandlerControl(int uid)
114             throws DBException {
115         super(uid);
116     }
117 
118     /**
119      * For using DBObjects within Controllers.  Initializes based upon the current
120      * user and the requested db. [Of course this can be modified later]
121      *
122      * @param request - The controller request handed to you by the framework.
123      * @throws DBException upon initialization error
124      */
125     public JobHandlerControl(RequestContext request)
126             throws DBException {
127         super(request);
128     }
129 
130     /**
131      * @throws DBException
132      */
133     protected synchronized void setupFields()
134             throws DBException {
135         setTargetTable("JOBHANDLERCONTROL");
136         setDescription("DBjobHandlerControl");
137         addField(FLD_COMMAND_ID, "auto-inc", 0, false, "commandSerialId");
138         addField(FLD_STATUS_CODE, "varchar", 255, false, "statusCode");
139         addField(FLD_COMMAND, "varchar", 255, false, "jobHandlerCommand");
140         addField(FLD_SERVERID, "int", 0, false, "handlingServer");
141         addField(FLD_UID, "int", 0, false, "requestedByUser");
142         setLookupObject(FLD_UID, ConfigManager.getClassHandler("userInfo"));
143         addField(FLD_REQUEST_TIME, "datetime", 0, false, "requestedAt");
144         addKey("CommandId");
145     } /* setupFields() */
146 
147 
148     public void add()
149             throws DBException {
150 
151         if (getField(FLD_STATUS_CODE).equals("")) {
152             setField(FLD_STATUS_CODE, JOB_STATUS_NEW);
153         }
154 
155         setField(FLD_REQUEST_TIME, DateTime.getDateTimeForDB(this.getDataContext()));
156         setField(FLD_SERVERID, "0");
157         super.add();
158     } /* add() */
159 
160 
161     /**
162      * Override the method getValidValues to provide specific values for our
163      * multi-valued fields
164      *
165      * @param fieldName Field name for which values are requested
166      * @return Vector The ValidValues field
167      * @throws DBException If the values cannot be retrieved
168      */
169     public Vector   getValidValues(String   fieldName)
170             throws DBException {
171         if (fieldName.equals(FLD_STATUS_CODE)) {
172             Vector   myValues = new Vector  (4);
173             myValues.addElement(new ValidValue(JOB_STATUS_NEW, "New"));
174             myValues.addElement(new ValidValue(JOB_STATUS_AVAILABLE,
175                     "Available"));
176             myValues.addElement(new ValidValue(JOB_STATUS_RUNNING, "Running"));
177             myValues.addElement(new ValidValue(JOB_STATUS_COMPLETED,
178                     "Completed"));
179 
180             return myValues;
181         }
182 
183         return super.getValidValues(fieldName);
184     } /* getValidValues(String) */
185 
186 
187     public void setCmdStopJob(String   jobID)
188             throws DBException {
189         String   cmd = "stop " + jobID;
190         setField(FLD_COMMAND, cmd);
191     }
192 
193     public void setCmdRestartJob(String   jobID)
194             throws DBException {
195         String   cmd = "restart " + jobID;
196         setField(FLD_COMMAND, cmd);
197     }
198 
199     public void setKillCommand(String   jobID)
200             throws DBException {
201         String   cmd = "kill " + jobID;
202         setField(FLD_COMMAND, cmd);
203     }
204 } /* JobHandlerControl */
205
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags