vmassol 01/06/17 06:40:42
Added: cactus/src/framework/share/org/apache/commons/cactus/util/log
BaseLog.java Log.java LogService.java
Log:
added logging using log4j (these classes are a facade to log4j)
Revision Changes Path
1.1
jakarta-commons/cactus/src/framework/share/org/apache/commons/cactus/util/log/BaseLog.java
Index: BaseLog.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Ant", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.commons.cactus.util.log;
import java.util.*;
import org.apache.log4j.Category;
import org.apache.log4j.Appender;
/**
* Wrapper around the Log4j <code>Category</code> class. A category is
* usually the full name of the class in which to log (including the package
* name).
*
* The order of priority is as follows : ERROR > WARNING > DEBUG > INFO
*/
public class BaseLog implements Log
{
/**
* Corresponding Log4j <code>Category</code> instance
*/
protected Category category;
/**
* @param theCategoryName the category's name. Usually, it is the full
* name of the class being logged, including the package name
*/
public BaseLog(String theCategoryName)
{
category = Category.getInstance(theCategoryName);
}
/**
* Log a DEBUG level message.
*
* @param theMessage the message to log
*/
public void debug(String theMessage)
{
category.debug(theMessage);
}
/**
* Log a DEBUG level message along with an exception
*
* @param theMessage the message to log
* @param theThrowable the exception to log
*/
public void debug(String theMessage, Throwable theThrowable)
{
category.debug(theMessage, theThrowable);
}
/**
* Log an ERROR level message.
*
* @param theMessage the message to log
*/
public void error(String theMessage)
{
category.error(theMessage);
}
/**
* Log an ERROR level message along with an exception
*
* @param theMessage the message to log
* @param theThrowable the exception to log
*/
public void error(String theMessage, Throwable theThrowable)
{
category.error(theMessage, theThrowable);
}
/**
* Log an ERROR level exception only
*
* @param theMessage the message to log
* @param theThrowable the exception to log
*/
public void error(Throwable theThrowable)
{
category.error("", theThrowable);
}
/**
* Log an INFO level message.
*
* @param theMessage the message to log
*/
public void info(String theMessage)
{
category.info(theMessage);
}
/**
* Log an INFO level message along with an exception
*
* @param theMessage the message to log
* @param theThrowable the exception to log
*/
public void info(String theMessage, Throwable theThrowable)
{
category.info(theMessage, theThrowable);
}
/**
* Log a WARNING level message.
*
* @param theMessage the message to log
*/
public void warn(String theMessage)
{
category.warn(theMessage);
}
/**
* Log a WARNING level message along with an exception
*
* @param theMessage the message to log
* @param theThrowable the exception to log
*/
public void warn(String theMessage, Throwable theThrowable)
{
category.warn(theMessage, theThrowable);
}
/**
* Used to log a message when entering a method.
*
* @param theMessage the message to log
*/
public void entry(String theMessage)
{
category.debug('>' + theMessage);
}
/**
* Used to log a message when exiting a method.
*
* @param theMessage the message to log
*/
public void exit(String theMessage)
{
category.debug('<' + theMessage);
}
/**
* @return true if the Log4j priority level is debugging
*/
public boolean isDebugEnabled()
{
return category.isDebugEnabled();
}
/**
* Special method that returns the Log4j root <code>Appender</code>. This
* method is useful for unit testing, where you can define a test
* <code>Appender</code> and use it to verify the result of a log.
*
* @param theAppenderName the name of the <code>Appender</code> to return.
* It is the name defined in the log properties file.
* @return the root appender or null if not found
*/
public Appender getRootAppender(String theAppenderName)
{
return category.getRoot().getAppender(theAppenderName);
}
}
1.1
jakarta-commons/cactus/src/framework/share/org/apache/commons/cactus/util/log/Log.java
Index: Log.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Ant", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.commons.cactus.util.log;
import org.apache.log4j.Category;
/**
* Interface for logging implementation classes
*/
public interface Log
{
/**
* Log a DEBUG level message.
*
* @param theMessage the message to log
*/
public void debug(String theMessage);
/**
* Log a DEBUG level message along with an exception
*
* @param theMessage the message to log
* @param theThrowable the exception to log
*/
public void debug(String theMessage, Throwable theThrowable);
/**
* Log an ERROR level message.
*
* @param theMessage the message to log
*/
public void error(String theMessage);
/**
* Log an ERROR level message along with an exception
*
* @param theMessage the message to log
* @param theThrowable the exception to log
*/
public void error(String theMessage, Throwable theThrowable);
/**
* Log an ERROR level exception only
*
* @param theMessage the message to log
* @param theThrowable the exception to log
*/
public void error(Throwable theThrowable);
/**
* Log an INFO level message.
*
* @param theMessage the message to log
*/
public void info(String theMessage);
/**
* Log an INFO level message along with an exception
*
* @param theMessage the message to log
* @param theThrowable the exception to log
*/
public void info(String theMessage, Throwable theThrowable);
/**
* Log a WARNING level message.
*
* @param theMessage the message to log
*/
public void warn(String theMessage);
/**
* Log a WARNING level message along with an exception
*
* @param theMessage the message to log
* @param theThrowable the exception to log
*/
public void warn(String theMessage, Throwable theThrowable);
/**
* Used to log a message when entering a method.
*
* @param theMessage the message to log
*/
public void entry(String theMessage);
/**
* Used to log a message when exiting a method.
*
* @param theMessage the message to log
*/
public void exit(String theMessage);
/**
* @return true if the Log4j priority level is debugging
*/
public boolean isDebugEnabled();
}
1.1
jakarta-commons/cactus/src/framework/share/org/apache/commons/cactus/util/log/LogService.java
Index: LogService.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Ant", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.commons.cactus.util.log;
import java.util.*;
import java.net.*;
import org.apache.log4j.PropertyConfigurator;
/**
* Logging service acting as a wrapper around the Jakarta Log4j logging
* framework.
*/
public class LogService
{
/**
* List of <code>Log</code> instances (i.e. <code>Category</code>
* objects for Log4j) indexed on the category's name.
*/
private Hashtable logCategories = new Hashtable();
/**
* Has initialization been performed yet ?
*/
private boolean isInitialized = false;
/**
* The singleton's unique instance
*/
private static LogService instance;
/**
* Initialization
*/
private LogService()
{
}
/**
* @return the unique singleton instance
*/
public static synchronized LogService getInstance()
{
if (instance == null) {
instance = new LogService();
}
return instance;
}
/**
* Initialize the logging system. Need to be called once before calling
* <code>getLog()</code>.
*
* @param theFileName the file name (Ex: "/log_client.properties")
*/
public void init(String theFileName)
{
URL url = LogService.class.getResource(theFileName);
PropertyConfigurator.configure(url);
isInitialized = true;
}
/**
* @param theCategoryName the category's name. Usually, it is the full
* name of the class being logged, including the package name
* @return the <code>Log</code> instance associated with the specified
* category name
*/
public synchronized Log getLog(String theCategoryName)
{
// Check first if initialization has been performed
if (!isInitialized) {
throw new RuntimeException("Must call init() first");
}
Log log = (Log)logCategories.get(theCategoryName);
if (log == null) {
log = new BaseLog(theCategoryName);
logCategories.put(theCategoryName, log);
}
return log;
}
/**
* @return true if the logging system has already been initialized.
*/
public boolean isInitialized()
{
return isInitialized;
}
}
