adressevedligehold/tasks/Task.java

package dk.daoas.adressevedligehold.tasks;

import dk.daoas.adressevedligehold.util.TimingHelper;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

public abstract class Task implements Runnable {
        
        private TaskLogger logger = TaskLogger.getInstance(); 
        
        public enum TaskState {
                STATE_QUEUED, STATE_RUNNING, STATE_DONE, STATE_ABORTED;
        }
        
        @SuppressFBWarnings("URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD")//bliver læst via gson - og det forvirrer findbugs
        public static class TaskBean {
                public int id;
                public String description;
                public String detail;
                public String errorMessage;
                public double percentCompleted;
                public String state;
        }
        
        protected volatile boolean abort = false;//mark volatile to make sure value isn't cached by threads
        protected volatile TaskState state = TaskState.STATE_QUEUED;
        protected TaskManager manager;
        private String errorMsg;
        
        private String logMessages;
        
        private int id;
        
        public final void setManager(TaskManager manager) {
                this.manager = manager;
        }
        
        @Override
        public final void run() {
                
                TaskLogger.getInstance().reset();
                
                TimingHelper timing = new TimingHelper();
                
                
                logger.info("Starting " + this.getDescription() );
                
                this.state = TaskState.STATE_RUNNING;
                manager.setCurrentTask(this);
                
                try {
                        taskRun();
                        
                        if (this.state != TaskState.STATE_ABORTED) { //just to make sure we wasn't aborted
                                this.state = TaskState.STATE_DONE;
                        }
                        
                        
                } catch (Exception e) {
                        this.errorMsg = e.getMessage();
                        e.printStackTrace();
                        this.state = TaskState.STATE_ABORTED;
                }
                
                manager.setCurrentTask(null);
                
                logger.info("Done " + this.getDescription() + "   " + timing.getElapsed() + "ms");
                
                logMessages = TaskLogger.getInstance().getBuffer();
        }
        
        public final String getLog() {
                if (this.state == TaskState.STATE_RUNNING) {
                        return TaskLogger.getInstance().getBuffer(); //if live return current log buffer content 
                } else {
                        return logMessages;
                }
        }
        
        public final void setId(int newId) {
                this.id = newId;
        }
        
        public final int getId() {
                return this.id;
        }
        
        public final TaskState getState() {
                return this.state;
        }
        
        public boolean isAborted() {
                return this.abort;
        }
        
        public void doAbort() {
                this.abort = true;
        }
        
        public void doAbort(Exception e) {
                this.abort = true;
                this.errorMsg = e.getMessage();
        }
        
        public TaskBean getTaskBean() {
                TaskBean bean = new TaskBean();
                bean.id = this.getId();
                bean.description = this.getDescription();
                bean.detail = this.getDetail();
                bean.percentCompleted = this.getPercentCompleted();
                bean.state = this.state.toString();
                bean.errorMessage = this.getErrorMessage();
                
                return bean;
        }
        
        public String getErrorMessage() {
                return this.errorMsg;
        }
        
        @Override
        public final boolean equals(Object o) {
                Task otherTask = (Task) o;
                
                return this.getId() == otherTask.getId();
        }
        
        /**
         * @throws Exception
         * 
         * Implementing classes should not catch terminating exceptions but let it propagate to Task the Task::run()
         * method.
         */
        protected abstract void taskRun() throws Exception;
        
        public abstract String getDescription();
        public abstract String getDetail();
        public abstract double getPercentCompleted();
        
}
1	torben	2838	package dk.daoas.adressevedligehold.tasks;
2
3			import dk.daoas.adressevedligehold.util.TimingHelper;
4	torben	2864	import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
5
6	torben	2838	public abstract class Task implements Runnable {
7
8	torben	2903	private TaskLogger logger = TaskLogger.getInstance();
9
10	torben	2838	public enum TaskState {
11			STATE_QUEUED, STATE_RUNNING, STATE_DONE, STATE_ABORTED;
12			}
13
14	torben	2864	@SuppressFBWarnings("URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD")//bliver læst via gson - og det forvirrer findbugs
15	torben	2838	public static class TaskBean {
16	torben	2903	public int id;
17	torben	2838	public String description;
18			public String detail;
19	torben	2844	public String errorMessage;
20	torben	2838	public double percentCompleted;
21			public String state;
22			}
23
24	torben	2913	protected volatile boolean abort = false;//mark volatile to make sure value isn't cached by threads
25	torben	2915	protected volatile TaskState state = TaskState.STATE_QUEUED;
26	torben	2838	protected TaskManager manager;
27	torben	2844	private String errorMsg;
28	torben	2838
29	torben	2903	private String logMessages;
30
31			private int id;
32
33			public final void setManager(TaskManager manager) {
34	torben	2838	this.manager = manager;
35			}
36
37			@Override
38			public final void run() {
39	torben	2903
40			TaskLogger.getInstance().reset();
41
42	torben	2838	TimingHelper timing = new TimingHelper();
43
44	torben	2903
45			logger.info("Starting " + this.getDescription() );
46
47	torben	2838	this.state = TaskState.STATE_RUNNING;
48			manager.setCurrentTask(this);
49
50			try {
51			taskRun();
52	torben	2915
53			if (this.state != TaskState.STATE_ABORTED) { //just to make sure we wasn't aborted
54			this.state = TaskState.STATE_DONE;
55			}
56
57
58	torben	2838	} catch (Exception e) {
59	torben	2844	this.errorMsg = e.getMessage();
60			e.printStackTrace();
61	torben	2838	this.state = TaskState.STATE_ABORTED;
62			}
63
64			manager.setCurrentTask(null);
65
66	torben	2903	logger.info("Done " + this.getDescription() + " " + timing.getElapsed() + "ms");
67
68			logMessages = TaskLogger.getInstance().getBuffer();
69	torben	2838	}
70
71	torben	2903	public final String getLog() {
72			if (this.state == TaskState.STATE_RUNNING) {
73			return TaskLogger.getInstance().getBuffer(); //if live return current log buffer content
74			} else {
75			return logMessages;
76			}
77			}
78	torben	2838
79	torben	2903	public final void setId(int newId) {
80			this.id = newId;
81			}
82
83			public final int getId() {
84			return this.id;
85			}
86
87			public final TaskState getState() {
88	torben	2838	return this.state;
89			}
90
91	torben	2878	public boolean isAborted() {
92			return this.abort;
93			}
94
95	torben	2838	public void doAbort() {
96			this.abort = true;
97			}
98
99	torben	2916	public void doAbort(Exception e) {
100			this.abort = true;
101			this.errorMsg = e.getMessage();
102			}
103
104	torben	2838	public TaskBean getTaskBean() {
105			TaskBean bean = new TaskBean();
106	torben	2903	bean.id = this.getId();
107	torben	2838	bean.description = this.getDescription();
108			bean.detail = this.getDetail();
109			bean.percentCompleted = this.getPercentCompleted();
110			bean.state = this.state.toString();
111	torben	2844	bean.errorMessage = this.getErrorMessage();
112	torben	2838
113			return bean;
114			}
115
116	torben	2844	public String getErrorMessage() {
117			return this.errorMsg;
118			}
119	torben	2838
120	torben	2918	@Override
121			public final boolean equals(Object o) {
122			Task otherTask = (Task) o;
123
124			return this.getId() == otherTask.getId();
125			}
126
127	torben	2844	/**
128			* @throws Exception
129			*
130			* Implementing classes should not catch terminating exceptions but let it propagate to Task the Task::run()
131			* method.
132			*/
133			protected abstract void taskRun() throws Exception;
134
135	torben	2838	public abstract String getDescription();
136			public abstract String getDetail();
137	torben	2891	public abstract double getPercentCompleted();
138	torben	2838
139			}