1 | // Copyright 2012 Georg-August-Universität Göttingen, Germany |
---|
2 | // |
---|
3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
---|
4 | // you may not use this file except in compliance with the License. |
---|
5 | // You may obtain a copy of the License at |
---|
6 | // |
---|
7 | // http://www.apache.org/licenses/LICENSE-2.0 |
---|
8 | // |
---|
9 | // Unless required by applicable law or agreed to in writing, software |
---|
10 | // distributed under the License is distributed on an "AS IS" BASIS, |
---|
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
---|
12 | // See the License for the specific language governing permissions and |
---|
13 | // limitations under the License. |
---|
14 | |
---|
15 | package de.ugoe.cs.autoquest.htmlmonitor; |
---|
16 | |
---|
17 | import java.util.ArrayList; |
---|
18 | import java.util.HashMap; |
---|
19 | import java.util.List; |
---|
20 | import java.util.Map; |
---|
21 | import java.util.Timer; |
---|
22 | import java.util.TimerTask; |
---|
23 | |
---|
24 | import de.ugoe.cs.util.console.Console; |
---|
25 | |
---|
26 | /** |
---|
27 | * <p> |
---|
28 | * The log manager handles different {@link HtmlMonitorOutputWriter}s to perform the logging |
---|
29 | * of recorded messages. It initializes a new writer if the first message for a specific |
---|
30 | * client is received and it closes a writer if for a specific period of time no further message |
---|
31 | * of the same client was received. The writers themselves consider log rotation. For handling |
---|
32 | * messages, the {@link HtmlMonitorMessageListener} mechanism provided by the |
---|
33 | * {@link HtmlMonitorServer} is used. |
---|
34 | * </p> |
---|
35 | * |
---|
36 | * @author Patrick Harms |
---|
37 | */ |
---|
38 | class HtmlMonitorLogManager implements HtmlMonitorComponent, HtmlMonitorMessageListener { |
---|
39 | |
---|
40 | /** |
---|
41 | * the timeout after which a writer of an inactive client is closed |
---|
42 | */ |
---|
43 | private static final int SESSION_TIMEOUT = 100000; |
---|
44 | |
---|
45 | /** |
---|
46 | * the directory into which the log files shall be written |
---|
47 | */ |
---|
48 | private String logFileBaseDir; |
---|
49 | |
---|
50 | /** |
---|
51 | * the mapping of client ids to the respective writers. |
---|
52 | */ |
---|
53 | private Map<String, HtmlMonitorOutputWriter> writers; |
---|
54 | |
---|
55 | /** |
---|
56 | * a timer used to detect client timouts |
---|
57 | */ |
---|
58 | private Timer logFileMonitorTimer; |
---|
59 | |
---|
60 | /** |
---|
61 | * <p> |
---|
62 | * initializes the log manager with the directory into which the log files shall be stored |
---|
63 | * </p> |
---|
64 | * |
---|
65 | * @param logFileBaseDir the directory into which the log files shall be stored |
---|
66 | */ |
---|
67 | HtmlMonitorLogManager(String logFileBaseDir) { |
---|
68 | this.logFileBaseDir = logFileBaseDir; |
---|
69 | } |
---|
70 | |
---|
71 | /* (non-Javadoc) |
---|
72 | * @see de.ugoe.cs.autoquest.htmlmonitor.HtmlMonitorComponent#init() |
---|
73 | */ |
---|
74 | @Override |
---|
75 | public synchronized void init() throws IllegalStateException, HtmlMonitorException { |
---|
76 | if (writers != null) { |
---|
77 | throw new IllegalStateException("already initialized"); |
---|
78 | } |
---|
79 | |
---|
80 | writers = new HashMap<String, HtmlMonitorOutputWriter>(); |
---|
81 | logFileMonitorTimer = new Timer(); |
---|
82 | } |
---|
83 | |
---|
84 | /* (non-Javadoc) |
---|
85 | * @see de.ugoe.cs.autoquest.htmlmonitor.HtmlMonitorComponent#start() |
---|
86 | */ |
---|
87 | @Override |
---|
88 | public synchronized void start() throws IllegalStateException, HtmlMonitorException { |
---|
89 | if (writers == null) { |
---|
90 | throw new IllegalStateException("not initialized"); |
---|
91 | } |
---|
92 | |
---|
93 | logFileMonitorTimer.schedule |
---|
94 | (new LogFileMonitorTimerTask(), SESSION_TIMEOUT / 2, SESSION_TIMEOUT / 2); |
---|
95 | } |
---|
96 | |
---|
97 | /* (non-Javadoc) |
---|
98 | * @see de.ugoe.cs.autoquest.htmlmonitor.HtmlMonitorComponent#stop() |
---|
99 | */ |
---|
100 | @Override |
---|
101 | public synchronized void stop() { |
---|
102 | if (writers != null) { |
---|
103 | logFileMonitorTimer.cancel(); |
---|
104 | |
---|
105 | for (HtmlMonitorOutputWriter writer : writers.values()) { |
---|
106 | writer.stop(); |
---|
107 | } |
---|
108 | } |
---|
109 | |
---|
110 | writers = null; |
---|
111 | } |
---|
112 | |
---|
113 | /* (non-Javadoc) |
---|
114 | * @see HtmlMonitoringListener#handleEvents(HtmlClientInfos, HtmlEvent[]) |
---|
115 | */ |
---|
116 | @Override |
---|
117 | public void handleMessage(HtmlClientInfos clientInfos, |
---|
118 | HtmlGUIElement guiStructure, |
---|
119 | HtmlEvent[] events) |
---|
120 | { |
---|
121 | HtmlMonitorOutputWriter writer = writers.get(clientInfos.getClientId()); |
---|
122 | |
---|
123 | try { |
---|
124 | if (writer == null) { |
---|
125 | synchronized (this) { |
---|
126 | writer = writers.get(clientInfos.getClientId()); |
---|
127 | if (writer == null) { |
---|
128 | writer = |
---|
129 | new HtmlMonitorOutputWriter(logFileBaseDir, clientInfos.getClientId()); |
---|
130 | writer.init(); |
---|
131 | writer.start(); |
---|
132 | writers.put(clientInfos.getClientId(), writer); |
---|
133 | } |
---|
134 | } |
---|
135 | } |
---|
136 | |
---|
137 | writer.handleMessage(clientInfos, guiStructure, events); |
---|
138 | } |
---|
139 | catch (Exception e) { |
---|
140 | Console.printerrln("could not handle message of client " + clientInfos.getClientId() + |
---|
141 | ": " + e); |
---|
142 | e.printStackTrace(); |
---|
143 | Console.logException(e); |
---|
144 | |
---|
145 | // determine, if the writer exists but is not able to log something. In this case, |
---|
146 | // destroy the writer (part of the message may be logged twice through this). |
---|
147 | writer = writers.get(clientInfos.getClientId()); |
---|
148 | if (writer != null) { |
---|
149 | try { |
---|
150 | writer.handleMessage(clientInfos, guiStructure, events); |
---|
151 | } |
---|
152 | catch (Exception e1) { |
---|
153 | synchronized (this) { |
---|
154 | writers.remove(clientInfos.getClientId()); |
---|
155 | writer.stop(); |
---|
156 | } |
---|
157 | } |
---|
158 | } |
---|
159 | } |
---|
160 | } |
---|
161 | |
---|
162 | /** |
---|
163 | * <p> |
---|
164 | * internal timer task used for detecting session timeouts of clients |
---|
165 | * </p> |
---|
166 | * |
---|
167 | * @author Patrick Harms |
---|
168 | */ |
---|
169 | public class LogFileMonitorTimerTask extends TimerTask { |
---|
170 | |
---|
171 | /* (non-Javadoc) |
---|
172 | * @see java.lang.Runnable#run() |
---|
173 | */ |
---|
174 | @Override |
---|
175 | public void run() { |
---|
176 | synchronized (HtmlMonitorLogManager.this) { |
---|
177 | List<String> timeoutSessions = new ArrayList<String>(); |
---|
178 | for (Map.Entry<String, HtmlMonitorOutputWriter> entry : writers.entrySet()) { |
---|
179 | HtmlMonitorOutputWriter writer = entry.getValue(); |
---|
180 | |
---|
181 | if (System.currentTimeMillis() - writer.getLastUpdate() > SESSION_TIMEOUT) { |
---|
182 | timeoutSessions.add(entry.getKey()); |
---|
183 | } |
---|
184 | } |
---|
185 | |
---|
186 | for (String clientId : timeoutSessions) { |
---|
187 | HtmlMonitorOutputWriter writer = writers.remove(clientId); |
---|
188 | writer.stop(); |
---|
189 | } |
---|
190 | } |
---|
191 | } |
---|
192 | |
---|
193 | } |
---|
194 | |
---|
195 | } |
---|