KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > core > servlet > ServletInstallLog


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */
64
65 package com.jcorporate.expresso.core.servlet;
66
67
68 import com.jcorporate.expresso.kernel.InstallLog;
69 import org.apache.log4j.Logger;
70
71 import java.io.ByteArrayOutputStream JavaDoc;
72 import java.io.IOException JavaDoc;
73 import java.io.PrintStream JavaDoc;
74 import java.io.PrintWriter JavaDoc;
75
76 /**
77  * This is an implementation of the <code>IntallLog</code> interface that is
78  * useful when running installation systems inside servlets.
79  * <p>It renders the output to the servlet output stream.</p>
80  *
81  * @author Michael Rimov
82  * @see com.jcorporate.expresso.kernel.InstallLog
83  * @see com.jcorporate.expresso.kernel.ConsoleInstallLog
84  */
85 public class ServletInstallLog implements InstallLog {
86
87
88     private static final transient Logger log = Logger.getLogger(ServletInstallLog.class);
89
90     private PrintWriter JavaDoc out;
91
92
93     /**
94      * Constructs a ControllerInstallLog and sets the ControllerResponse that
95      * we will be using to add the outputs to.
96      *
97      * @param response
98      */
99     public ServletInstallLog(PrintWriter JavaDoc theOutputStream) throws IOException JavaDoc {
100         out = theOutputStream;
101     }
102
103     /**
104      * The point is that we don't want the default constructor used.
105      */
106     protected ServletInstallLog() {
107
108     }
109
110
111     /**
112      * Log a debug message
113      *
114      * @param message The message to log.
115      */
116     public void debug(String JavaDoc message) {
117         out.println("<p><font color=\"green\"> [DEBUG] " + message + "</font></p>");
118     }
119
120
121     /**
122      * Log an info message
123      *
124      * @param message The message to log.
125      */
126     public void info(String JavaDoc message) {
127         out.println("<p align=\"center\">" + message + "</p>");
128     }
129
130     /**
131      * Log a warning message
132      *
133      * @param message The message to log.
134      */
135     public void warn(String JavaDoc message) {
136         out.println("<p align=\"center\"><font color=\"orange\"> [WARN] " + message + "</font></p>");
137     }
138
139     /**
140      * Log a warning exception
141      *
142      * @param message The message to log.
143      * @param error The <code>Throwable</code> object to log
144      */
145     public void warn(String JavaDoc message, Throwable JavaDoc error) {
146         out.println("<p align=\"center\"><font color=\"orange\"> [WARN] " + message + "</font></p>");
147         writeException(error);
148     }
149
150     /**
151      * Log an error exception
152      *
153      * @param message The message to log.
154      * @param error The <code>Throwable</code> object to log
155      */
156     public void error(String JavaDoc message, Throwable JavaDoc error) {
157         out.println("<p align=\"center\"><font color=\"red\"> [WARN] " + message + "</font></p>");
158         writeException(error);
159     }
160
161     /**
162      * Log an error message
163      *
164      * @param message The message to log.
165      */
166     public void error(String JavaDoc message) {
167         out.println("<p align=\"center\"><font color=\"red\"> [WARN] " + message + "</font></p>");
168     }
169
170
171     /**
172      * Adds the exceptions as nested outputs to the original log message
173      *
174      * @param o the original log message
175      * @param error the exception to log as well.
176      */
177     protected void writeException(Throwable JavaDoc error) {
178         out.println("<p align=\"center\">" + error.getMessage() + "</p>");
179         out.println("<blockquote>");
180         ByteArrayOutputStream JavaDoc bos = new ByteArrayOutputStream JavaDoc();
181         error.printStackTrace(new PrintStream JavaDoc(bos));
182         out.println(bos.toString());
183         out.println("</blockquote>");
184     }
185
186 }
Popular Tags