1 |
+ |
/* |
2 |
+ |
* i-scream central monitoring system |
3 |
+ |
* http://www.i-scream.org.uk |
4 |
+ |
* Copyright (C) 2000-2002 i-scream |
5 |
+ |
* |
6 |
+ |
* This program is free software; you can redistribute it and/or |
7 |
+ |
* modify it under the terms of the GNU General Public License |
8 |
+ |
* as published by the Free Software Foundation; either version 2 |
9 |
+ |
* of the License, or (at your option) any later version. |
10 |
+ |
* |
11 |
+ |
* This program 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. |
15 |
+ |
* |
16 |
+ |
* You should have received a copy of the GNU General Public License |
17 |
+ |
* along with this program; if not, write to the Free Software |
18 |
+ |
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
19 |
+ |
*/ |
20 |
+ |
|
21 |
|
//---PACKAGE DECLARATION--- |
22 |
< |
package uk.ac.ukc.iscream.core.loggers; |
22 |
> |
package uk.org.iscream.cms.server.core.loggers; |
23 |
|
|
24 |
|
//---IMPORTS--- |
25 |
< |
import uk.ac.ukc.iscream.core.LoggerImpl; |
26 |
< |
import uk.ac.ukc.iscream.core.Logger; |
25 |
> |
import uk.org.iscream.cms.util.*; |
26 |
> |
import uk.org.iscream.cms.server.core.*; |
27 |
|
import java.util.Date; |
28 |
|
import java.text.DateFormat; |
29 |
|
import java.util.Locale; |
40 |
|
* @author $Author$ |
41 |
|
* @version $Id$ |
42 |
|
*/ |
43 |
< |
class FileLogger implements LoggerImpl { |
43 |
> |
public class FileLogger implements LoggerImpl { |
44 |
|
|
45 |
|
//---FINAL ATTRIBUTES--- |
46 |
|
|
66 |
|
* @throws IOException if there is a problem with the file check. |
67 |
|
*/ |
68 |
|
public FileLogger() throws IOException{ |
69 |
< |
_verbosityLevel = Integer.parseInt(System.getProperty("uk.ac.ukc.iscream.Verbosity")); |
50 |
< |
filename = System.getProperty("uk.ac.ukc.iscream.LoggerClassParam1"); |
69 |
> |
filename = System.getProperty("uk.org.iscream.cms.server.LoggerClass.FileLogger.filename"); |
70 |
|
// Perform file check to make sure writing is ok |
71 |
|
if(!fileCheck()){ |
72 |
|
// Have to system.out.println errors because logging mechanism failed ! |
73 |
< |
System.out.println(formatLogLine(this.toString(), "File check failed, construction terminated")); |
73 |
> |
System.out.println(FormatName.formatLogLine(this.toString(), Logger.FATAL, "File check failed, construction terminated")); |
74 |
|
throw new IOException("File check failed, unable to create FileLog"); |
75 |
|
} |
76 |
|
try{ |
80 |
|
open = true; |
81 |
|
} |
82 |
|
catch(IOException e){ |
83 |
< |
System.out.println(formatLogLine(this.toString(), "Attemp to setup writer failed: "+e.getMessage())); |
83 |
> |
System.out.println(FormatName.formatLogLine(this.toString(), Logger.FATAL, "Attempt to setup writer failed - " + e.getMessage())); |
84 |
|
} |
85 |
|
// Put an initial line into the log |
86 |
< |
write(this.toString(), Logger.SYSINIT, "started"); |
68 |
< |
write(this.toString(), Logger.SYSMSG, "using verbosity " + _verbosityLevel); |
86 |
> |
write(toString(), Logger.SYSINIT, "started"); |
87 |
|
} |
88 |
|
|
89 |
|
//---PUBLIC METHODS--- |
90 |
|
|
91 |
< |
/** |
92 |
< |
* The write() method writes a line of log to the file, prepending |
93 |
< |
* it with some information about where to line came from and the |
94 |
< |
* date. This formatting is handled by the formatLogLine() method. |
95 |
< |
* There is some synchronisation here due to problems with the logfiles |
96 |
< |
* having multiple lines written on the same line, followed by dotted |
79 |
< |
* newlines in the wrong places. This is due to this method being |
80 |
< |
* called by multiple threads. |
91 |
> |
/** |
92 |
> |
* The write() method takes a line of text, pre-formatted |
93 |
> |
* and outputs it using a method defined by the actual |
94 |
> |
* implementation. The verbosity is given in case the |
95 |
> |
* implementation wishes to utilise it in the layout - |
96 |
> |
* eg. a different colour or font. |
97 |
|
* |
98 |
< |
* @param source A string representation of the calling object. |
99 |
< |
* @param message The message to be logged. |
100 |
< |
*/ |
101 |
< |
public synchronized void write(String source, int verbosity, String message) { |
98 |
> |
* This instance writes the line to a file. |
99 |
> |
* |
100 |
> |
* @param line A line of formatted text to be logged |
101 |
> |
* @param verbosity the verbosity of this message |
102 |
> |
*/ |
103 |
> |
public synchronized void write(String line, int verbosity) { |
104 |
|
// Check to make sure file is open |
105 |
|
if(open){ |
106 |
|
// Produce a nicely formatted line for the logfile |
89 |
– |
String line = formatLogLine(source, message); |
107 |
|
try{ |
108 |
|
// We have to synchronize here due to problems with two write()'s being called before a newLine() |
109 |
|
synchronized(writer){ |
117 |
|
} |
118 |
|
catch(IOException e){ |
119 |
|
// We'd best log the error |
120 |
< |
System.out.println(formatLogLine(this.toString(), "Writing to logfile failed: "+e.getMessage())); |
120 |
> |
System.out.println(FormatName.formatLogLine(this.toString(), Logger.FATAL, "Writing to logfile failed - " + e.getMessage())); |
121 |
|
// As it's an IOException we should suspend logging |
122 |
|
open = false; |
123 |
|
} |
124 |
|
} |
125 |
|
else{ |
126 |
|
// If file is not open we should print this to the screen |
127 |
< |
System.out.println(formatLogLine(this.toString(), "Write failed: file not open")); |
127 |
> |
System.out.println(FormatName.formatLogLine(this.toString(), Logger.FATAL, "Write failed - file not open")); |
128 |
|
} |
129 |
|
} |
130 |
|
|
137 |
|
public void clear(){ |
138 |
|
// Check file is open |
139 |
|
if(open){ |
140 |
< |
write(this.toString(), Logger.SYSMSG, "Attempting to clear logfile"); |
140 |
> |
write(toString(), Logger.SYSMSG, "Attempting to clear logfile"); |
141 |
|
try{ |
142 |
|
// Close appending writer |
143 |
|
open = false; |
148 |
|
} |
149 |
|
catch(IOException e){ |
150 |
|
// We'd best log the error |
151 |
< |
write(this.toString(), Logger.ERROR, "Attempt to clear logfile failed: "+e.getMessage()); |
151 |
> |
write(toString(), Logger.ERROR, "Attempt to clear logfile failed - "+e.getMessage()); |
152 |
|
// As it's an IOException we should suspend logging |
153 |
|
open = false; |
154 |
|
} |
155 |
|
} |
156 |
|
else{ |
157 |
|
// If file is not open we should print this to the screen |
158 |
< |
System.out.println(formatLogLine(this.toString(), "Clearing failed: file not open")); |
158 |
> |
System.out.println(FormatName.formatLogLine(this.toString(), Logger.FATAL, "Clearing failed - file not open")); |
159 |
|
} |
160 |
|
} |
161 |
|
|
167 |
|
public void close(){ |
168 |
|
// Check to see if a file is open |
169 |
|
if(open){ |
170 |
< |
write(this.toString(), Logger.SYSMSG, "Attempting to terminate logging"); |
170 |
> |
write(toString(), Logger.SYSMSG, "Attempting to terminate logging"); |
171 |
|
try{ |
172 |
|
open = false; |
173 |
|
writer.close(); |
174 |
|
} |
175 |
|
catch(IOException e){ |
176 |
< |
write(this.toString(), Logger.ERROR, "Attempt to close logfile failed: "+e.getMessage()); |
176 |
> |
write(toString(), Logger.ERROR, "Attempt to close logfile failed - " + e.getMessage()); |
177 |
|
// As it's an IOException we should suspend logging |
178 |
|
open = false; |
179 |
|
} |
180 |
|
} |
181 |
|
else{ |
182 |
|
// If file is not open we should print this to the screen |
183 |
< |
System.out.println(formatLogLine(this.toString(), "Close failed: file not open")); |
183 |
> |
System.out.println(FormatName.formatLogLine(this.toString(), Logger.FATAL, "Close failed - file not open")); |
184 |
|
} |
185 |
|
} |
186 |
|
|
197 |
|
// Check to see if a file is open |
198 |
|
if(open){ |
199 |
|
// If file is already open then we should log that this went wrong |
200 |
< |
write(this.toString(), Logger.WARNING, "Open failed: a file is already open"); |
200 |
> |
write(this.toString(), Logger.WARNING, "Open failed - a file is already open"); |
201 |
|
} |
202 |
|
else{ |
203 |
|
this.filename = filename; |
204 |
|
if(!fileCheck()) { |
205 |
|
// Have to system.out.println errors because logging mechanism failed ! |
206 |
< |
System.out.println(formatLogLine(this.toString(), "File check failed, construction terminated")); |
206 |
> |
System.out.println(FormatName.formatLogLine(this.toString(), Logger.FATAL, "File check failed, construction terminated")); |
207 |
|
throw new IOException("File check failed, unable to create FileLog"); |
208 |
|
} |
209 |
|
try{ |
213 |
|
open = true; |
214 |
|
} |
215 |
|
catch(IOException e){ |
216 |
< |
System.out.println(formatLogLine(this.toString(), "Attempt to open writer failed: "+e.getMessage())); |
216 |
> |
System.out.println(FormatName.formatLogLine(this.toString(), Logger.FATAL, "Attempt to open writer failed - " + e.getMessage())); |
217 |
|
} |
218 |
|
} |
219 |
|
} |
228 |
|
// Check to see if a file is open |
229 |
|
if(open){ |
230 |
|
// Make a note of the fact that writing has been suspended |
231 |
< |
write(this.toString(), Logger.SYSMSG, "Writing suspended"); |
231 |
> |
write(toString(), Logger.SYSMSG, "Writing suspended"); |
232 |
|
// Make sure writing not permitted |
233 |
|
open=false; |
234 |
|
} |
235 |
|
else{ |
236 |
|
// If file is not open we should print this to the screen |
237 |
< |
System.out.println(formatLogLine(this.toString(), "Suspend failed: file not open")); |
237 |
> |
System.out.println(FormatName.formatLogLine(this.toString(), Logger.FATAL, "Suspend failed - file not open")); |
238 |
|
} |
239 |
|
} |
240 |
|
|
247 |
|
// Check to see if a file is open |
248 |
|
if(open){ |
249 |
|
// If file is open we should print this to the screen |
250 |
< |
System.out.println(formatLogLine(this.toString(), "Resume failed: file open")); |
250 |
> |
System.out.println(FormatName.formatLogLine(this.toString(), Logger.FATAL, "Resume failed - file open")); |
251 |
|
} |
252 |
|
else{ |
253 |
|
// Permit writing again |
254 |
|
open=true; |
255 |
|
// Make a note of the fact that writing has been resumed |
256 |
< |
write(this.toString(), Logger.SYSMSG, "Writing resumed"); |
256 |
> |
write(toString(), Logger.SYSMSG, "Writing resumed"); |
257 |
|
} |
258 |
|
} |
259 |
|
|
261 |
|
* Overrides the {@link java.lang.Object#toString() Object.toString()} |
262 |
|
* method to provide clean logging (every class should have this). |
263 |
|
* |
264 |
+ |
* This uses the uk.org.iscream.cms.util.FormatName class |
265 |
+ |
* to format the toString() |
266 |
+ |
* |
267 |
|
* @return the name of this class and its CVS revision |
268 |
|
*/ |
269 |
|
public String toString() { |
270 |
< |
return this.getClass().getName() + "(" + REVISION.substring(11, REVISION.length() - 2) + ")"; |
270 |
> |
return FormatName.getName( |
271 |
> |
_name, |
272 |
> |
getClass().getName(), |
273 |
> |
REVISION); |
274 |
|
} |
275 |
|
|
276 |
|
//---PRIVATE METHODS--- |
277 |
|
|
278 |
|
/** |
256 |
– |
* This method generates a nicely formatted line for the log, |
257 |
– |
* including the date/time and the source of the message. The date |
258 |
– |
* and time are formatted using the DateFormat class, and the source |
259 |
– |
* class is formatted using the toString() method found in every |
260 |
– |
* source file. This is then prepended to the message and returned. |
261 |
– |
* |
262 |
– |
* @param source A string representation of the calling object. |
263 |
– |
* @param message The message to be logged. |
264 |
– |
* @return The string to be written to the log. |
265 |
– |
*/ |
266 |
– |
private String formatLogLine(String source, String message){ |
267 |
– |
String date = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.MEDIUM).format(new Date()); |
268 |
– |
return "[" + date + "] " + source + ": " + message; |
269 |
– |
} |
270 |
– |
|
271 |
– |
/** |
279 |
|
* The fileCheck() method is used to ensure that writing is ok. It |
280 |
|
* performs so basic checks to make sure that if the file exists |
281 |
|
* it can be written to, and if not a new file is created. A boolean |
304 |
|
} |
305 |
|
} |
306 |
|
catch(IOException e){ |
307 |
< |
System.out.println(formatLogLine(this.toString(), "File check failed: "+e.getMessage())); |
307 |
> |
System.out.println(FormatName.formatLogLine(this.toString(), Logger.FATAL, "File check failed - "+e.getMessage())); |
308 |
|
} |
309 |
|
|
310 |
|
return fileOK; |
311 |
|
} |
312 |
|
|
313 |
+ |
/** |
314 |
+ |
* This method is provided if this class wishes to log |
315 |
+ |
* a message itself. |
316 |
+ |
* |
317 |
+ |
* @param source A String representation of the source |
318 |
+ |
* @param verbosity the verbosity of this message |
319 |
+ |
* @param message The message to log |
320 |
+ |
*/ |
321 |
+ |
private void write(String source, int verbosity, String message) { |
322 |
+ |
write(FormatName.formatLogLine(source, verbosity, message), verbosity); |
323 |
+ |
} |
324 |
+ |
|
325 |
|
//---ACCESSOR/MUTATOR METHODS--- |
326 |
|
|
327 |
|
//---ATTRIBUTES--- |
331 |
|
*/ |
332 |
|
private String filename; |
333 |
|
|
315 |
– |
/** |
316 |
– |
* The verbosity level of this instance |
317 |
– |
*/ |
318 |
– |
private int _verbosityLevel; |
319 |
– |
|
334 |
|
/** |
335 |
|
* A reference to the writer being used. |
336 |
|
*/ |
340 |
|
* A boolean signifying whether a file is open or not. |
341 |
|
*/ |
342 |
|
private boolean open = false; |
343 |
+ |
|
344 |
+ |
/** |
345 |
+ |
* This is the friendly identifier of the |
346 |
+ |
* component this class is running in. |
347 |
+ |
* eg, a Filter may be called "filter1", |
348 |
+ |
* If this class does not have an owning |
349 |
+ |
* component, a name from the configuration |
350 |
+ |
* can be placed here. This name could also |
351 |
+ |
* be changed to null for utility classes. |
352 |
+ |
*/ |
353 |
+ |
private String _name = Core.NAME; |
354 |
|
|
355 |
|
//---STATIC ATTRIBUTES--- |
356 |
|
|