User: olegnitz
  Date: 02/01/16 17:23:16

  Added:       jetty/src/main/org/apache/jasper/logging DefaultLogger.java
                        JasperLogger.java LogAware.java Logger.java
  Log:
  Jetty source files are in JBoss CVS now.
  Run "merge-mortbay-cvs" target to update them from Jetty CVS.
  Modified Jetty files (if such need will appear) must be explicitely listed in 
build.xml
  
  Revision  Changes    Path
  1.1                  
contrib/jetty/src/main/org/apache/jasper/logging/DefaultLogger.java
  
  Index: DefaultLogger.java
  ===================================================================
  /*
   * ====================================================================
   * 
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999 The Apache Software Foundation.  All rights 
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer. 
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:  
   *       "This product includes software developed by the 
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written 
   *    permission, please contact [EMAIL PROTECTED]
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   */ 
  package org.apache.jasper.logging;
  
  import java.io.Writer;
  import java.io.IOException;
  import javax.servlet.ServletContext;
  
  /**
   * Trivial logger that sends all messages to the default sink.  To
   * change default sink, call Logger.setDefaultSink(Writer)
   *
   * @author Alex Chaffee ([EMAIL PROTECTED])
   * @since  Tomcat 3.1
   **/
  public class DefaultLogger extends Logger {
  
      static private char[] newline;
      static {
        String separator = System.getProperty("line.separator", "\n");
        newline = separator.toCharArray();
      }
      
  
      /**
       * Default constructor leaves the debug output going to the
       * default sink.
       */
      public DefaultLogger() {
          super();
      }
  
  
      /**
       * The servlet context we are associated with.
       */
      protected ServletContext servletContext;
  
  
      /**
       * Construct a logger that writes output to the servlet context log
       * for the current web application.
       *
       * @param servletContext The servlet context for our web application
       */
      public DefaultLogger(ServletContext servletContext) {
          super();
          this.servletContext = servletContext;
      }
  
  
  
      /**
       * Prints log message to default sink
       * 
       * @param message         the message to log.
       */
      protected void realLog(String message) {
          if (servletContext != null) {
              servletContext.log(message);
              return;
          }
        try {
            defaultSink.write(message);
            defaultSink.write(newline);
            flush();
        }
        catch (IOException e) {
            bad(e, message, null);
        }
      }
      
      /**
       * Prints log message to default sink
       * 
       * @param message         the message to log.
       * @param t               the exception that was thrown.
       */
      protected void realLog(String message, Throwable t) {
          if (servletContext != null) {
              servletContext.log(message, t);
              return;
          }
        try {
            defaultSink.write(message);
            defaultSink.write(newline);
            defaultSink.write(throwableToString(t));
            defaultSink.write(newline);
            flush();
        }
        catch (IOException e) {
            bad(e, message, t);
        }
      }
  
      private void bad(Throwable t1, String message, Throwable t2)
      {
        System.err.println("Default sink is unwritable! Reason:");
        if (t1 != null) t1.printStackTrace();
        if (message != null) System.err.println(message);
        if (t2 != null) t2.printStackTrace();
      } 
      
      /**
       * Flush the log. 
       */
      public void flush() {
        try {
            defaultSink.flush();
        }
        catch (IOException e) {
        }
      }    
  }
  
  
  
  1.1                  
contrib/jetty/src/main/org/apache/jasper/logging/JasperLogger.java
  
  Index: JasperLogger.java
  ===================================================================
  /*
   * ====================================================================
   * 
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999 The Apache Software Foundation.  All rights 
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer. 
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:  
   *       "This product includes software developed by the 
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written 
   *    permission, please contact [EMAIL PROTECTED]
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   */ 
  package org.apache.jasper.logging;
  
  import java.io.Writer;
  import java.io.StringWriter;
  import java.io.PrintWriter;
  import java.security.AccessController;
  import java.security.PrivilegedAction;
  import java.util.Date;
  import javax.servlet.ServletException;
  import javax.servlet.ServletContext;
  
  import org.apache.jasper.util.Queue;
  //import org.apache.jasper.core.JasperException;
  
  /**
   * A real implementation of the Logger abstraction. 
   *
   * @author Anil V ([EMAIL PROTECTED])
   * @since  Tomcat 3.1
   */
  public class JasperLogger extends Logger {
      
      /**
       * This is an entry that is created in response to every
       * Logger.log(...) call.
       */
      class LogEntry {
        String logName;
        long date;
        String message;
        Throwable t;
        
        LogEntry(String message, Throwable t) {
            // avoid expensive system call
            if (JasperLogger.this.timestamp)
                this.date = System.currentTimeMillis();
            this.message = message;
            this.t = t;
        }
  
        /**
         * Get the writer into which this log entry needs to be
         * written into. 
         */
        Writer getWriter() {
            return JasperLogger.this.sink;
        }
  
        /**
         * Format the log message nicely into a string.
         */
        public String toString() {
            
            StringBuffer val = new StringBuffer();
  
            // custom output, now with timestamp
            // does anyone actually use non-custom logs?
  
            if( !JasperLogger.this.custom ) {
                val.append("<");
                val.append(JasperLogger.this.getName());
                val.append("> ");
            }
  
            if (JasperLogger.this.timestamp) {
                formatTimestamp( date, val );
                val.append(" - ");
            }
  
            if (message != null) {
                val.append(message);
            }
            
            if (t != null) {
                val.append(" - ");
                val.append(throwableToString( t ));
            }
  
            if( !JasperLogger.this.custom ) {
                val.append("</");
                val.append(JasperLogger.this.getName());
                val.append("> ");
            }
  
            return val.toString();          
        }
      }
  
  
      /**
       * Just one daemon and one queue for all Logger instances.. 
       */
      static LogDaemon logDaemon = null;
      static Queue     logQueue  = null;
  
      ServletContext servletContext = null;
  
      public JasperLogger(ServletContext servletContext) {
        this.servletContext = servletContext;
        init();
      }
  
      public JasperLogger() {
        init();
      }
  
      private void init() {
        if (logDaemon == null || logQueue == null) {
            logQueue = new Queue();
              LogDaemon logDaemon = new LogDaemon(logQueue, servletContext);
              logDaemon.start();               
        }
      }
      
      /**
       * Adds a log message to the queue and returns immediately. The
       * logger daemon thread will pick it up later and actually print
       * it out.
       * 
       * @param message         the message to log.
       */
      protected void realLog(String message) {
        logQueue.put(new LogEntry(message, null));
      }
      
      /**
       * Adds a log message and stack trace to the queue and returns
       * immediately. The logger daemon thread will pick it up later and
       * actually print it out. 
       *
       * @param message         the message to log. 
       * @param t               the exception that was thrown.
       */
      protected void realLog(String message, Throwable t) {
        logQueue.put(new LogEntry(message, t));
      }
      
      /**
       * Flush the log. 
       */
      public void flush() {
        logDaemon.flush();
      }
  
      public String toString() {
        return "JasperLogger(" + getName() + ", " + getPath() + ")";
      }
      
  }
  
  /**
   * The daemon thread that looks in a queue and if it is not empty
   * writes out everything in the queue to the sink.
   */
  class LogDaemon extends Thread {
      LogDaemon(Queue logQueue, ServletContext servletContext) {
        this.logQueue = logQueue;
        this.servletContext = servletContext;
        setDaemon(true);
      }
  
      static char[] newline;
      static String separator;
      static {
        separator = System.getProperty("line.separator", "\n");
        newline = separator.toCharArray();
      }
      
      Runnable flusher = new Runnable() {
        public void run() {
            do {
                JasperLogger.LogEntry logEntry =
                    (JasperLogger.LogEntry) LogDaemon.this.logQueue.pull();
                if (servletContext != null) {
                    servletContext.log(logEntry.toString());
                    servletContext.log(separator);
                } else {
                    Writer writer = logEntry.getWriter();
                    if (writer != null) {
                        try {
                            writer.write(logEntry.toString());
                            writer.write(newline);
                            writer.flush();
                        } catch (Exception ex) { // IOException
                            ex.printStackTrace(); // nowhere else to write it
                        }
                    }
                }
            } while (!LogDaemon.this.logQueue.isEmpty());
        }};
  
      public void run() {
        while (true)
            flusher.run();
      }
  
      public void flush() {
        Thread workerThread = new Thread(flusher);
        workerThread.start();
      }
  
      private Queue logQueue;
      private ServletContext servletContext;
  }
  
  
  
  1.1                  contrib/jetty/src/main/org/apache/jasper/logging/LogAware.java
  
  Index: LogAware.java
  ===================================================================
  /*
   * ====================================================================
   * 
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999 The Apache Software Foundation.  All rights 
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer. 
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:  
   *       "This product includes software developed by the 
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written 
   *    permission, please contact [EMAIL PROTECTED]
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   */
  package org.apache.jasper.logging;
  
  public interface LogAware {
      public void setLogger(Logger logger);
      public Logger.Helper getLoggerHelper();
  }
  
  
  
  1.1                  contrib/jetty/src/main/org/apache/jasper/logging/Logger.java
  
  Index: Logger.java
  ===================================================================
  /*
   * ====================================================================
   * 
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999 The Apache Software Foundation.  All rights 
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer. 
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:  
   *       "This product includes software developed by the 
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written 
   *    permission, please contact [EMAIL PROTECTED]
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   */ 
  package org.apache.jasper.logging;
  
  import java.io.Writer;
  import java.io.PrintWriter;
  import java.io.OutputStreamWriter;
  import java.io.FileWriter;
  import java.io.File;
  import java.io.IOException;
  import java.io.StringWriter;
  
  import java.util.*;
  import java.text.DateFormat;
  import java.text.SimpleDateFormat;
  
  import javax.servlet.ServletException;        // for throwableToString()
  import org.apache.jasper.core.JasperException;        // for throwableToString()
  import org.apache.jasper.util.FastDateFormat;
  
  /**
   * Interface for a logging object. A logging object provides mechanism
   * for logging errors and messages that are of interest to someone who
   * is trying to monitor the system.
   * 
   * @author Anil Vijendran ([EMAIL PROTECTED])
   * @author Alex Chaffee ([EMAIL PROTECTED])
   * @since  Tomcat 3.1
   */
  public abstract class Logger {
  
      // ----- static content -----
      
      /**
       * Verbosity level codes.
       */
      public static final int FATAL = Integer.MIN_VALUE;
      public static final int ERROR = 1;
      public static final int WARNING = 2;
      public static final int INFORMATION = 3;
      public static final int DEBUG = 4;
  
      protected static Writer defaultSink = new OutputStreamWriter(System.err);
      protected static Hashtable loggers = new Hashtable(5);
      protected static Logger defaultLogger = new DefaultLogger();
      static {
        defaultLogger.setVerbosityLevel(DEBUG);
      }
        
  
      /**
       * Prints the log message on a specified logger. 
       *
       * @param name            the name of the logger. 
       * @param message         the message to log. 
       * @param verbosityLevel  what type of message is this? 
       *                                (WARNING/DEBUG/INFO etc)
       */
      /*
        public static void log(String logName, String message, 
                           int verbosityLevel) 
      {
        Logger logger = getLogger(logName);
        if (logger != null)
            logger.log(message, verbosityLevel);
      }
      */
      
      /**
       * Prints the log message on a specified logger at the "default"
       * log leve: INFORMATION
       *
       * @param name            the name of the logger. 
       * @param message         the message to log. 
       */
      /*
        public static void log(String logName, String message)
      {
        Logger logger = getLogger(logName);
        if (logger != null)
            logger.log(message);
      }
      */
      
      /**
       * Set the default output stream that is used by all logging
       * channels. 
       * 
       * @param w               the default output stream. 
       */
      public static void setDefaultSink(Writer w) {
        defaultSink = w;
      }
  
      public static Logger getLogger(String name) {
        return (Logger) loggers.get(name);
      }
  
      /**
       * Get the logger that prints to the default sink
       * (usu. System.err)
       **/
      public static Logger getDefaultLogger() {
        return defaultLogger;
      }
  
      public static Enumeration getLoggerNames() {
        return loggers.keys();
      }
  
      public static void putLogger(Logger logger) {     
        loggers.put(logger.getName(), logger);  
      }
  
      public static void removeLogger(Logger logger) {
        loggers.remove(logger.getName());
      }
  
      /**
       * Converts a Throwable to a printable stack trace, including the
       * nested root cause for a ServletException or JasperException if
       * applicable
       * TODO: JDBCException too
       * 
       * @param t any Throwable, or ServletException, or null
       **/
      public static String throwableToString( Throwable t ) {
        // we could use a StringManager here to get the
        // localized translation of "Root cause:" , but
        // since it's going into a log, no user will see
        // it, and it's desirable that the log file is
        // predictable, so just use English
        return throwableToString( t, "Root cause:" );
      }
  
      /**
       * Converts a Throwable to a printable stack trace, including the
       * nested root cause for a ServletException or JasperException or
       * SQLException if applicable
       * 
       * @param t any Throwable, or ServletException, or null
       * @param rootcause localized string equivalent of "Root Cause"
       **/
      public static String throwableToString( Throwable t, String rootcause ) {
        if (rootcause == null)
            rootcause = "Root Cause:";
        StringWriter sw = new StringWriter();
        PrintWriter w = new PrintWriter(sw);
        printThrowable(w, t, rootcause);
        w.flush();
        return sw.toString();
      }
  
      private static void printThrowable(PrintWriter w, Throwable t, String rootcause 
) {
        if (t != null) {
            t.printStackTrace(w);
            if (t instanceof ServletException) {
                Throwable cause = ((ServletException)t).getRootCause();
                if (cause != null) {
                    w.println(rootcause);
                    printThrowable(w, cause, rootcause);
                }
            }
            else if (t instanceof JasperException) {
                Throwable cause = ((JasperException)t).getRootCause();
                if (cause != null) {
                    w.println(rootcause);
                    printThrowable(w, cause, rootcause);
                }
            }
            else if (t instanceof java.sql.SQLException) {
                java.sql.SQLException sql = 
((java.sql.SQLException)t).getNextException();
                if (sql != null) {
                    w.println("Next SQL Exception:");
                    printThrowable(w, sql, rootcause);
                }
            }
            else if (t instanceof org.xml.sax.SAXException) {
                Throwable embedded = ((org.xml.sax.SAXException)t).getException();
                if (embedded != null) {
                    w.println("Embedded SAX Exception:");
                    printThrowable(w, embedded, rootcause);
                }
            }
        }
      }
      
      /**
       * General purpose nasty hack to determine if an exception can be
       * safely ignored -- specifically, if it's an IOException or
       * SocketException that is thrown in the normal course of a socket
       * closing halfway through a connection, or if it's a weird
       * unknown type of exception.  This is an intractable problem, and
       * this is a bad solution, but at least it's centralized.
       **/
      public static boolean canIgnore(Throwable t) {
        String msg = t.getMessage();
        if (t instanceof java.io.InterruptedIOException) {
            return true;
        }
        else if (t instanceof java.io.IOException) {
            // Streams throw Broken Pipe exceptions if their
            // underlying sockets close
            if( "Broken pipe".equals(msg))
                return true;
        }
        else if (t instanceof java.net.SocketException) {
            // TCP stacks can throw SocketExceptions when the client
            // disconnects.  We don't want this to shut down the
            // endpoint, so ignore it. Is there a more robust
            // solution?  Should we compare the message string to
            // "Connection reset by peer"?
            return true;
        }
        return false;
      }
  
  
      // ----- instance (non-static) content -----
      
      protected boolean custom = true;
      protected Writer sink = defaultSink;
      String path;
      protected String name;
      
      private int level = WARNING;
  
      /**
       * Should we timestamp this log at all?
       **/
      protected boolean timestamp = true;
  
      /**
       * true = The timestamp format is raw msec-since-epoch <br>
       * false = The timestamp format is a custom string to pass to SimpleDateFormat
       **/
      protected boolean timestampRaw = false;
  
      /**
       * The timestamp format string, default is "yyyy-MM-dd hh:mm:ss"
       **/
      protected String timestampFormat = "yyyy-MM-dd hh:mm:ss";
  
      protected DateFormat timestampFormatter
        = new FastDateFormat(new SimpleDateFormat(timestampFormat));
      
      /**
       * Is this Log usable?
       */
      public boolean isOpen() {
        return this.sink != null;
      }
  
      /**
       * Prints the log message at the "default" log level: INFORMATION
       * 
       * @param message         the message to log.
       */
      public final void log(String message) {
        log(message, Logger.INFORMATION);
      }
          
      /**
       * Prints the log message.
       * 
       * @param message         the message to log.
       * @param verbosityLevel  what type of message is this?
       *                                (WARNING/DEBUG/INFO etc)
       */
      public final void log(String message, int verbosityLevel) {
        log(message, null, verbosityLevel);
      }
  
      /**
       * Prints log message and stack trace, with verbosityLevel ERROR.
       * This makes the assumption that throwables are exceptions which
       * are errors by nature; if you disagree, you can always call
       * log(msg, t, Logger.INFORMATION) or whatever.
       *
       * @param message         the message to log. 
       * @param t the exception that was thrown.  */
      public final void log(String message, Throwable t)
      {
        log(message, t, ERROR);
      }
      
      /**
       * Prints log message and stack trace.
       *
       * @param message         the message to log. 
       * @param t               the exception that was thrown.
       * @param verbosityLevel  what type of message is this?
       *                                (WARNING/DEBUG/INFO etc)
       */
      public final void log(String message, Throwable t, 
                          int verbosityLevel) 
      {
        if (matchVerbosityLevel(verbosityLevel)) {
            if (t == null) {
                realLog(message);
            }
            else {
                realLog(message, t);
            }
        }
      }
  
      public boolean matchVerbosityLevel(int verbosityLevel) {
        return verbosityLevel <= getVerbosityLevel();
      }
      
      /**
       * Subclasses implement these methods which are called by the
       * log(..) methods internally.
       *
       * @param message         the message to log.
       */
      protected abstract void realLog(String message);
  
      /** 
       * Subclasses implement these methods which are called by the
       * log(..) methods internally. 
       *
       * @param message         the message to log. 
       * @param t               the exception that was thrown.
       */
      protected abstract void realLog(String message, Throwable t);
      
      /**
       * Flush the log. 
       */
      public abstract void flush();
  
  
      /**
       * Close the log. 
       */
      public synchronized void close() {
        this.sink = null;
        loggers.remove(getName());
      }
      
      /**
       * Get name of this log channel. 
       */
      public String getName() {
        return this.name;
      }
  
      /**
       * Set name of this log channel.
       *
       * @param name            Name of this logger. 
       */
      public void setName(String name) {
        this.name = name;
  
        // Once the name of this logger is set, we add it to the list
        // of loggers... 
        putLogger(this);
      }
  
      /**
       * Set the path name for the log output file.
       * 
       * @param path            The path to the log file. 
       */
      public void setPath(String path) {
          if (File.separatorChar == '/')
              this.path = path.replace('\\', '/');
          else if (File.separatorChar == '\\')
              this.path = path.replace('/', '\\');
      }
  
      public String getPath() {
        return path;
      }
  
      public String toString() {
        return "Logger(" + getName() + ", " + getPath() + ")";
      }
  
      /** Open the log - will create the log file and all the parent directories.
       *  You must open the logger before use, or it will write to System.err
       */
      public void open() {
        if (path == null) 
              return;
        // use default sink == System.err
        try {
            File file = new File(path);
            
            if (!file.exists())
                new File(file.getParent()).mkdirs();
            
            this.sink = new FileWriter(path);
        } catch (IOException ex) {
            System.err.print("Unable to open log file: "+path+"! ");
            System.err.println(" Using stderr as the default.");
            this.sink = defaultSink;
        }
      }
  
      
  
      /**
       * Set the verbosity level for this logger. This controls how the
       * logs will be filtered. 
       *
       * @param level           one of the verbosity level strings. 
       */
      public void setVerbosityLevel(String level) {
        if ("warning".equalsIgnoreCase(level))
            this.level = WARNING;
        else if ("fatal".equalsIgnoreCase(level))
            this.level = FATAL;
        else if ("error".equalsIgnoreCase(level))
            this.level = ERROR;
        else if ("information".equalsIgnoreCase(level))
            this.level = INFORMATION;
        else if ("debug".equalsIgnoreCase(level))
            this.level = DEBUG;
      }
  
      /**
       * Set the verbosity level for this logger. This controls how the
       * logs will be filtered. 
       *
       * @param level           one of the verbosity level codes. 
       */
      public void setVerbosityLevel(int level) {
        this.level = level;
      }
      
      /**
       * Get the current verbosity level. 
       */
      public int getVerbosityLevel() {
        return this.level;
      }
  
      /**
       * Do we need to time stamp this or not?
       *
       * @param value           "yes/no" or "true/false"
       */
      public void setTimestamp(String value) {
        if ("true".equalsIgnoreCase(value) || "yes".equalsIgnoreCase(value))
            timestamp = true;
        else if ("false".equalsIgnoreCase(value) || "no".equalsIgnoreCase(value))
            timestamp = false;
      }
  
      public  boolean isTimestamp() {
        return timestamp;
      }
  
      /**
       * If we are timestamping at all, what format do we use to print
       * the timestamp? See java.text.SimpleDateFormat.
       *
       * Default = "yyyy-MM-dd hh:mm:ss". Special case: "msec" => raw
       * number of msec since epoch, very efficient but not
       * user-friendly
       **/
      public void setTimestampFormat(String value)
      {
        if (value.equalsIgnoreCase("msec"))
            timestampRaw = true;
        else {
            timestampRaw = false;
            timestampFormat = value;
            timestampFormatter =
                new FastDateFormat(new SimpleDateFormat(timestampFormat));
        }
      }
      
      public String getTimestampFormat()
      {
        if (timestampRaw)
            return "msec";
        else
            return timestampFormat;
      }
      
      public void setCustomOutput( String value ) {
        if ("true".equalsIgnoreCase(value) || "yes".equalsIgnoreCase(value))
            custom = true;
        else if ("false".equalsIgnoreCase(value) || "no".equalsIgnoreCase(value))
            custom = false;
      }
  
      protected String formatTimestamp(long msec) {
        StringBuffer buf = new StringBuffer();
        formatTimestamp(msec, buf);
        return buf.toString();
      }
  
      // dummy variable to make SimpleDateFormat work right
      private static java.text.FieldPosition position = new 
java.text.FieldPosition(DateFormat.YEAR_FIELD);
      
      protected void formatTimestamp(long msec, StringBuffer buf) {
        if (timestamp == false)
            return;
        else if (timestampRaw) {
            buf.append(Long.toString(msec));
            return;
        }
        else {
            Date d = new Date(msec);
            timestampFormatter.format(d, buf, position);
            return;
        }
      }
      
      // ----- Logger.Helper static inner class -----
      
      /**
       * Wrapper for Logger. It has a preferred log name to write to; if
       * it can't find a log with that name, it outputs to the default
       * sink.  Also prepends a descriptive name to each message
       * (usually the toString() of the calling object), so it's easier
       * to identify the source.<p>
       *
       * Intended for use by client classes to make it easy to do
       * reliable, consistent logging behavior, even if you don't
       * necessarily have a context, or if you haven't registered any
       * log files yet, or if you're in a non-Tomcat application.  Not
       * intended to supplant Logger, but to allow client objects a
       * consistent bit of code that prepares log messages before they
       * reach logger (and does the right thing if there is no logger).
       * <p>
       * Usage: <pre>
       * class Foo {
       *   Logger.Helper loghelper = new Logger.Helper("tc_log", "Foo"); // or...
       *   Logger.Helper loghelper = new Logger.Helper("tc_log", this); // fills in 
"Foo" for you
       *   ...
       *     loghelper.log("Something happened");
       *     ...
       *     loghelper.log("Starting something", Logger.DEBUG);
       *     ...
       *     catch (IOException e) {
       *       loghelper.log("While doing something", e);
       *     }
       * </pre>
       *
       * @author Alex Chaffee [[EMAIL PROTECTED]]
       **/
      public static class Helper implements LogAware {
  
        private String logname;
        private String prefix;
        private Logger logger;
        private Helper proxy;
  
        /**
         * Subclass constructor, for classes that want to *be* a
         * LogHelper, and get the log methods for free (like a mixin)
         **/
        protected Helper(String logname) {
            this.logname = logname;
            String cname=this.getClass().getName();
            this.prefix = cname.substring( cname.lastIndexOf(".") +1);
        }
  
        /**
         * @param logname name of log to use
         * @param owner object whose class name to use as prefix
         **/
        public Helper(String logname, Object owner) 
        {
            this.logname = logname;
            String cname = owner.getClass().getName();
            this.prefix = cname.substring( cname.lastIndexOf(".") +1);
        }       
  
        /**
         * @param logname name of log to use
         * @param prefix string to prepend to each message
         **/
        public Helper(String logname, String prefix) 
        {
            this.logname = logname;
            this.prefix = prefix;
        }
  
        public Logger getLogger() {
            if (proxy != null)
                logger = proxy.getLogger();
            return logger;
        }
  
        /**
         * Set a logger explicitly.  Also resets the logname property to
         * match that of the given log.
         *
         * <p>(Note that setLogger(null) will not necessarily redirect log
         * output to System.out; if there is a logger named logname it
         * will fall back to using it, or trying to.)
         **/
        public void setLogger(Logger logger) {
            if (logger != null)
                setLogname(logger.getName());
            this.logger = logger;
        }
  
        /**
         * Set the logger by name.  Will throw away current idea of what
         * its logger is, and next time it's asked, will locate the global
         * Logger object if the given name.
         **/    
        public void setLogname(String logname) {
            logger = null;      // prepare to locate a new logger
            this.logname = logname;
        }
  
        /**
         * Set the prefix string to be prepended to each message
         **/
        public void setLogPrefix(String prefix) {
            this.prefix = prefix;
        }
  
        /**
         * Set a "proxy" Logger.Helper -- whatever that one says its
         * Logger is, use it
         **/
        public void setProxy(Helper helper) {
            this.proxy = helper;
        }
  
        public Helper getLoggerHelper() {
            return this;
        }
        
        /**
         * Logs the message with level INFORMATION
         **/
        public void log(String msg) 
        {
            log(msg, null, Logger.INFORMATION);
        }
  
        /**
         * Logs the Throwable with level ERROR (assumes an exception is
         * trouble; if it's not, use log(msg, t, level))
         **/
        public void log(String msg, Throwable t) 
        {
            log(msg, t, Logger.ERROR);
        }
  
        /**
         * Logs the message with given level
         **/
        public void log(String msg, int level) 
        {
            log(msg, null, level);
        }
  
        /**
         * Logs the message and Throwable to its logger or, if logger
         * not found, to the default logger, which writes to the
         * default sink, which is usually System.err
         **/
        public void log(String msg, Throwable t, int level)
        {
            if (prefix != null) {
                // tuneme
                msg = prefix + ": " + msg;
            }
  
            // activate proxy if present
            if (proxy != null)
                logger = proxy.getLogger();
  
            // activate logname fetch if necessary
            if (logger == null) {
                if (logname != null)
                    logger = Logger.getLogger(logname);
            }
  
            // if all else fails, use default logger (writes to default sink)
            Logger loggerTemp = logger;
            if (loggerTemp == null) {
                loggerTemp = defaultLogger;
            }
            loggerTemp.log(msg, t, level);
        }
      }    
  }
  
  
  

_______________________________________________
Jboss-development mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/jboss-development

Reply via email to