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.dbobj;
066:
067: import com.jcorporate.expresso.core.db.DBException;
068: import com.jcorporate.expresso.core.dbobj.RequestContext;
069: import com.jcorporate.expresso.core.dbobj.SecuredDBObject;
070: import com.jcorporate.expresso.core.dbobj.ValidValue;
071: import com.jcorporate.expresso.core.misc.ConfigManager;
072: import com.jcorporate.expresso.core.misc.DateTime;
073:
074: import java.util.Vector;
075:
076: /**
077: * applies operations (commands) to all jobs running on a server.
078: * For example, cause all jobs to stop or restart.
079: *
080: * @author Mike Dubman
081: */
082: public class JobHandlerControl extends SecuredDBObject {
083: public static final String FLD_REQUEST_TIME = "RequestTime";
084: /**
085: * command to apply to all jobs on server. currently, only restart and stop are available
086: */
087: public static final String FLD_COMMAND = "Command";
088: public static final String FLD_UID = "ExpUid";
089: public static final String FLD_STATUS_CODE = "Status";
090: public static final String FLD_SERVERID = "ServerID";
091: public static final String FLD_COMMAND_ID = "CommandId";
092: public static final String JOB_STATUS_NEW = "N";
093: public static final String JOB_STATUS_AVAILABLE = "A";
094: public static final String JOB_STATUS_COMPLETED = "C";
095: public static final String JOB_STATUS_RUNNING = "R";
096:
097: public static final String RESTART_COMMAND = "restart";
098: public static final String STOP_COMMAND = "stop";
099:
100: /**
101: * @throws DBException
102: */
103: public JobHandlerControl() throws DBException {
104: } /* JobHandlerControl() */
105:
106: /**
107: * @param uid the Expresso user id
108: * @throws DBException upon initialization error
109: */
110: public JobHandlerControl(int uid) throws DBException {
111: super (uid);
112: }
113:
114: /**
115: * For using DBObjects within Controllers. Initializes based upon the current
116: * user and the requested db. [Of course this can be modified later]
117: *
118: * @param request - The controller request handed to you by the framework.
119: * @throws DBException upon initialization error
120: */
121: public JobHandlerControl(RequestContext request) throws DBException {
122: super (request);
123: }
124:
125: /**
126: * @throws DBException
127: */
128: protected synchronized void setupFields() throws DBException {
129: setTargetTable("JOBHANDLERCONTROL");
130: setDescription("DBjobHandlerControl");
131: addField(FLD_COMMAND_ID, "auto-inc", 0, false,
132: "commandSerialId");
133: addField(FLD_STATUS_CODE, "varchar", 255, false, "statusCode");
134: addField(FLD_COMMAND, "varchar", 255, false,
135: "jobHandlerCommand");
136: addField(FLD_SERVERID, "int", 0, false, "handlingServer");
137: addField(FLD_UID, "int", 0, false, "requestedByUser");
138: setLookupObject(FLD_UID, ConfigManager
139: .getClassHandler("userInfo"));
140: addField(FLD_REQUEST_TIME, "datetime", 0, false, "requestedAt");
141: addKey("CommandId");
142: } /* setupFields() */
143:
144: public void add() throws DBException {
145:
146: if (getField(FLD_STATUS_CODE).equals("")) {
147: setField(FLD_STATUS_CODE, JOB_STATUS_NEW);
148: }
149:
150: setField(FLD_REQUEST_TIME, DateTime.getDateTimeForDB(this
151: .getDataContext()));
152: setField(FLD_SERVERID, "0");
153: super .add();
154: } /* add() */
155:
156: /**
157: * Override the method getValidValues to provide specific values for our
158: * multi-valued fields
159: *
160: * @param fieldName Field name for which values are requested
161: * @return Vector The ValidValues field
162: * @throws DBException If the values cannot be retrieved
163: */
164: public Vector getValidValues(String fieldName) throws DBException {
165: if (fieldName.equals(FLD_STATUS_CODE)) {
166: Vector myValues = new Vector(4);
167: myValues.addElement(new ValidValue(JOB_STATUS_NEW, "New"));
168: myValues.addElement(new ValidValue(JOB_STATUS_AVAILABLE,
169: "Available"));
170: myValues.addElement(new ValidValue(JOB_STATUS_RUNNING,
171: "Running"));
172: myValues.addElement(new ValidValue(JOB_STATUS_COMPLETED,
173: "Completed"));
174:
175: return myValues;
176: }
177:
178: return super .getValidValues(fieldName);
179: } /* getValidValues(String) */
180:
181: public void setCmdStopJob(String jobID) throws DBException {
182: String cmd = "stop " + jobID;
183: setField(FLD_COMMAND, cmd);
184: }
185:
186: public void setCmdRestartJob(String jobID) throws DBException {
187: String cmd = "restart " + jobID;
188: setField(FLD_COMMAND, cmd);
189: }
190:
191: public void setKillCommand(String jobID) throws DBException {
192: String cmd = "kill " + jobID;
193: setField(FLD_COMMAND, cmd);
194: }
195: } /* JobHandlerControl */
|