001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by Jcorporate Ltd.
021: * (http://www.jcorporate.com/)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. "Jcorporate" and product names such as "Expresso" must
026: * not be used to endorse or promote products derived from this
027: * software without prior written permission. For written permission,
028: * please contact info@jcorporate.com.
029: *
030: * 5. Products derived from this software may not be called "Expresso",
031: * or other Jcorporate product names; nor may "Expresso" or other
032: * Jcorporate product names appear in their name, without prior
033: * written permission of Jcorporate Ltd.
034: *
035: * 6. No product derived from this software may compete in the same
036: * market space, i.e. framework, without prior written permission
037: * of Jcorporate Ltd. For written permission, please contact
038: * partners@jcorporate.com.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
044: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
045: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
046: * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Jcorporate Ltd. Contributions back
056: * to the project(s) are encouraged when you make modifications.
057: * Please send them to support@jcorporate.com. For more information
058: * on Jcorporate Ltd. and its products, please see
059: * <http://www.jcorporate.com/>.
060: *
061: * Portions of this software are based upon other open source
062: * products and are subject to their respective licenses.
063: */
064:
065: package com.jcorporate.expresso.core.controller;
066:
067: import com.jcorporate.expresso.kernel.InstallLog;
068: import org.apache.log4j.Logger;
069:
070: import java.io.ByteArrayOutputStream;
071: import java.io.PrintStream;
072:
073: /**
074: * This is an implementation of the <code>IntallLog</code> interface that is
075: * useful when running installation systems inside controllers. It renders the
076: * log messages as a series of outputs with the following rules:
077: * <p/>
078: * <ul>
079: * <li>For each output, if an exception was logged, there are two nested outputs:
080: * One named 'errorMessage' the other 'stackTrace' which contain the exception
081: * message and the exception stack trace</li>
082: * <li>For each output, a 'color' attribute is set. This attribute can be
083: * used at render time to render the font color of the output. Of course, a JSP
084: * can use different color schemes, but the concept is to provide highest
085: * performance possible</li>
086: * </ul>
087: * </p>
088: * first before using the log or
089: *
090: * @author Michael Rimov
091: * @see com.jcorporate.expresso.kernel.InstallLog
092: * @see com.jcorporate.expresso.kernel.ConsoleInstallLog
093: */
094: public class ControllerInstallLog implements InstallLog {
095:
096: protected ControllerResponse response;
097: protected Block parentBlock;
098:
099: private static final transient Logger log = Logger
100: .getLogger(ControllerInstallLog.class);
101:
102: /**
103: * Constructs a ControllerInstallLog and sets the ControllerResponse that
104: * we will be using to add the outputs to.
105: *
106: * @param theResponse
107: */
108: public ControllerInstallLog(ControllerResponse theResponse) {
109: response = theResponse;
110: parentBlock = null;
111: }
112:
113: /**
114: * The point is that we don't want the default constructor used.
115: */
116: protected ControllerInstallLog() {
117:
118: }
119:
120: /**
121: * Optional method. If you want the outputs to be added to a block rather
122: * than the root of the ControllerResponse then call setParentBlock() before
123: * usage
124: *
125: * @param b the block you wish to use.
126: */
127: public void setParentBlock(Block b) {
128: parentBlock = b;
129: }
130:
131: /**
132: * Helper method that adds the output to either the parent block
133: * or the controller response, depending on what was needed
134: *
135: * @param logMessage the output to add
136: */
137: protected void addOutput(Output logMessage) {
138: try {
139: if (parentBlock == null) {
140: response.add(logMessage);
141: } else {
142: parentBlock.add(logMessage);
143: }
144: } catch (ControllerException ex) {
145: log.warn("Error logging install message", ex);
146: }
147: }
148:
149: /**
150: * Log a debug message
151: *
152: * @param message The message to log.
153: */
154: public void debug(String message) {
155: Output o = new Output("[DEBUG] " + message);
156: o.setAttribute("color", "green");
157: addOutput(o);
158: }
159:
160: /**
161: * Log an info message
162: *
163: * @param message The message to log.
164: */
165: public void info(String message) {
166: Output o = new Output(message);
167: o.setAttribute("color", "black");
168: addOutput(o);
169: }
170:
171: /**
172: * Log a warning message
173: *
174: * @param message The message to log.
175: */
176: public void warn(String message) {
177: Output o = new Output("[WARN] " + message);
178: o.setAttribute("color", "orange");
179: addOutput(o);
180: }
181:
182: /**
183: * Log a warning exception
184: *
185: * @param message The message to log.
186: * @param error The <code>Throwable</code> object to log
187: */
188: public void warn(String message, Throwable error) {
189: Output o = new Output("[WARN] " + message);
190: o.setAttribute("color", "orange");
191: addNestedOutputs(o, error);
192: addOutput(o);
193: }
194:
195: /**
196: * Log an error exception
197: *
198: * @param message The message to log.
199: * @param error The <code>Throwable</code> object to log
200: */
201: public void error(String message, Throwable error) {
202: Output o = new Output("[ERROR] " + message);
203: o.setAttribute("color", "red");
204: addNestedOutputs(o, error);
205: addOutput(o);
206: }
207:
208: /**
209: * Log an error message
210: *
211: * @param message The message to log.
212: */
213: public void error(String message) {
214: Output o = new Output("[ERROR] " + message);
215: o.setAttribute("color", "red");
216: addOutput(o);
217: }
218:
219: /**
220: * Adds the exceptions as nested outputs to the original log message
221: *
222: * @param o the original log message
223: * @param error the exception to log as well.
224: */
225: protected void addNestedOutputs(Output o, Throwable error) {
226: ByteArrayOutputStream bos = new ByteArrayOutputStream();
227: error.printStackTrace(new PrintStream(bos));
228: o.addNested(new Output("stackTrace", bos.toString()));
229: o.addNested(new Output("errorMessage", error.getMessage()));
230: }
231: }
|