[jbossnative-commits] JBoss Native SVN: r1953 - in trunk/mod_cluster: src and 8 other directories.

Author: jfrederic.clere(a)jboss.com Date: 2008-10-13 08:08:37 -0400 (Mon, 13 Oct 2008) New Revision: 1953 Added: trunk/mod_cluster/build-tomcat.xml trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/impl/MCMPJBURLEncoder.java trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/impl/MCMPTCURLEncoder.java trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/impl/MCMPURLEncoder.java trunk/mod_cluster/src/tomcat/ trunk/mod_cluster/src/tomcat/org/ trunk/mod_cluster/src/tomcat/org/jboss/ trunk/mod_cluster/src/tomcat/org/jboss/logging/ trunk/mod_cluster/src/tomcat/org/jboss/logging/DynamicLogger.java trunk/mod_cluster/src/tomcat/org/jboss/logging/Logger.java trunk/mod_cluster/src/tomcat/org/jboss/logging/LoggerPlugin.java trunk/mod_cluster/src/tomcat/org/jboss/logging/MDC.java trunk/mod_cluster/src/tomcat/org/jboss/logging/MDCProvider.java trunk/mod_cluster/src/tomcat/org/jboss/logging/MDCSupport.java trunk/mod_cluster/src/tomcat/org/jboss/logging/NDC.java trunk/mod_cluster/src/tomcat/org/jboss/logging/NDCProvider.java trunk/mod_cluster/src/tomcat/org/jboss/logging/NDCSupport.java trunk/mod_cluster/src/tomcat/org/jboss/logging/NullLoggerPlugin.java trunk/mod_cluster/src/tomcat/org/jboss/logging/NullMDCProvider.java trunk/mod_cluster/src/tomcat/org/jboss/logging/NullNDCProvider.java trunk/mod_cluster/src/tomcat/org/jboss/logging/jdk/ trunk/mod_cluster/src/tomcat/org/jboss/logging/jdk/JDK14LoggerPlugin.java trunk/mod_cluster/src/tomcat/org/jboss/logging/jdk/JDKMDCProvider.java trunk/mod_cluster/src/tomcat/org/jboss/logging/jdk/JDKNDCProvider.java Modified: trunk/mod_cluster/src/main/java/org/jboss/modcluster/DefaultJBossWebEventHandler.java trunk/mod_cluster/src/main/java/org/jboss/modcluster/Utils.java trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/MCMPUtils.java trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/impl/DefaultMCMPHandler.java Log: Add what is needed to get it run with TC6.0.x Added: trunk/mod_cluster/build-tomcat.xml =================================================================== --- trunk/mod_cluster/build-tomcat.xml (rev 0) +++ trunk/mod_cluster/build-tomcat.xml 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,59 @@ +<?xml version="1.0"?> +<!-- + * Copyright(c) 2008 Red Hat Middleware, LLC, + * and individual contributors as indicated by the @authors tag. + * See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2 of the License, or (at your option) any later version. + * + * This library 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library in the file COPYING.LIB; + * if not, write to the Free Software Foundation, Inc., + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + * + * @author Jean-Frederic Clere + * @version $Revision$ +--> +<project name="tomcat" default="all" basedir="."> + + <!-- See "build.properties.sample" in the top level directory for all --> + <!-- property values you must customize for successful building!!! --> + <property file="${user.home}/build.properties"/> + <property file="build.properties"/> + + <property file="build.properties.default"/> + + <property name="out.dir" value="${basedir}/target/tomcat/"/> + <property name="out.classes" value="${basedir}/target/tomcat/classes"/> + + <property name="compile.source" value="1.5"/> + + <target name="compile"> + + <mkdir dir="${out.classes}"/> + + <!-- Compile --> + <javac srcdir="src/tomcat" destdir="${out.classes}" + debug="on" debuglevel="lines,vars,source" + deprecation="${compile.deprecation}" + source="${compile.source}" + optimize="${compile.optimize}"> + <include name="org/jboss/logging/**" /> + </javac> + </target> + + <target name="all" depends="compile"> + <jar destfile="${out.dir}/jbosslogging.jar"> + <fileset dir="${out.classes}"/> + </jar> + </target> +</project> Modified: trunk/mod_cluster/src/main/java/org/jboss/modcluster/DefaultJBossWebEventHandler.java =================================================================== --- trunk/mod_cluster/src/main/java/org/jboss/modcluster/DefaultJBossWebEventHandler.java 2008-10-13 07:41:25 UTC (rev 1952) +++ trunk/mod_cluster/src/main/java/org/jboss/modcluster/DefaultJBossWebEventHandler.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -230,7 +230,7 @@ log.debug(this.sm.getString("modcluster.context.enable", context.getPath(), context.getParent().getName())); // Send ENABLE-APP if state is started - if (context.isStarted()) + if (Utils.isContextStarted(context)) { MCMPRequest request = MCMPUtils.createEnableAppRequest(context); this.mcmpHandler.sendRequest(request); Modified: trunk/mod_cluster/src/main/java/org/jboss/modcluster/Utils.java =================================================================== --- trunk/mod_cluster/src/main/java/org/jboss/modcluster/Utils.java 2008-10-13 07:41:25 UTC (rev 1952) +++ trunk/mod_cluster/src/main/java/org/jboss/modcluster/Utils.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -19,6 +19,32 @@ private static final StringManager sm = StringManager.getManager(Constants.Package); + public enum TCtype { + JBOSSWEB, TC6, UNKNOWN + } + // public final static TCtype tctype = TCtype.UNKNOWN; + public static TCtype tctype = TCtype.UNKNOWN; + + static + { + + if (tctype == tctype.UNKNOWN) { + try { + Class t = Class.forName("org.apache.catalina.Context"); + java.lang.reflect.Method m = t.getMethod("isStarted", (Class [])null); + if (m != null) { + tctype = tctype.JBOSSWEB; + } else { + tctype = tctype.TC6; + } + } catch (NoSuchMethodException ex) { + tctype = tctype.TC6; + } catch (ClassNotFoundException ex) { + tctype = tctype.TC6; + } + } + } + /** * Find the most likely connector the proxy server should connect to, or * accept connections from. @@ -102,6 +128,32 @@ return result.toString(); } + /** + * Check if the context is started. + * + * @param context + * @return true if the context is started (or if we don't know) false otherwise. + */ + public static boolean isContextStarted(Context context) + { + boolean ret = true; + if (tctype == tctype.JBOSSWEB) + ret = context.isStarted(); + return ret; + } + + /** + * Tell if running under JBossWEB + * @return true running under JBossWEB/AS5.0x. False TC6 or AS4.2.x AS4.3.x + */ + public static boolean isJBossWEB() + { + if (tctype == tctype.JBOSSWEB) + return true; + else + return false; + } + public static void establishJvmRouteAndConnectorAddress(Engine engine, MCMPHandler mcmpHandler) throws IOException { Connector connector = findProxyConnector(engine.getService().findConnectors()); @@ -154,4 +206,4 @@ private Utils() { } -} \ No newline at end of file +} Modified: trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/MCMPUtils.java =================================================================== --- trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/MCMPUtils.java 2008-10-13 07:41:25 UTC (rev 1952) +++ trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/MCMPUtils.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -251,7 +251,7 @@ for (Container element2: children2) { Context ctx = (Context) element2; - if (ctx.isStarted()) + if (Utils.isContextStarted(ctx)) { requests.add(MCMPUtils.createEnableAppRequest(ctx)); } Modified: trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/impl/DefaultMCMPHandler.java =================================================================== --- trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/impl/DefaultMCMPHandler.java 2008-10-13 07:41:25 UTC (rev 1952) +++ trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/impl/DefaultMCMPHandler.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -61,6 +61,7 @@ import org.jboss.modcluster.mcmp.MCMPRequest; import org.jboss.modcluster.mcmp.MCMPServerState; import org.jboss.modcluster.mcmp.MCMPUtils; +import org.jboss.modcluster.Utils; import org.jboss.modcluster.mcmp.ResetRequestSource; import org.jboss.modcluster.mcmp.MCMPServerState.State; @@ -579,18 +580,19 @@ String jvmRoute = request.getJvmRoute(); Map<String, String> parameters = request.getParameters(); - UEncoder encoder = new UEncoder(); - CharChunk body = null; + MCMPURLEncoder body = null; // First, encode the POST body try { - body = encoder.encodeURL("", 0, 0); - body.recycle(); + if (Utils.isJBossWEB()) + body = new MCMPJBURLEncoder(); + else + body = new MCMPTCURLEncoder(); if (jvmRoute != null) { - body = this.encodeParameter(encoder, "JVMRoute", jvmRoute, !parameters.isEmpty()); + body.encodeParameter(this.sm, "JVMRoute", jvmRoute, !parameters.isEmpty()); } Iterator<Map.Entry<String, String>> entries = parameters.entrySet().iterator(); @@ -599,7 +601,7 @@ { Map.Entry<String, String> entry = entries.next(); - body = this.encodeParameter(encoder, entry.getKey(), entry.getValue(), entries.hasNext()); + body.encodeParameter(this.sm, entry.getKey(), entry.getValue(), entries.hasNext()); } } catch (IOException e) Added: trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/impl/MCMPJBURLEncoder.java =================================================================== --- trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/impl/MCMPJBURLEncoder.java (rev 0) +++ trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/impl/MCMPJBURLEncoder.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,79 @@ +/* + * JBoss, Home of Professional Open Source. + * Copyright 2008, Red Hat Middleware LLC, and individual contributors + * as indicated by the @author tags. See the copyright.txt file in the + * distribution for a full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + +package org.jboss.modcluster.mcmp.impl; + +import java.io.IOException; + +import org.apache.tomcat.util.buf.CharChunk; +import org.apache.tomcat.util.buf.UEncoder; +import org.apache.catalina.util.StringManager; + +/** + * Allow to use TC and JBoss url converter. + * + * @author Jean-Frederic Clere + */ +public class MCMPJBURLEncoder implements MCMPURLEncoder +{ + + private CharChunk body = null; + private UEncoder encoder; + + public MCMPJBURLEncoder() throws IOException { + encoder = new UEncoder(); + + body = encoder.encodeURL("", 0, 0); + body.recycle(); + } + /* Add parameter to the buffer */ + public void encodeParameter(StringManager sm, String key, String value, boolean hasNext) throws IOException { + if (value == null) + { + throw new IllegalArgumentException(sm.getString("modcluster.error.nullAttribute", key)); + } + + encoder.encodeURL(key, 0, key.length()).append('='); + + CharChunk body = encoder.encodeURL(value, 0, value.length()); + + if (hasNext) + { + body.append('&'); + } + } + + /* Return the length of the encoded data */ + public int getLength() { + return body.getLength(); + } + + /* Return the length of the encoded data */ + public int getStart() { + return body.getStart(); + } + + /* buffer of the encoded data */ + public char[] getBuffer() { + return body.getBuffer(); + } +} Added: trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/impl/MCMPTCURLEncoder.java =================================================================== --- trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/impl/MCMPTCURLEncoder.java (rev 0) +++ trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/impl/MCMPTCURLEncoder.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,111 @@ +/* + * JBoss, Home of Professional Open Source. + * Copyright 2008, Red Hat Middleware LLC, and individual contributors + * as indicated by the @author tags. See the copyright.txt file in the + * distribution for a full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + +package org.jboss.modcluster.mcmp.impl; + +import java.io.IOException; +import java.io.CharArrayWriter; +import java.io.Writer; +import java.lang.reflect.Method; + + +import org.apache.tomcat.util.buf.UEncoder; +import org.apache.catalina.util.StringManager; + +/** + * Allow to use TC and JBoss url converter. + * + * @author Jean-Frederic Clere + */ +public class MCMPTCURLEncoder implements MCMPURLEncoder +{ + + private CharArrayWriter body = null; + private UEncoder encoder = null; + private char[] buff = null; + + private static Method method = null; + + static { + try { + Class [] classes = new Class[2]; + classes[0] = java.io.Writer.class; + classes[1] = java.lang.String.class; + method = Class.forName("org.apache.tomcat.util.buf.UEncoder").getMethod("urlEncode", classes); + } catch (Exception ex) { + } + } + + MCMPTCURLEncoder() { + encoder = new UEncoder(); + + body = new CharArrayWriter(); + } + /* Add parameter to the buffer */ + public void encodeParameter(StringManager sm, String key, String value, boolean hasNext) throws IOException { + Object [] objects = new Object[2]; + objects[0] = body; + objects[1] = key; + if (value == null) + { + throw new IllegalArgumentException(sm.getString("modcluster.error.nullAttribute", key)); + } + + try { + method.invoke(encoder, objects); + } catch (Exception ex) { + body.write(key); + } + body.write('='); + + objects[1] = value; + try { + method.invoke(encoder, objects); + } catch (Exception ex) { + body.write(value); + } + + if (hasNext) + { + body.write('&'); + } + } + + /* Return the length of the encoded data */ + public int getLength() { + if (buff == null) + buff = body.toCharArray(); + return buff.length; + } + + /* Return the start of the encoded data */ + public int getStart() { + return 0; + } + + /* buffer of the encoded data */ + public char[] getBuffer() { + if (buff == null) + buff = body.toCharArray(); + return buff; + } +} Added: trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/impl/MCMPURLEncoder.java =================================================================== --- trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/impl/MCMPURLEncoder.java (rev 0) +++ trunk/mod_cluster/src/main/java/org/jboss/modcluster/mcmp/impl/MCMPURLEncoder.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,47 @@ +/* + * JBoss, Home of Professional Open Source. + * Copyright 2008, Red Hat Middleware LLC, and individual contributors + * as indicated by the @author tags. See the copyright.txt file in the + * distribution for a full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + +package org.jboss.modcluster.mcmp.impl; + +import java.io.IOException; +import org.apache.catalina.util.StringManager; + +/** + * Allow to use TC and JBoss url converter. + * + * @author Jean-Frederic Clere + */ +public interface MCMPURLEncoder +{ + + /* Add parameter to the buffer */ + void encodeParameter(StringManager sm, String key, String value, boolean hasNext) throws IOException; + + /* Return the length of the encoded data */ + int getLength(); + + /* Return the start of the encoded data */ + int getStart(); + + /* buffer of the encoded data */ + char[] getBuffer(); +} Added: trunk/mod_cluster/src/tomcat/org/jboss/logging/DynamicLogger.java =================================================================== --- trunk/mod_cluster/src/tomcat/org/jboss/logging/DynamicLogger.java (rev 0) +++ trunk/mod_cluster/src/tomcat/org/jboss/logging/DynamicLogger.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,265 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.logging; + +/** + * An extension of the JBoss Logger that adds a log() + * primitive that maps to a dynamically defined log level. + * + * TODO - Make sure serialization works correctly + * + * @author <a href="mailto:dimitris@jboss.org">Dimitris Andreadis</a> + * @version <tt>$Revision: 515 $</tt> + * + * @since 4.0.3 + */ +public class DynamicLogger extends Logger +{ + /** The serialVersionUID */ + private static final long serialVersionUID = -5963699806863917370L; + + /** No logging */ + public static final int LOG_LEVEL_NONE = 0; + + /** Fatal level logging */ + public static final int LOG_LEVEL_FATAL = 1; + + /** Error level logging */ + public static final int LOG_LEVEL_ERROR = 2; + + /** Warn level logging */ + public static final int LOG_LEVEL_WARN = 3; + + /** Info level logging */ + public static final int LOG_LEVEL_INFO = 4; + + /** Debug level logging */ + public static final int LOG_LEVEL_DEBUG = 5; + + /** Trace level logging */ + public static final int LOG_LEVEL_TRACE = 6; + + /** The available log level strings */ + public final static String[] LOG_LEVEL_STRINGS = + { "NONE", "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE" }; + + /** The log level to use for the "log" primitive */ + private int logLevel = LOG_LEVEL_DEBUG; + + /** + * Create a DynamicLogger instance given the logger name. + * + * @param name the logger name + * @return the dynamic logger + */ + public static DynamicLogger getDynamicLogger(String name) + { + return new DynamicLogger(name); + } + + /** + * Create a DynamicLogger instance given the logger name with the given suffix. + * + * <p>This will include a logger seperator between classname and suffix + * + * @param name The logger name + * @param suffix A suffix to append to the classname. + * @return the dynamic logger + */ + public static DynamicLogger getDynamicLogger(String name, String suffix) + { + return new DynamicLogger(name + "." + suffix); + } + + /** + * Create a DynamicLogger instance given the logger class. This simply + * calls create(clazz.getName()). + * + * @param clazz the Class whose name will be used as the logger name + * @return the dynamic logger + */ + public static DynamicLogger getDynamicLogger(Class clazz) + { + return new DynamicLogger(clazz.getName()); + } + + /** + * Create a DynamicLogger instance given the logger class with the given suffix. + * + * <p>This will include a logger seperator between classname and suffix + * + * @param clazz The Class whose name will be used as the logger name. + * @param suffix A suffix to append to the classname. + * @return the dynamic logger + */ + public static DynamicLogger getDynamicLogger(Class clazz, String suffix) + { + return new DynamicLogger(clazz.getName() + "." + suffix); + } + + /** + * Create a new DynamicLogger. + * + * @param name the log name + */ + protected DynamicLogger(final String name) + { + super(name); + } + + /** + * Sets the logLevel for the log() primitive + * + * @param logLevel between LOG_LEVEL_NONE and LOG_LEVEL_TRACE + */ + public void setLogLevel(int logLevel) + { + if (logLevel >= LOG_LEVEL_NONE && logLevel <= LOG_LEVEL_TRACE) + { + this.logLevel = logLevel; + } + } + + /** + * Gets the logLevel of the log() primitive + * + * @return the logLevel of the log() primitive + */ + public int getLogLevel() + { + return logLevel; + } + + /** + * Sets the logLevel of the log() primitive + * + * @param logLevelString the log level in String form + */ + public void setLogLevelAsString(String logLevelString) + { + if (logLevelString != null) + { + logLevelString = logLevelString.toUpperCase().trim(); + + for (int i = 0; i <= LOG_LEVEL_TRACE; i++) + { + if (logLevelString.equals(LOG_LEVEL_STRINGS[i])) + { + // match + this.logLevel = i; + break; + } + } + } + } + + /** + * Gets the logLevel of the log() primitive in String form + * + * @return the logLevel of the log() primitive in String form + */ + public String getLogLevelAsString() + { + return LOG_LEVEL_STRINGS[logLevel]; + } + + /** + * Logs a message using dynamic log level + * + * @param message the message to log + */ + public void log(Object message) + { + switch (logLevel) + { + case LOG_LEVEL_TRACE: + super.trace(message); + break; + + case LOG_LEVEL_DEBUG: + super.debug(message); + break; + + case LOG_LEVEL_INFO: + super.info(message); + break; + + case LOG_LEVEL_WARN: + super.warn(message); + break; + + case LOG_LEVEL_ERROR: + super.error(message); + break; + + case LOG_LEVEL_FATAL: + super.fatal(message); + break; + + case LOG_LEVEL_NONE: + default: + // do nothing + break; + } + } + + /** + * Logs a message and a throwable using dynamic log level + * + * @param message the message to log + * @param t the throwable to log + */ + public void log(Object message, Throwable t) + { + switch (logLevel) + { + case LOG_LEVEL_TRACE: + super.trace(message, t); + break; + + case LOG_LEVEL_DEBUG: + super.debug(message, t); + break; + + case LOG_LEVEL_INFO: + super.info(message, t); + break; + + case LOG_LEVEL_WARN: + super.warn(message, t); + break; + + case LOG_LEVEL_ERROR: + super.error(message, t); + break; + + case LOG_LEVEL_FATAL: + super.fatal(message, t); + break; + + case LOG_LEVEL_NONE: + default: + // do nothing + break; + } + } +} Added: trunk/mod_cluster/src/tomcat/org/jboss/logging/Logger.java =================================================================== --- trunk/mod_cluster/src/tomcat/org/jboss/logging/Logger.java (rev 0) +++ trunk/mod_cluster/src/tomcat/org/jboss/logging/Logger.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,434 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.logging; + +import java.io.IOException; +import java.io.ObjectInputStream; +import java.io.Serializable; + +/** + * Logger wrapper that tries to dynamically load a log4j class to + * determine if log4j is available in the VM. If it is the case, + * a log4j delegate is built and used. In the contrary, a null + * logger is used. This class cannot directly reference log4j + * classes otherwise the JVM will try to load it and make it fail. + * To set + * + * <p>Only exposes the relevent factory and logging methods. + * + * <p>For JBoss the logging should be done as follows: + * <ul> + * <li>FATAL - JBoss is likely to/will crash + * <li>ERROR - A definite problem + * <li>WARN - Likely to be a problem, or it could be JBoss + * detected a problem it can recover from + * <li>INFO - Lifecycle low volume, e.g. "Bound x into jndi", + * things that are of interest to a user + * <li>DEBUG - Lifecycle low volume but necessarily of interest + * to the user, e.g. "Starting listener thread" + * <li>TRACE - High volume detailed logging + * </ul> + * + * @see #isTraceEnabled + * @see #trace(Object) + * @see #trace(Object,Throwable) + * + * @version <tt>$Revision: 515 $</tt> + * @author Scott.Stark(a)jboss.org + * @author <a href="mailto:jason@planet57.com">Jason Dillon</a> + * @author <a href="mailto:sacha.labourey@cogito-info.ch">Sacha Labourey</a> + */ +public class Logger implements Serializable +{ + /** Serialization */ + private static final long serialVersionUID = 4232175575988879434L; + + /** The system property to look for an externalized LoggerPlugin implementation class */ + protected static String PLUGIN_CLASS_PROP = "org.jboss.logging.Logger.pluginClass"; + + /** The default LoggerPlugin implementation is log4j */ + protected static final String DEFAULT_PLUGIN_CLASS_NAME = "org.jboss.logging.jdk.JDK14LoggerPlugin"; + + /** The LoggerPlugin implementation class to use */ + protected static Class pluginClass = null; + + /** The class name of the LoggerPlugin implementation class to use */ + protected static String pluginClassName = null; + + static + { + init(); + } + + /** The logger name. */ + private final String name; + + /** The logger plugin delegate */ + protected transient LoggerPlugin loggerDelegate = null; + + /** The LoggerPlugin implementation class name in use + * + * @return LoggerPlugin implementation class name + */ + public static String getPluginClassName() + { + return Logger.pluginClassName; + } + + /** + * Set the LoggerPlugin implementation class name in use + * + * @param pluginClassName the LoggerPlugin implementation class name + */ + public static void setPluginClassName(String pluginClassName) + { + if (pluginClassName.equals(Logger.pluginClassName) == false) + { + Logger.pluginClassName = pluginClassName; + init(); + } + } + + /** + * Creates new Logger the given logger name. + * + * @param name the logger name. + */ + protected Logger(final String name) + { + this.name = name; + this.loggerDelegate = getDelegatePlugin(name); + } + + /** + * Return the name of this logger. + * + * @return The name of this logger. + */ + public String getName() + { + return name; + } + + /** + * Get the logger plugin delegate + * + * @return the delegate + */ + public LoggerPlugin getLoggerPlugin() + { + return this.loggerDelegate; + } + + /** + * Check to see if the TRACE level is enabled for this logger. + * + * @return true if a {@link #trace(Object)} method invocation would pass + * the msg to the configured appenders, false otherwise. + */ + public boolean isTraceEnabled() + { + return loggerDelegate.isTraceEnabled(); + } + + /** + * Issue a log msg with a level of TRACE. + * + * @param message the message + */ + public void trace(Object message) + { + loggerDelegate.trace(message); + } + + /** + * Issue a log msg and throwable with a level of TRACE. + * + * @param message the message + * @param t the throwable + */ + public void trace(Object message, Throwable t) + { + loggerDelegate.trace(message, t); + } + + /** + * Check to see if the DEBUG level is enabled for this logger. + * + * @deprecated DEBUG is for low volume logging, you don't need this + * @return true if a {@link #trace(Object)} method invocation would pass + * the msg to the configured appenders, false otherwise. + */ + public boolean isDebugEnabled() + { + return loggerDelegate.isDebugEnabled(); + } + + /** + * Issue a log msg with a level of DEBUG. + * + * @param message the message + */ + public void debug(Object message) + { + loggerDelegate.debug(message); + } + + /** + * Issue a log msg and throwable with a level of DEBUG. + * + * @param message the message + * @param t the throwable + */ + public void debug(Object message, Throwable t) + { + loggerDelegate.debug(message, t); + } + + /** + * Check to see if the INFO level is enabled for this logger. + * + * @deprecated INFO is for low volume information, you don't need this + * @return true if a {@link #info(Object)} method invocation would pass + * the msg to the configured appenders, false otherwise. + */ + public boolean isInfoEnabled() + { + return loggerDelegate.isInfoEnabled(); + } + + /** + * Issue a log msg with a level of INFO. + * + * @param message the message + */ + public void info(Object message) + { + loggerDelegate.info(message); + } + + /** + * Issue a log msg and throwable with a level of INFO. + * + * @param message the message + * @param t the throwable + */ + public void info(Object message, Throwable t) + { + loggerDelegate.info(message, t); + } + + /** + * Issue a log msg with a level of WARN. + * + * @param message the message + */ + public void warn(Object message) + { + loggerDelegate.warn(message); + } + + /** + * Issue a log msg and throwable with a level of WARN. + * + * @param message the message + * @param t the throwable + */ + public void warn(Object message, Throwable t) + { + loggerDelegate.warn(message, t); + } + + /** + * Issue a log msg with a level of ERROR. + * + * @param message the message + */ + public void error(Object message) + { + loggerDelegate.error(message); + } + + /** + * Issue a log msg and throwable with a level of ERROR. + * + * @param message the message + * @param t the throwable + */ + public void error(Object message, Throwable t) + { + loggerDelegate.error(message, t); + } + + /** + * Issue a log msg with a level of FATAL. + * + * @param message the message + */ + public void fatal(Object message) + { + loggerDelegate.fatal(message); + } + + /** + * Issue a log msg and throwable with a level of FATAL. + * + * @param message the message + * @param t the throwable + */ + public void fatal(Object message, Throwable t) + { + loggerDelegate.fatal(message, t); + } + + /** + * Custom serialization to reinitalize the delegate + * + * @param stream the object stream + * @throws IOException for any error + * @throws ClassNotFoundException if a class is not found during deserialization + */ + private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException + { + // restore non-transient fields (aka name) + stream.defaultReadObject(); + + // Restore logging + if (pluginClass == null) + { + init(); + } + this.loggerDelegate = getDelegatePlugin(name); + } + + /** + * Create a Logger instance given the logger name. + * + * @param name the logger name + * @return the logger + */ + public static Logger getLogger(String name) + { + return new Logger(name); + } + + /** + * Create a Logger instance given the logger name with the given suffix. + * + * <p>This will include a logger seperator between classname and suffix + * + * @param name the logger name + * @param suffix a suffix to append to the classname. + * @return the logger + */ + public static Logger getLogger(String name, String suffix) + { + return new Logger(name + "." + suffix); + } + + /** + * Create a Logger instance given the logger class. This simply + * calls create(clazz.getName()). + * + * @param clazz the Class whose name will be used as the logger name + * @return the logger + */ + public static Logger getLogger(Class clazz) + { + return new Logger(clazz.getName()); + } + + /** + * Create a Logger instance given the logger class with the given suffix. + * + * <p>This will include a logger seperator between classname and suffix + * + * @param clazz the Class whose name will be used as the logger name. + * @param suffix a suffix to append to the classname. + * @return the logger + */ + public static Logger getLogger(Class clazz, String suffix) + { + return new Logger(clazz.getName() + "." + suffix); + } + + /** + * Get the delegate plugin + * + * @param name the name of the logger + * @return the plugin + */ + protected static LoggerPlugin getDelegatePlugin(String name) + { + LoggerPlugin plugin = null; + try + { + plugin = (LoggerPlugin) pluginClass.newInstance(); + } + catch (Throwable e) + { + plugin = new NullLoggerPlugin(); + } + try + { + plugin.init(name); + } + catch (Throwable e) + { + String extraInfo = e.getMessage(); + System.err.println("Failed to initalize plugin: " + plugin + + (extraInfo != null ? ", cause: " + extraInfo : "")); + plugin = new NullLoggerPlugin(); + } + + return plugin; + } + + /** + * Initialize the LoggerPlugin class to use as the delegate to the + * logging system. This first checks to see if a pluginClassName has + * been specified via the {@link #setPluginClassName(String)} method, + * then the PLUGIN_CLASS_PROP system property and finally the + * LOG4J_PLUGIN_CLASS_NAME default. If the LoggerPlugin implementation + * class cannot be loaded the default NullLoggerPlugin will be used. + */ + protected static void init() + { + try + { + // See if there is a PLUGIN_CLASS_PROP specified + if (pluginClassName == null) + { + pluginClassName = System.getProperty(PLUGIN_CLASS_PROP, DEFAULT_PLUGIN_CLASS_NAME); + } + + // Try to load the plugin via the TCL + ClassLoader cl = Thread.currentThread().getContextClassLoader(); + pluginClass = cl.loadClass(pluginClassName); + } + catch (Throwable e) + { + // The plugin could not be setup, default to a null logger + pluginClass = org.jboss.logging.NullLoggerPlugin.class; + } + } +} Added: trunk/mod_cluster/src/tomcat/org/jboss/logging/LoggerPlugin.java =================================================================== --- trunk/mod_cluster/src/tomcat/org/jboss/logging/LoggerPlugin.java (rev 0) +++ trunk/mod_cluster/src/tomcat/org/jboss/logging/LoggerPlugin.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,158 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.logging; + +/** + * Defines a "pluggable" login module. In fact, this is only used to split between + * log4j and /dev/null. Choice is made in org.jboss.logging.Logger + * + * @see org.jboss.logging.Logger + * @see org.jboss.logging.NullLoggerPlugin + * + * @author <a href="mailto:sacha.labourey@cogito-info.ch">Sacha Labourey</a>. + * @version $Revision: 515 $ + */ +public interface LoggerPlugin +{ + /** + * Initialise the logger with the given name + * + * @param name the name + */ + void init(String name); + + /** + * Check to see if the TRACE level is enabled for this logger. + * + * @return true if a {@link #trace(Object)} method invocation would pass + * the msg to the configured appenders, false otherwise. + */ + boolean isTraceEnabled(); + + /** + * Issue a log msg with a level of TRACE. + * + * @param message the message + */ + void trace(Object message); + + /** + * Issue a log msg and throwable with a level of TRACE. + * + * @param message the message + * @param t the throwable + */ + void trace(Object message, Throwable t); + + /** + * Check to see if the DEBUG level is enabled for this logger. + * + * @deprecated DEBUG is for low volume logging, you don't need this + * @return true if a {@link #trace(Object)} method invocation would pass + * the msg to the configured appenders, false otherwise. + */ + boolean isDebugEnabled(); + + /** + * Issue a log msg with a level of DEBUG. + * + * @param message the message + */ + void debug(Object message); + + /** + * Issue a log msg and throwable with a level of DEBUG. + * + * @param message the message + * @param t the throwable + */ + void debug(Object message, Throwable t); + + /** + * Check to see if the INFO level is enabled for this logger. + * + * @deprecated INFO is for low volume information, you don't need this + * @return true if a {@link #info(Object)} method invocation would pass + * the msg to the configured appenders, false otherwise. + */ + boolean isInfoEnabled(); + + /** + * Issue a log msg with a level of INFO. + * + * @param message the message + */ + void info(Object message); + + /** + * Issue a log msg and throwable with a level of INFO. + * + * @param message the message + * @param t the throwable + */ + void info(Object message, Throwable t); + + /** + * Issue a log msg with a level of WARN. + * + * @param message the message + */ + void warn(Object message); + + /** + * Issue a log msg and throwable with a level of WARN. + * + * @param message the message + * @param t the throwable + */ + void warn(Object message, Throwable t); + + /** + * Issue a log msg with a level of ERROR. + * + * @param message the message + */ + void error(Object message); + + /** + * Issue a log msg and throwable with a level of ERROR. + * + * @param message the message + * @param t the throwable + */ + void error(Object message, Throwable t); + + /** + * Issue a log msg with a level of FATAL. + * + * @param message the message + */ + void fatal(Object message); + + /** + * Issue a log msg and throwable with a level of FATAL. + * + * @param message the message + * @param t the throwable + */ + void fatal(Object message, Throwable t); +} Added: trunk/mod_cluster/src/tomcat/org/jboss/logging/MDC.java =================================================================== --- trunk/mod_cluster/src/tomcat/org/jboss/logging/MDC.java (rev 0) +++ trunk/mod_cluster/src/tomcat/org/jboss/logging/MDC.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,76 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.logging; + +import java.util.Map; + +/** + * A "Map Diagnostic Context" abstraction. + * + * @author Jason T. Greene + */ +public class MDC +{ + private final static MDCProvider mdc; + + static + { + MDCProvider m = null; + if (NDCSupport.class.isAssignableFrom(Logger.pluginClass)) + { + + try + { + m = ((MDCSupport) Logger.pluginClass.newInstance()).getMDCProvider(); + } + catch (Throwable t) + { + // Eat + } + } + + if (m == null) + m = new NullMDCProvider(); + + mdc = m; + } + + public static void put(String key, Object val) + { + mdc.put(key, val); + } + + public static Object get(String key) + { + return mdc.get(key); + } + + public static void remove(String key) + { + mdc.remove(key); + } + + public static Map<String, Object> getMap() + { + return mdc.getMap(); + } +} Added: trunk/mod_cluster/src/tomcat/org/jboss/logging/MDCProvider.java =================================================================== --- trunk/mod_cluster/src/tomcat/org/jboss/logging/MDCProvider.java (rev 0) +++ trunk/mod_cluster/src/tomcat/org/jboss/logging/MDCProvider.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,40 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.logging; + +import java.util.Map; + +/** + * MDC SPI for the backend logging implementation. + * + * @author Jason T. Greene + */ +public interface MDCProvider +{ + public void put(String key, Object value); + + public Object get(String key); + + public void remove(String key); + + public Map<String, Object> getMap(); +} Added: trunk/mod_cluster/src/tomcat/org/jboss/logging/MDCSupport.java =================================================================== --- trunk/mod_cluster/src/tomcat/org/jboss/logging/MDCSupport.java (rev 0) +++ trunk/mod_cluster/src/tomcat/org/jboss/logging/MDCSupport.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,32 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.logging; + +/** + * Indicates that a Logger plugin supports MDC. + * + * @author Jason T. Greene + */ +public interface MDCSupport +{ + public MDCProvider getMDCProvider(); +} Added: trunk/mod_cluster/src/tomcat/org/jboss/logging/NDC.java =================================================================== --- trunk/mod_cluster/src/tomcat/org/jboss/logging/NDC.java (rev 0) +++ trunk/mod_cluster/src/tomcat/org/jboss/logging/NDC.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,90 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.logging; + + +/** + * A "Nested Diagnostic Context" abstraction. + * + * @author Jason T. Greene + */ +public class NDC +{ + private final static NDCProvider ndc; + + static + { + NDCProvider n = null; + if (NDCSupport.class.isAssignableFrom(Logger.pluginClass)) + { + + try + { + n = ((NDCSupport) Logger.pluginClass.newInstance()).getNDCProvider(); + } + catch (Throwable t) + { + // Eat + } + } + + if (n == null) + n = new NullNDCProvider(); + + ndc = n; + } + + public static void clear() + { + ndc.clear(); + } + + public static String get() + { + return ndc.get(); + } + + public static int getDepth() + { + return ndc.getDepth(); + } + + public static String pop() + { + return ndc.pop(); + } + + public static String peek() + { + return ndc.peek(); + } + + public static void push(String message) + { + ndc.push(message); + } + + public static void setMaxDepth(int maxDepth) + { + ndc.setMaxDepth(maxDepth); + } +} Added: trunk/mod_cluster/src/tomcat/org/jboss/logging/NDCProvider.java =================================================================== --- trunk/mod_cluster/src/tomcat/org/jboss/logging/NDCProvider.java (rev 0) +++ trunk/mod_cluster/src/tomcat/org/jboss/logging/NDCProvider.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,45 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.logging; + + +/** + * An NDC SPI for the backend logging implementation. + * + * @author Jason T. Greene + */ +public interface NDCProvider +{ + public void clear(); + + public String get(); + + public int getDepth(); + + public String pop(); + + public String peek(); + + public void push(String message); + + public void setMaxDepth(int maxDepth); +} \ No newline at end of file Added: trunk/mod_cluster/src/tomcat/org/jboss/logging/NDCSupport.java =================================================================== --- trunk/mod_cluster/src/tomcat/org/jboss/logging/NDCSupport.java (rev 0) +++ trunk/mod_cluster/src/tomcat/org/jboss/logging/NDCSupport.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,32 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.logging; + +/** + * Indicates that a logger plugin supports NDC. + * + * @author Jason T. Greene + */ +public interface NDCSupport +{ + public NDCProvider getNDCProvider(); +} Added: trunk/mod_cluster/src/tomcat/org/jboss/logging/NullLoggerPlugin.java =================================================================== --- trunk/mod_cluster/src/tomcat/org/jboss/logging/NullLoggerPlugin.java (rev 0) +++ trunk/mod_cluster/src/tomcat/org/jboss/logging/NullLoggerPlugin.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,115 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.logging; + +/** + * LoggerPlugin implementation producing no output at all. Used for client + * side logging when no log4j.jar is available on the classpath. + * + * @see org.jboss.logging.Logger + * @see org.jboss.logging.LoggerPlugin + * + * @author <a href="mailto:sacha.labourey@cogito-info.ch">Sacha Labourey</a>. + * @version $Revision: 515 $ + */ +public class NullLoggerPlugin implements LoggerPlugin +{ + public void init(String name) + { + /* don't care */ + } + + public boolean isTraceEnabled() + { + return false; + } + + public void trace(Object message) + { + // nothing + } + + public void trace(Object message, Throwable t) + { + // nothing + } + + public boolean isDebugEnabled() + { + return false; + } + + public void debug(Object message) + { + // nothing + } + + public void debug(Object message, Throwable t) + { + // nothing + } + + public boolean isInfoEnabled() + { + return false; + } + + public void info(Object message) + { + // nothing + } + + public void info(Object message, Throwable t) + { + // nothing + } + + public void error(Object message) + { + // nothing + } + + public void error(Object message, Throwable t) + { + // nothing + } + + public void fatal(Object message) + { + // nothing + } + + public void fatal(Object message, Throwable t) + { + // nothing + } + + public void warn(Object message) + { + // nothing + } + + public void warn(Object message, Throwable t) + { + // nothing + } +} Added: trunk/mod_cluster/src/tomcat/org/jboss/logging/NullMDCProvider.java =================================================================== --- trunk/mod_cluster/src/tomcat/org/jboss/logging/NullMDCProvider.java (rev 0) +++ trunk/mod_cluster/src/tomcat/org/jboss/logging/NullMDCProvider.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,50 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.logging; + +import java.util.Map; + +/** + * An MDC provider which does nothing. + * + * @author Jason T. Greene + */ +public class NullMDCProvider implements MDCProvider +{ + public Object get(String key) + { + return null; + } + + public Map<String, Object> getMap() + { + return null; + } + + public void put(String key, Object val) + { + } + + public void remove(String key) + { + } +} \ No newline at end of file Added: trunk/mod_cluster/src/tomcat/org/jboss/logging/NullNDCProvider.java =================================================================== --- trunk/mod_cluster/src/tomcat/org/jboss/logging/NullNDCProvider.java (rev 0) +++ trunk/mod_cluster/src/tomcat/org/jboss/logging/NullNDCProvider.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,77 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.logging; + +import java.util.Stack; + +/** + * An NDC provider which does nothing. + * + * @author Jason T. Greene + */ +public class NullNDCProvider implements NDCProvider +{ + public void clear() + { + } + + public Stack cloneStack() + { + return null; + } + + public String get() + { + return null; + } + + public int getDepth() + { + return 0; + } + + public void inherit(Stack stack) + { + } + + public String peek() + { + return null; + } + + public String pop() + { + return null; + } + + public void push(String message) + { + } + + public void remove() + { + } + + public void setMaxDepth(int maxDepth) + { + } +} Added: trunk/mod_cluster/src/tomcat/org/jboss/logging/jdk/JDK14LoggerPlugin.java =================================================================== --- trunk/mod_cluster/src/tomcat/org/jboss/logging/jdk/JDK14LoggerPlugin.java (rev 0) +++ trunk/mod_cluster/src/tomcat/org/jboss/logging/jdk/JDK14LoggerPlugin.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,154 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + +package org.jboss.logging.jdk; + +import java.util.logging.Logger; +import java.util.logging.Level; + +import org.jboss.logging.LoggerPlugin; +import org.jboss.logging.MDCProvider; +import org.jboss.logging.MDCSupport; +import org.jboss.logging.NDCProvider; +import org.jboss.logging.NDCSupport; + +/** An example LoggerPlugin which uses the JDK java.util.logging framework. + * + * @author Scott.Stark(a)jboss.org + * @version $Revison:$ + */ +public class JDK14LoggerPlugin implements LoggerPlugin, MDCSupport, NDCSupport +{ + private Logger log; + + public void init(String name) + { + log = Logger.getLogger(name); + } + + public boolean isTraceEnabled() + { + return log.isLoggable(Level.FINER); + } + + public void trace(Object message) + { + log(Level.FINER, String.valueOf(message), null); + } + + public void trace(Object message, Throwable t) + { + log(Level.FINER, String.valueOf(message), t); + } + + public boolean isDebugEnabled() + { + return log.isLoggable(Level.FINE); + } + + public void debug(Object message) + { + log(Level.FINE, String.valueOf(message), null); + } + + public void debug(Object message, Throwable t) + { + log(Level.FINE, String.valueOf(message), t); + } + + public boolean isInfoEnabled() + { + return log.isLoggable(Level.INFO); + } + + public void info(Object message) + { + log(Level.INFO, String.valueOf(message), null); + } + + public void info(Object message, Throwable t) + { + log(Level.INFO, String.valueOf(message), t); + } + + public void warn(Object message) + { + log(Level.WARNING, String.valueOf(message), null); + } + + public void warn(Object message, Throwable t) + { + log(Level.WARNING, String.valueOf(message), t); + } + + public void error(Object message) + { + log(Level.SEVERE, String.valueOf(message), null); + } + + public void error(Object message, Throwable t) + { + log(Level.SEVERE, String.valueOf(message), t); + } + + public void fatal(Object message) + { + log(Level.SEVERE, String.valueOf(message), null); + } + + public void fatal(Object message, Throwable t) + { + log(Level.SEVERE, String.valueOf(message), t); + } + + // From commons-logging + private void log(Level level, String msg, Throwable ex) { + if (log.isLoggable(level)) { + // Get the stack trace. + Throwable dummyException = new Throwable(); + StackTraceElement locations[] = dummyException.getStackTrace(); + // Caller will be the third element + String cname = "unknown"; + String method = "unknown"; + if (locations != null && locations.length > 3) { + StackTraceElement caller = locations[3]; + cname = caller.getClassName(); + method = caller.getMethodName(); + } + if (ex == null) { + log.logp(level, cname, method, msg); + } else { + log.logp(level, cname, method, msg, ex); + } + } + } + + public NDCProvider getNDCProvider() + { + return new JDKNDCProvider(); + } + + public MDCProvider getMDCProvider() + { + return new JDKMDCProvider(); + } +} Added: trunk/mod_cluster/src/tomcat/org/jboss/logging/jdk/JDKMDCProvider.java =================================================================== --- trunk/mod_cluster/src/tomcat/org/jboss/logging/jdk/JDKMDCProvider.java (rev 0) +++ trunk/mod_cluster/src/tomcat/org/jboss/logging/jdk/JDKMDCProvider.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,68 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.logging.jdk; + +import java.util.HashMap; +import java.util.Map; + +import org.jboss.logging.MDCProvider; + +/** + * MDC implementation for JDK logging. + * + * @author Jason T. Greene + */ +public class JDKMDCProvider implements MDCProvider +{ + private ThreadLocal<Map<String, Object>> map = new ThreadLocal<Map<String, Object>>(); + + public Object get(String key) + { + return map.get() == null ? null : map.get().get(key); + } + + public Map<String, Object> getMap() + { + return map.get(); + } + + public void put(String key, Object value) + { + Map<String, Object> map = this.map.get(); + if (map == null) + { + map = new HashMap<String, Object>(); + this.map.set(map); + } + + map.put(key, value); + } + + public void remove(String key) + { + Map<String, Object> map = this.map.get(); + if (map == null) + return; + + map.remove(key); + } +} \ No newline at end of file Added: trunk/mod_cluster/src/tomcat/org/jboss/logging/jdk/JDKNDCProvider.java =================================================================== --- trunk/mod_cluster/src/tomcat/org/jboss/logging/jdk/JDKNDCProvider.java (rev 0) +++ trunk/mod_cluster/src/tomcat/org/jboss/logging/jdk/JDKNDCProvider.java 2008-10-13 12:08:37 UTC (rev 1953) @@ -0,0 +1,149 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.logging.jdk; + +import java.util.ArrayList; +import java.util.EmptyStackException; +import java.util.Stack; + +import org.jboss.logging.NDCProvider; + +/** + * NDC implementation for JDK logging + * + * @author Jason T. Greene + */ +public class JDKNDCProvider implements NDCProvider +{ + private class ArrayStack<E> extends ArrayList<E> + { + private static final long serialVersionUID = -8520038422243642840L; + + public E pop() + { + int size = size(); + if (size == 0) + throw new EmptyStackException(); + + return remove(size - 1); + } + + public E peek() + { + int size = size(); + if (size == 0) + throw new EmptyStackException(); + + return get(size - 1); + } + + public void push(E val) + { + add(val); + } + + public void setSize(int newSize) + { + int size = size(); + if (newSize >= size || newSize < 0) + return; + + removeRange(newSize, size); + } + } + + private class Entry + { + private String merged; + private String current; + + public Entry(String current) + { + this.merged = current; + this.current = current; + } + + public Entry(Entry parent, String current) + { + this.merged = parent.merged + ' ' + current; + this.current = current; + } + } + + private ThreadLocal<ArrayStack<Entry>> stack = new ThreadLocal<ArrayStack<Entry>>(); + + public void clear() + { + ArrayStack<Entry> stack = this.stack.get(); + if (stack != null) + stack.clear(); + } + + public String get() + { + ArrayStack<Entry> stack = this.stack.get(); + + return stack == null || stack.isEmpty() ? null : stack.peek().merged; + } + + public int getDepth() + { + ArrayStack<Entry> stack = this.stack.get(); + + return stack == null ? 0 : stack.size(); + } + + public String peek() + { + ArrayStack<Entry> stack = this.stack.get(); + + return stack == null || stack.isEmpty() ? "" : stack.peek().current; + } + + public String pop() + { + ArrayStack<Entry> stack = this.stack.get(); + + return stack == null || stack.isEmpty() ? "" : stack.pop().current; + } + + public void push(String message) + { + ArrayStack<Entry> stack = this.stack.get(); + + if (stack == null) + { + stack = new ArrayStack<Entry>(); + this.stack.set(stack); + } + + stack.push(stack.isEmpty() ? new Entry(message) : new Entry(stack.peek(), message)); + } + + public void setMaxDepth(int maxDepth) + { + ArrayStack<Entry> stack = this.stack.get(); + + if (stack != null) + stack.setSize(maxDepth); + } +}