2 * Copyright (C) 2001, 2002 The Mir-coders group
4 * This file is part of Mir.
6 * Mir is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * Mir is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with Mir; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * In addition, as a special exception, The Mir-coders gives permission to link
21 * the code of this program with any library licensed under the Apache Software License,
22 * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
23 * (or with modified versions of the above that use the same license as the above),
24 * and distribute linked combinations including the two. You must obey the
25 * GNU General Public License in all respects for all of the code used other than
26 * the above mentioned libraries. If you modify this file, you may extend this
27 * exception to your version of the file, but you are not obligated to do so.
28 * If you do not wish to do so, delete this exception statement from your version.
31 package mircoders.global;
34 import java.util.ArrayList;
35 import java.util.Calendar;
36 import java.util.Date;
37 import java.util.GregorianCalendar;
38 import java.util.HashMap;
39 import java.util.Iterator;
40 import java.util.List;
43 import mir.log.LoggerWrapper;
45 // important: objects passed as data must not be altered once put into a job
47 public class JobQueue {
48 private List jobHandlers;
49 private Map identifierToJobHandler;
51 private int jobCleanupTreshold;
52 private JobQueueRunner queueRunner;
53 private Thread thread;
54 private LoggerWrapper logger;
55 private long lastCleanup;
57 public static final int STATUS_CREATED = -1;
58 public static final int STATUS_PENDING = 0;
59 public static final int STATUS_PROCESSING = 1;
60 public static final int STATUS_PROCESSED = 2;
61 public static final int STATUS_CANCELLED = 3;
62 public static final int STATUS_ABORTED = 4;
64 public static final int PRIORITY_NORMAL = 100;
65 public static final int PRIORITY_LOW = 10;
66 public static final int PRIORITY_HIGH = 1000;
68 public static final int FINISHEDJOBS_LOGSIZE = 10;
70 public JobQueue(LoggerWrapper aLogger) {
72 jobHandlers = new ArrayList();
73 identifierToJobHandler = new HashMap();
76 jobCleanupTreshold = 900; // seconds
77 queueRunner = new JobQueueRunner(logger);
78 thread = new Thread(queueRunner, "JobQueue");
79 thread.setDaemon(true);
83 public String appendJob(Job aJob, String aDescription) {
85 if (System.currentTimeMillis() - lastCleanup > 60000) {
90 logger.error("error while cleaning up joblist: " + t.toString());
93 synchronized (jobHandlers) {
94 JobHandler jobHandler = new JobHandler(aJob, Integer.toString(nrJobs), aDescription);
97 jobHandlers.add(jobHandler);
98 identifierToJobHandler.put(jobHandler.getIdentifier(), jobHandler);
100 jobHandler.setPending();
102 jobHandlers.notify();
104 return jobHandler.getIdentifier();
108 public List getJobsInfo() {
109 if (System.currentTimeMillis() - lastCleanup > 60000) {
113 List result = new ArrayList();
115 synchronized (jobHandlers) {
116 Iterator i = jobHandlers.iterator();
118 while (i.hasNext()) {
119 result.add(0, ((JobHandler) i.next()).getJobInfo());
126 private void cleanupJobList() {
127 List toRemove = new ArrayList();
129 synchronized (jobHandlers) {
130 Iterator i = jobHandlers.iterator();
132 Calendar tresholdCalendar = new GregorianCalendar();
133 tresholdCalendar.add(Calendar.SECOND, -jobCleanupTreshold);
134 Date treshold = tresholdCalendar.getTime();
136 while (i.hasNext()) {
137 JobHandler jobHandler = (JobHandler) i.next();
139 synchronized (jobHandler) {
140 if (jobHandler.isFinished() && jobHandler.getLastChange().before(treshold)) {
141 toRemove.add(jobHandler);
142 identifierToJobHandler.remove(jobHandler.getIdentifier());
147 jobHandlers.removeAll(toRemove);
150 lastCleanup = System.currentTimeMillis();
154 * Returns when a new producer job has become available
156 private JobHandler acquirePendingJob() throws InterruptedException {
157 int priorityFound= 0;
160 synchronized (jobHandlers) {
163 Iterator i = jobHandlers.iterator();
164 while (i.hasNext()) {
165 JobHandler job = (JobHandler) i.next();
167 if (job.isPending() && (jobFound==null || priorityFound<job.getPriority())) {
169 priorityFound = job.getPriority();
173 if (jobFound==null) {
177 } while (jobFound==null);
183 public void cancelJobs(List aJobs) {
184 synchronized (jobHandlers) {
185 Iterator i = aJobs.iterator();
187 while (i.hasNext()) {
188 ((JobHandler) identifierToJobHandler.get(i.next())).cancelOrAbortJob();
193 public void cancelAllJobs() {
194 synchronized (jobHandlers) {
195 Iterator i = jobHandlers.iterator();
197 while (i.hasNext()) {
198 ((JobHandler) i.next()).cancelOrAbortJob();
203 public interface Job {
205 * This method should cause the run() method to terminate as soon as
211 * This method should perform the actions associated with the job.
212 * @return <code>true</code> if terminated normally, <code>false</code> if aborted
217 public static class JobInfo {
218 private String identifier;
219 private Date lastChange;
221 private long runningTime;
222 private int priority;
223 private String description;
225 private JobInfo(String aDescription, int aStatus, Date aLastChange, String anIdentifier, long aRunningTime, int aPriority) {
226 description = aDescription;
227 lastChange = aLastChange;
229 identifier = anIdentifier;
230 priority = aPriority;
231 runningTime = aRunningTime;
234 public String getDescription() {
238 public int getStatus() {
242 public int getPriority() {
246 public Date getLastChange() {
250 public String getIdentifier() {
254 public long getRunningTime() {
259 public class JobHandler {
261 private String identifier;
262 private String description;
264 private Date lastChange;
265 private long starttime;
266 private long endtime;
268 private int priority;
269 private boolean hasRun;
271 public JobHandler(Job aJob, String anIdentifier, String aDescription, int aPriority) {
273 description = aDescription;
274 identifier = anIdentifier;
275 priority = aPriority;
276 status = STATUS_CREATED;
279 public JobHandler(Job aJob, String anIdentifier, String aDescription) {
280 this(aJob, anIdentifier, aDescription, PRIORITY_NORMAL);
283 public JobInfo getJobInfo() {
284 return new JobInfo(getDescription(), getStatus(), getLastChange(), getIdentifier(), getRunningTime(), priority);
287 private void runJob() {
288 if (setProcessing()) {
296 private void cancelOrAbortJob() {
297 synchronized (this) {
305 public int getStatus() {
311 public String getIdentifier() {
315 public String getDescription() {
319 public long getRunningTime() {
327 result = System.currentTimeMillis();
329 result = result - starttime;
336 public int getPriority() {
340 private boolean setProcessing() {
341 return setStatus(STATUS_PENDING, STATUS_PROCESSING);
344 private void setProcessed() {
345 setStatus(STATUS_PROCESSING, STATUS_PROCESSED);
348 private void setAborted() {
349 setStatus(STATUS_PROCESSING, STATUS_ABORTED);
352 private void setPending() {
353 setStatus(STATUS_CREATED, STATUS_PENDING);
356 private boolean setCancelled() {
357 return setStatus(STATUS_PENDING, STATUS_CANCELLED);
360 public boolean hasBeenProcessed() {
361 return getStatus() == STATUS_PROCESSED;
364 public boolean hasBeenAborted() {
365 return getStatus() == STATUS_ABORTED;
368 public boolean isCancelled() {
369 return getStatus() == STATUS_CANCELLED;
372 public boolean isFinished() {
373 return hasBeenProcessed() || hasBeenAborted() || isCancelled();
376 public boolean isProcessing() {
377 return getStatus() == STATUS_PROCESSING;
380 public boolean isPending() {
381 return getStatus() == STATUS_PENDING;
384 public Date getLastChange() {
385 synchronized (this) {
390 private boolean setStatus(int anOldStatus, int aNewStatus) {
392 if (status == anOldStatus) {
394 lastChange = (new GregorianCalendar()).getTime();
395 if (isProcessing()) {
396 starttime = System.currentTimeMillis();
401 endtime = System.currentTimeMillis();
410 private class JobQueueRunner implements Runnable {
412 public JobQueueRunner(LoggerWrapper aLogger) {
417 logger.debug("starting JobQueueRunner");
422 JobHandler job = acquirePendingJob();
424 logger.debug(" starting job ("+job.getIdentifier()+"): " +job.getDescription());
426 logger.debug(" finished job ("+job.getIdentifier()+"): " +job.getDescription());
430 catch (InterruptedException e) {
435 logger.warn("JobQueueRunner terminated");