[cp-patches] PATCH: debug logging

[Casey Marshall]

Hi,

Attached is an initial implementation of a component-level logging
system, like I mentioned earlier on the Classpath list. Comments are
welcome.

/* Component.java -- a component log level.
   Copyright (C) 2005  Free Software Foundation, Inc.

This file is a part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at
your option) any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License along
with GNU Classpath; if not, write to the

   Free Software Foundation, Inc.,
   59 Temple Place, Suite 330,
   Boston, MA  02111-1307
   USA

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under terms
of your choice, provided that you also meet, for each linked independent
module, the terms and conditions of the license of that module.  An
independent module is a module which is not derived from or based on
this library.  If you modify this library, you may extend this exception
to your version of the library, but you are not obligated to do so.  If
you do not wish to do so, delete this exception statement from your
version.  */


package gnu.classpath.debug;

import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.util.logging.Level;

public final class Component extends Level
{
  /**
   * Signifies that everything should be logged. This should be used to
   * enable or disable levels only; logging code should not use it.
   */
  public static final Component EVERYTHING = new Component ("*", 
0xFFFFFFFFFFFFFFFFL);

  /**
   * Signifies that all SSL related messages should be logged. This should
   * be used to enable or disable levels only; logging code should not use
   * it.
   */
  public static final Component SSL = new Component ("SSL", 0x7);

  /**
   * Traces the progression of an SSL handshake.
   */
  public static final Component SSL_HANDSHAKE = new Component ("SSL HANDSHAKE", 
1);

  /**
   * Traces the application messages during SSL communications.
   */
  public static final Component SSL_APPLICATION = new Component ("SSL 
APPLICATION", 1 << 1);

  /**
   * Trace details about the SSL key exchange.
   */
  public static final Component SSL_KEY_EXCHANGE = new Component ("SSL KEY 
EXCHANGE", 1 << 2);

  /**
   * Trace the operation of cryptographic primitives.
   */
  public static final Component CRYPTO = new Component ("CRYPTO", 1 << 3);

  /**
   * Trace the parsing of X.509 certificates and related objects.
   */
  public static final Component X509 = new Component ("X.509", 1 << 4);

  private final long bitValue;

  private Component (final String name, final long bitValue)
  {
    super (name, Level.FINE.intValue ());
    this.bitValue = bitValue;
  }

  /**
   * Return the component for the given name.
   *
   * @param name The name of the component to get.
   * @return The named component, or null if there is no such component.
   */
  public static Component forName (final String name)
  {
    try
      {
        Field f = Component.class.getField (name.toUpperCase ());
        if (!Modifier.isStatic (f.getModifiers ())
            || Component.class.isAssignableFrom (f.getClass ()))
          return null;
        return (Component) f.get (null);
      }
    catch (Throwable _)
      {
        return null;
      }
  }

  public long bitValue ()
  {
    return bitValue;
  }
}

/* PreciseFilter.java -- filter log messages by precise level.
   Copyright (C) 2005  Free Software Foundation, Inc.

This file is a part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at
your option) any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License along
with GNU Classpath; if not, write to the

   Free Software Foundation, Inc.,
   59 Temple Place, Suite 330,
   Boston, MA  02111-1307
   USA

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under terms
of your choice, provided that you also meet, for each linked independent
module, the terms and conditions of the license of that module.  An
independent module is a module which is not derived from or based on
this library.  If you modify this library, you may extend this exception
to your version of the library, but you are not obligated to do so.  If
you do not wish to do so, delete this exception statement from your
version.  */


package gnu.classpath.debug;

import java.util.logging.Filter;
import java.util.logging.LogRecord;

public final class PreciseFilter implements Filter
{

  /**
   * The singleton filter instance.
   */
  public static final PreciseFilter GLOBAL = new PreciseFilter ();

  private long enabled;

  private PreciseFilter ()
  {
    enabled = 0;
  }

  /**
   * Disable logging of a component.
   *
   * @param component The component to disable logging for.
   * @throws NullPointerException If component is null.
   */
  public void disable (final Component component)
  {
    enabled &= ~(component.bitValue ());
  }

  /**
   * Enable logging of a component.
   *
   * @param component The component to enable logging for.
   * @throws NullPointerException If component is null.
   */
  public void enable (final Component component)
  {
    enabled |= component.bitValue ();
  }

  /**
   * Tell if a component is enabled for logging.
   *
   * @param component The component to test.
   * @return True iff the specified component is enabled for logging.
   * @throws NullPointerException If component is null.
   */
  public boolean isEnabled (final Component component)
  {
    return (enabled & component.bitValue ()) != 0;
  }

  public boolean isLoggable (final LogRecord record)
  {
    try
      {
        return isEnabled ((Component) record.getLevel ());
      }
    catch (ClassCastException cce)
      {
        return true;
      }
  }
}

/* SystemLogger.java -- Classpath's system debugging logger.
   Copyright (C) 2005  Free Software Foundation, Inc.

This file is a part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at
your option) any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License along
with GNU Classpath; if not, write to the

   Free Software Foundation, Inc.,
   59 Temple Place, Suite 330,
   Boston, MA  02111-1307
   USA

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under terms
of your choice, provided that you also meet, for each linked independent
module, the terms and conditions of the license of that module.  An
independent module is a module which is not derived from or based on
this library.  If you modify this library, you may extend this exception
to your version of the library, but you are not obligated to do so.  If
you do not wish to do so, delete this exception statement from your
version.  */


package gnu.classpath.debug;

import gnu.java.security.action.GetPropertyAction;
import java.security.AccessController;
import java.util.StringTokenizer;
import java.util.logging.Logger;

public final class SystemLogger
{
  public static final Logger SYSTEM = Logger.getLogger ("gnu.classpath");

  static
  {
    SYSTEM.setFilter (PreciseFilter.GLOBAL);

    String defaults = (String) AccessController.doPrivileged
      (new GetPropertyAction ("gnu.classpath.debug.components"));

    if (defaults != null)
      {
        StringTokenizer tok = new StringTokenizer (defaults, ",");
        while (tok.hasMoreTokens ())
          {
            Component c = Component.forName (tok.nextToken ());
            if (c != null)
              PreciseFilter.GLOBAL.enable (c);
          }
      }
  }
}