replaced logkit logger with the logger interface in avalon framework

Submitted by:	Michael Gratton <mjg@recalldesign.com>


git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@194733 13f79535-47bb-0310-9956-ffa450edef68

build.bat

 
 set LIBDIR=lib
 set LOCALCLASSPATH=%JAVA_HOME%\lib\tools.jar;%JAVA_HOME%\lib\classes.zip;%LIBDIR%\ant.jar;%LIBDIR%\batik.jar;%LIBDIR%\buildtools.jar;%LIBDIR%\xerces-1.4.3.jar;%LIBDIR%\xalan-2.2D11.jar
-set LOCALCLASSPATH=%LOCALCLASSPATH%;%LIBDIR%\jimi-1.0.jar;%LIBDIR%\logkit-1.0.jar
+set LOCALCLASSPATH=%LOCALCLASSPATH%;%LIBDIR%\jimi-1.0.jar;%LIBDIR%\avalon-framework-cvs-20020315.jar
 
 set ANT_HOME=%LIBDIR%
 

build.sh

 fi
 LIBDIR=lib
 LOCALCLASSPATH=$JAVA_HOME/lib/tools.jar:$JAVA_HOME/lib/classes.zip:$LIBDIR/ant.jar:$LIBDIR/batik.jar:$LIBDIR/buildtools.jar:$LIBDIR/xerces-1.4.3.jar:$LIBDIR/xalan-2.2D11.jar
-LOCALCLASSPATH=$LOCALCLASSPATH:$LIBDIR/jimi-1.0.jar:$LIBDIR/logkit-1.0.jar
+LOCALCLASSPATH=$LOCALCLASSPATH:$LIBDIR/jimi-1.0.jar:$LIBDIR/avalon-framework-cvs-20020315.jar
 
 ANT_HOME=$LIBDIR
 

build.xml

        <include name="lib/xerces-1.4.3.jar"/>
        <include name="lib/xalan-2.2D11.jar"/>
        <include name="lib/batik.jar"/>
-       <include name="lib/logkit-1.0.jar"/>
+       <include name="lib/avalon-framework-cvs-20020315.jar"/>
        <include name="lib/jimi*"/>
     </fileset>
 
     <taskdef name="runTest" classname="org.apache.fop.tools.anttasks.RunTest"/>
 
     <property name="main.class" value="org.apache.fop.apps.Fop"/>
-    <property name="runtime.classpath" value="lib/xerces-1.4.3.jar lib/xalan-2.2D11.jar lib/batik.jar lib/jimi-1.0.jar lib/logkit-1.0.jar"/>
+    <property name="runtime.classpath" value="lib/xerces-1.4.3.jar lib/xalan-2.2D11.jar lib/batik.jar lib/jimi-1.0.jar lib/avalon-framework-cvs-20020315.jar"/>
    
     <filter filtersfile="${build.src}/codegen/filter"/>
 

docs/xml-docs/fop/embedding.xml

    driver.setRenderer(RENDER_PDF);
    driver.run();]]></source>
 
+  <p>You also need to set up logging. Global logging for all FOP
+    processes is managed by MessageHandler. Per-instance logging
+    is handled by Driver. You want to set both using an implementation
+    of org.apache.avalon.framework.logger.Logger. See
+    <jump href="http://jakarta.apache.org/avalon/framework/">Jakarta
+    Avalon Framework</jump> for more information.
+  </p>
+    <source><![CDATA[
+    Logger logger = new ConsoleLogger(ConsoleLogger.LEVEL_INFO);
+    MessageHandler.setScreenLogger(logger);
+    driver.setLogger(logger);]]></source>
+
   <p>To setup the user config file you can do the following
   </p>
     <source><![CDATA[

fop.bat

-java -cp build\fop.jar;lib\batik.jar;lib\xalan-2.0.0.jar;lib\xerces-1.2.3.jar;lib\avalon-framework-4.0.jar;lib\logkit-1.0b4.jar;lib\jimi-1.0.jar org.apache.fop.apps.Fop %1 %2 %3 %4 %5 %6 %7 %8
+java -cp build\fop.jar;lib\batik.jar;lib\xalan-2.0.0.jar;lib\xerces-1.2.3.jar;lib\avalon-framework-4.0.jar;lib\avalon-framework-cvs-20020315.jar;lib\jimi-1.0.jar org.apache.fop.apps.Fop %1 %2 %3 %4 %5 %6 %7 %8

lib/logkit-1.0.LICENSE.txt → lib/avalon.LICENSE.txt

                    The Apache Software License, Version 1.1
  ============================================================================
  
- Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
+ Copyright (C) @year@ The Apache Software Foundation. All rights reserved.
  
  Redistribution and use in source and binary forms, with or without modifica-
  tion, are permitted provided that the following conditions are met:
     Alternately, this  acknowledgment may  appear in the software itself,  if
     and wherever such third-party acknowledgments normally appear.
  
- 4. The names "Apache Cocoon" 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
-    apache@apache.org.
+ 4. The names "Jakarta", "Apache Avalon", "Avalon Excalibur", "Avalon
+    Framework" 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 apache@apache.org.
  
  5. Products  derived from this software may not  be called "Apache", nor may
     "Apache" appear  in their name,  without prior written permission  of the

src/org/apache/fop/apps/CommandLineOptions.java

 import org.apache.fop.configuration.Configuration;
 import org.apache.fop.apps.FOPException;
 
-import org.apache.log.*;
-import org.apache.log.format.*;
-import org.apache.log.output.io.*;
-import org.apache.log.output.*;
+// Avalon
+import org.apache.avalon.framework.logger.ConsoleLogger;
+import org.apache.avalon.framework.logger.Logger;
 
 import java.io.*;
 
     public CommandLineOptions(String[] args)
             throws FOPException, FileNotFoundException {
 
-        Hierarchy hierarchy = Hierarchy.getDefaultHierarchy();
-        PatternFormatter formatter = new PatternFormatter(
-           "[%{priority}]: %{message}\n%{throwable}" );
-
-        LogTarget target = null;
-        boolean doConsoleLogging = true;
-        if (doConsoleLogging) {
-            target = new StreamTarget(System.out, formatter);
-        } else {
-            try {
-                File f = new File("fop.log");
-                target = new FileTarget(f, false, formatter);
-            } catch (IOException e) {}
-        }
-
-        hierarchy.setDefaultLogTarget(target);
-        log = hierarchy.getLoggerFor("fop");
-        log.setPriority(Priority.INFO);
+        log = new ConsoleLogger(ConsoleLogger.LEVEL_INFO);
 
         boolean optionsParsed = true;
         rendererOptions = new java.util.HashMap();
         for (int i = 0; i < args.length; i++) {
             if (args[i].equals("-d") || args[i].equals("--full-error-dump")) {
                 errorDump = new Boolean(true);
-                log.setPriority(Priority.DEBUG);
+                log = new ConsoleLogger(ConsoleLogger.LEVEL_DEBUG);
             } else if (args[i].equals("-x")
                        || args[i].equals("--dump-config")) {
                 dumpConfiguration = new Boolean(true);
             } else if (args[i].equals("-q") || args[i].equals("--quiet")) {
                 quiet = new Boolean(true);
-                log.setPriority(Priority.ERROR);
+                log = new ConsoleLogger(ConsoleLogger.LEVEL_ERROR);
             } else if (args[i].equals("-c")) {
                 if ((i + 1 == args.length)
                         || (args[i + 1].charAt(0) == '-')) {

src/org/apache/fop/apps/CommandLineStarter.java

 import org.xml.sax.SAXException;
 import org.xml.sax.SAXParseException;
 
-import org.apache.log.*;
-
 // Java
 import java.io.*;
 import java.net.URL;

src/org/apache/fop/apps/Driver.java

 
 import org.apache.fop.render.pdf.PDFRenderer;
 
-import org.apache.log.*;
-import org.apache.log.format.*;
-import org.apache.log.output.io.*;
-import org.apache.log.output.*;
+// Avalon
+import org.apache.avalon.framework.logger.ConsoleLogger;
+import org.apache.avalon.framework.logger.Logger;
 
 // DOM
 import org.w3c.dom.Document;
 
     private Logger getLogger() {
         if(log == null) {
-            Hierarchy hierarchy = Hierarchy.getDefaultHierarchy();
-            PatternFormatter formatter = new PatternFormatter(
-               "[%{priority}]: %{message}\n%{throwable}" );
+	    log = new ConsoleLogger(ConsoleLogger.LEVEL_INFO);
+	    log.error("Logger not set");
+	}
 
-            LogTarget target = null;
-            target = new StreamTarget(System.out, formatter);
-
-            hierarchy.setDefaultLogTarget(target);
-            log = hierarchy.getLoggerFor("fop");
-            log.setPriority(Priority.INFO);
-            log.error("Logger not set");
-        }
         return log;
     }
 

src/org/apache/fop/apps/Starter.java

 
 package org.apache.fop.apps;
 
-import org.apache.log.*;
+// Avalon
+import org.apache.avalon.framework.logger.Logger;
 
 // SAX
 import org.xml.sax.XMLReader;

src/org/apache/fop/apps/StreamRenderer.java

 import org.apache.fop.extensions.ExtensionObj;
 import org.apache.fop.fo.pagination.PageSequence;
 
-import org.apache.log.Logger;
+import org.apache.avalon.framework.logger.Logger;
 
 /**
   This class acts as a bridge between the XML:FO parser

src/org/apache/fop/datatypes/ToBeImplementedProperty.java

 
 import org.apache.fop.fo.*;
 
-import org.apache.log.*;
-
 public class ToBeImplementedProperty extends Property {
 
     public static class Maker extends Property.Maker {
     }
 
     public ToBeImplementedProperty(String propName) {
-        Logger log = Hierarchy.getDefaultHierarchy().getLoggerFor("fop");
-        log.warn("property - \"" + propName
-                               + "\" is not implemented yet.");
+
+	// XXX: (mjg@recalldesign.com) This is a bit of a kluge, perhaps an
+	// UnimplementedPropertyException or something similar should
+	// get thrown here instead.
+	//
+	// This was solved on the maintenance branch by using
+	// MessageHandler, btu that doesn't exist on the trunk
+
+//         Logger log = Hierarchy.getDefaultHierarchy().getLoggerFor("fop");
+//         log.warn("property - \"" + propName
+//                                + "\" is not implemented yet.");
     }
 
 }

src/org/apache/fop/fo/FONode.java

 import org.apache.fop.layout.Area;
 import org.apache.fop.util.CharUtilities;
 
-import org.apache.log.Logger;
+// Avalon
+import org.apache.avalon.framework.logger.Logger;
 
 import org.xml.sax.Attributes;
 

src/org/apache/fop/fo/FOTreeBuilder.java

 import org.apache.fop.fo.pagination.PageSequence;
 import org.apache.fop.extensions.ExtensionObj;
 
-import org.apache.log.Logger;
+// Avalon
+import org.apache.avalon.framework.logger.Logger;
 
 // SAX
 import org.xml.sax.helpers.DefaultHandler;

src/org/apache/fop/fo/FOUserAgent.java

 
 import org.apache.fop.render.XMLHandler;
 import org.apache.fop.render.RendererContext;
-import org.apache.log.Logger;
+
+import org.apache.avalon.framework.logger.Logger;
 
 import org.w3c.dom.*;
 

src/org/apache/fop/fo/Property.java

 import org.apache.fop.apps.FOPException;
 import java.util.Vector;
 
-import org.apache.log.Logger;
+import org.apache.avalon.framework.logger.Logger;
 
 public class Property {
 

src/org/apache/fop/fo/pagination/PageNumberGenerator.java

 
 package org.apache.fop.fo.pagination;
 
+// FOP
 import org.apache.fop.fo.properties.*;
 
-import org.apache.log.*;
+// Avalon
+import org.apache.avalon.framework.logger.Logger;
 
 // Java
 import java.util.*;

src/org/apache/fop/image/ImageCache.java

 // FOP
 import org.apache.fop.fo.FOUserAgent;
 
-import org.apache.log.Logger;
-
 public interface ImageCache {
     public FopImage getImage(String url, FOUserAgent context);
     public void releaseImage(String url, FOUserAgent context);

src/org/apache/fop/image/ImageFactory.java

 import org.apache.fop.image.analyser.ImageReader;
 import org.apache.fop.fo.FOUserAgent;
 
-import org.apache.log.Logger;
+// Avalon
+import org.apache.avalon.framework.logger.Logger;
 
 /*
 handle context: base dir, logger, caching

src/org/apache/fop/render/AbstractRenderer.java

 import org.apache.fop.area.inline.Space;
 import org.apache.fop.fo.FOUserAgent;
 
-import org.apache.log.Logger;
+// Avalon
+import org.apache.avalon.framework.logger.Logger;
 
 // Java
 import java.awt.geom.Rectangle2D;

src/org/apache/fop/render/Renderer.java

 import org.apache.fop.layout.FontInfo;
 import org.apache.fop.fo.FOUserAgent;
 
-import org.apache.log.Logger;
+// Avalon
+import org.apache.avalon.framework.logger.Logger;
 
 // Java
 import java.io.OutputStream;

src/org/apache/fop/render/RendererContext.java

 
 import org.apache.fop.fo.FOUserAgent;
 
-import org.apache.log.Logger;
-
 import java.util.HashMap;
 
 /**

src/org/apache/fop/render/XMLHandler.java

 
 package org.apache.fop.render;
 
-import org.apache.log.Logger;
-
 import org.w3c.dom.Document;
 
 /**

src/org/apache/fop/render/pdf/PDFXMLHandler.java

 import org.apache.fop.svg.SVGUserAgent;
 import org.apache.fop.layout.FontState;
 
-import org.apache.log.Logger;
-
 import org.apache.batik.dom.util.DOMUtilities;
 
 import org.w3c.dom.Document;

src/org/apache/fop/render/ps/PSRenderer.java

 import org.apache.batik.gvt.filter.*;
 import org.apache.batik.gvt.event.*;
 
-import org.apache.log.Logger;
-
 // SVG
 import org.w3c.dom.svg.SVGSVGElement;
 import org.w3c.dom.svg.SVGDocument;

src/org/apache/fop/render/xml/XMLRenderer.java

 import org.apache.fop.layout.FontInfo;
 import org.apache.fop.apps.FOPException;
 
-import org.apache.log.Logger;
+// Avalon
+import org.apache.avalon.framework.logger.Logger;
 
 // Java
 import java.io.IOException;

src/org/apache/fop/render/xml/XMLXMLHandler.java

 import org.apache.fop.render.XMLHandler;
 import org.apache.fop.render.RendererContext;
 
-import org.apache.log.Logger;
-
 import org.apache.batik.dom.util.DOMUtilities;
 
 import org.w3c.dom.Document;

src/org/apache/fop/svg/SVGUserAgent.java

 
 import org.apache.fop.fo.FOUserAgent;
 
-import org.apache.log.Logger;
-
 import org.apache.batik.bridge.*;
 import org.apache.batik.swing.svg.*;
 import org.apache.batik.swing.gvt.*;
 import org.apache.batik.gvt.filter.*;
 import org.apache.batik.gvt.event.*;
 
+import org.apache.avalon.framework.logger.Logger;
+
 import org.w3c.dom.*;
 import org.w3c.dom.svg.*;
 import org.w3c.dom.css.*;

src/org/apache/fop/tools/AreaTreeBuilder.java

 import org.apache.fop.layout.FontState;
 import org.apache.fop.fo.FOUserAgent;
 
-import org.apache.log.*;
-import org.apache.log.format.*;
-import org.apache.log.output.io.*;
-import org.apache.log.output.*;
+import org.apache.avalon.framework.logger.ConsoleLogger;
+import org.apache.avalon.framework.logger.Logger;
 
 import java.io.*;
 import java.util.*;
  * out of order rendering
  */
 public class AreaTreeBuilder {
-    private Logger log;
+    private Logger log = new ConsoleLogger(ConsoleLogger.LEVEL_DEBUG);
 
     /**
      */
         System.exit(0);
     }
 
-    public AreaTreeBuilder() {
-        setupLogging();
-    }
-
-    private void setupLogging() {
-        Hierarchy hierarchy = Hierarchy.getDefaultHierarchy();
-        PatternFormatter formatter = new PatternFormatter("[%{priority}]: %{message}\n%{throwable}");
-
-        LogTarget target = null;
-        target = new StreamTarget(System.out, formatter);
-
-        hierarchy.setDefaultLogTarget(target);
-        log = hierarchy.getLoggerFor("test");
-        log.setPriority(Priority.DEBUG);
-    }
-
     /**
      *
      */

src/org/apache/fop/tools/TestConverter.java

 import org.apache.fop.apps.*;
 import org.apache.fop.configuration.*;
 
-import org.apache.log.*;
-import org.apache.log.format.*;
-import org.apache.log.output.io.*;
-import org.apache.log.output.*;
+import org.apache.avalon.framework.logger.ConsoleLogger;
+import org.apache.avalon.framework.logger.Logger;
 
 import java.io.*;
 import java.util.*;
     }
 
     private void setupLogging() {
-        Hierarchy hierarchy = Hierarchy.getDefaultHierarchy();
-        PatternFormatter formatter = new PatternFormatter(
-           "[%{priority}]: %{message}\n%{throwable}" );
-
-        LogTarget target = null;
-        target = new StreamTarget(System.out, formatter);
-
-        hierarchy.setDefaultLogTarget(target);
-        log = hierarchy.getLoggerFor("test");
-        log.setPriority(Priority.ERROR);
+	log = new ConsoleLogger(ConsoleLogger.LEVEL_ERROR);
     }
 
     public void setOutputPDF(boolean pdf) {

src/org/apache/fop/tools/anttasks/Fop.java

 import org.apache.tools.ant.*;
 import org.apache.tools.ant.types.FileSet;
 
-import org.apache.log.*;
-import org.apache.log.format.*;
-import org.apache.log.output.io.*;
-import org.apache.log.output.*;
-
 // SAX
 import org.xml.sax.XMLReader;
 import org.xml.sax.InputSource;
 import org.apache.fop.apps.FOPException;
 import org.apache.fop.configuration.Configuration;
 
+// Avalon
+import org.apache.avalon.framework.logger.ConsoleLogger;
+import org.apache.avalon.framework.logger.Logger;
+
 /**
  * Wrapper for Fop which allows it to be accessed from within an Ant task.
  * Accepts the inputs:
     FOPTaskStarter(Fop task) throws FOPException {
         this.task = task;
 
-	Hierarchy hierarchy = Hierarchy.getDefaultHierarchy();
-        // PatternFormatter formatter = new PatternFormatter(
-        //   "[%{priority}] %{category}: %{message}\n%{throwable}" );
-        PatternFormatter formatter = new PatternFormatter("%{message}\n%{throwable}");
-
-        LogTarget target = null;
-        boolean doConsoleLogging = true;
-        if (doConsoleLogging) {
-            target = new StreamTarget(System.out, formatter);
-        } else {
-            try {
-                File f = new File("fop.log");
-                target = new FileTarget(f, false, formatter);
-            } catch (IOException e) {}
-        }
-
-        hierarchy.setDefaultLogTarget(target);
-        log = hierarchy.getLoggerFor("fop");
-        log.setPriority(Priority.INFO);
+	log = new ConsoleLogger(ConsoleLogger.LEVEL_INFO);
     }
 
     private int determineRenderer(String format) {