org.apache.jetspeed.util.JetspeedLoggerUtil Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jetspeed.util;
import java.io.Serializable;
import java.lang.reflect.Method;
import org.apache.jetspeed.logger.JetspeedLogger;
import org.apache.jetspeed.logger.JetspeedLoggerFactory;
import org.apache.jetspeed.services.JetspeedPortletServices;
import org.apache.jetspeed.services.PortletServices;
/**
* JetspeedLoggerUtil to get access to portlet web application's logger or shared portal logger.
*
* @version $Id: JetspeedLoggerUtil.java 1150058 2011-07-23 07:17:27Z woonsan $
*/
public class JetspeedLoggerUtil
{
/**
* Default logger factory class name
*/
public static final String DEFAULT_LOGGER_FACTORY = "org.slf4j.LoggerFactory";
/**
* Default logger factory method to create a logger object.
*/
public static final String DEFAULT_LOGGER_FACTORY_METHOD = "getLogger";
/**
* LocationAwareLogger SLF4J SPI Interface FQN
*/
public static final String LOCATION_AWARE_LOGGER_FQN = "org.slf4j.spi.LocationAwareLogger";
/**
* SLF4J MessageFormatter FQN
*/
public static final String MESSAGE_FORMATTER_FQN = "org.slf4j.helpers.MessageFormatter";
private static JetspeedLogger noopLogger = new NOOPJetspeedLogger();
private JetspeedLoggerUtil()
{
}
/**
* Returns a JetspeedLogger from the portlet application.
*
* Note: This method tries to retrieve slf4j Logger by using current context classloader
* to get a portlet application specific logger.
*
*
* If no portlet application specific slf4j Logger is available, then it returns null.
*
* @param clazz
* @return
*/
public static JetspeedLogger getLocalLogger(Class clazz)
{
try
{
Class factoryClazz = Thread.currentThread().getContextClassLoader().loadClass(DEFAULT_LOGGER_FACTORY);
Object logger = invokeDeclaredMethod(factoryClazz, DEFAULT_LOGGER_FACTORY_METHOD, new Class [] { Class.class }, new Object [] { clazz });
if (logger != null)
{
Class locationAwareLoggerClazz = Thread.currentThread().getContextClassLoader().loadClass(LOCATION_AWARE_LOGGER_FQN);
Class messageFormatterClazz = Thread.currentThread().getContextClassLoader().loadClass(MESSAGE_FORMATTER_FQN);
return new DelegatingByReflectionJetspeedLogger(logger, locationAwareLoggerClazz.isAssignableFrom(logger.getClass()), locationAwareLoggerClazz, messageFormatterClazz);
}
}
catch (Exception e)
{
getSharedLogger(clazz).warn("Failed to create PA logger: " + e);
}
return null;
}
/**
* Returns a JetspeedLogger from the portlet application.
*
* Note: This method tries to retrieve slf4j Logger by using current context classloader
* to get a portlet application specific logger.
*
*
* If no portlet application specific slf4j Logger is available, then it returns null.
*
* @param name
* @return
*/
public static JetspeedLogger getLocalLogger(String name)
{
try
{
Class factoryClazz = Thread.currentThread().getContextClassLoader().loadClass(DEFAULT_LOGGER_FACTORY);
Object logger = invokeDeclaredMethod(factoryClazz, DEFAULT_LOGGER_FACTORY_METHOD, new Class [] { String.class }, new Object [] { name });
if (logger != null)
{
Class locationAwareLoggerClazz = Thread.currentThread().getContextClassLoader().loadClass(LOCATION_AWARE_LOGGER_FQN);
Class messageFormatterClazz = Thread.currentThread().getContextClassLoader().loadClass(MESSAGE_FORMATTER_FQN);
return new DelegatingByReflectionJetspeedLogger(logger, locationAwareLoggerClazz.isAssignableFrom(logger.getClass()), locationAwareLoggerClazz, messageFormatterClazz);
}
}
catch (Exception e)
{
getSharedLogger(name).warn("Failed to create PA logger: " + e);
}
return null;
}
/**
* Returns a JetspeedLogger from the portal services component.
*
* Note: A component which wants to use the shared JetspeedLogger should invoke this method
* whenever it tries to leave logs. The retrieved logger instance should not be kept for later use.
* Jetspeed container can be reloaded any time and it can make the old logger instances invalid.
*
*
* If Jetspeed container is not available, then it returns a NOOP logger instead.
* which does not do anything.
*
* @param clazz
* @return
*/
public static JetspeedLogger getSharedLogger(Class clazz)
{
PortletServices ps = JetspeedPortletServices.getSingleton();
if (ps != null)
{
JetspeedLoggerFactory jsLoggerFactory = (JetspeedLoggerFactory) ps.getService(JetspeedLoggerFactory.class.getName());
if (jsLoggerFactory != null)
{
return jsLoggerFactory.getLogger(clazz);
}
}
return noopLogger;
}
/**
* Returns a JetspeedLogger from the portal services component.
*
* Note: A component which wants to use the shared JetspeedLogger should invoke this method
* whenever it tries to leave logs. The retrieved logger instance should not be kept for later use.
* Jetspeed container can be reloaded any time and it can make the old logger instances invalid.
*
*
* If Jetspeed container is not available, then it returns a NOOP logger instead.
* which does not do anything.
*
* @param name
* @return
*/
public static JetspeedLogger getSharedLogger(String name)
{
PortletServices ps = JetspeedPortletServices.getSingleton();
if (ps != null)
{
JetspeedLoggerFactory jsLoggerFactory = (JetspeedLoggerFactory) ps.getService(JetspeedLoggerFactory.class.getName());
if (jsLoggerFactory != null)
{
return jsLoggerFactory.getLogger(name);
}
}
return noopLogger;
}
private static Object invokeDeclaredMethod(Class targetClazz, String methodName, Class [] argTypes, Object ... args)
{
try
{
Method method = targetClazz.getDeclaredMethod(methodName, argTypes);
return method.invoke(targetClazz, args);
}
catch (Exception e)
{
throw new RuntimeException("Failed to invoke logging method. " + e);
}
}
private static class DelegatingByReflectionJetspeedLogger implements JetspeedLogger, Serializable
{
private static final long serialVersionUID = 1L;
private final static String FQCN = DelegatingByReflectionJetspeedLogger.class.getName();
/* See org.slf4j.spi.LocationAwareLogger for the following log level constants */
private final static int DEBUG_INT = 10;
private final static int INFO_INT = 20;
private final static int WARN_INT = 30;
private final static int ERROR_INT = 40;
private Class targetClazz;
private Object targetLogger;
private boolean locationAware;
private Method locationAwareLoggerLogMethod;
private int locationAwareLoggerLogMethodArgsCount;
private Class formatterClazz;
private Method arrayFormatMethod;
private Method formattingTupleGetMessageMethod;
public DelegatingByReflectionJetspeedLogger(Object targetLogger, boolean locationAware, Class locationAwareLoggerClazz, Class formatterClazz)
{
this.targetLogger = targetLogger;
this.targetClazz = targetLogger.getClass();
this.locationAware = locationAware;
if (locationAware)
{
for (Method method : locationAwareLoggerClazz.getMethods())
{
if ("log".equals(method.getName()))
{
int argsCount = method.getParameterTypes().length;
if (argsCount == 6 || argsCount == 5) // slf4j-1.6.x when 6, slf4j-1.5.x when 5
{
locationAwareLoggerLogMethod = method;
locationAwareLoggerLogMethodArgsCount = argsCount;
break;
}
}
}
}
this.formatterClazz = formatterClazz;
}
public boolean isDebugEnabled()
{
return ((Boolean) invokeLoggerMethod("isDebugEnabled", null)).booleanValue();
}
public boolean isInfoEnabled()
{
return ((Boolean) invokeLoggerMethod("isInfoEnabled", null)).booleanValue();
}
public boolean isWarnEnabled()
{
return ((Boolean) invokeLoggerMethod("isWarnEnabled", null)).booleanValue();
}
public boolean isErrorEnabled()
{
return ((Boolean) invokeLoggerMethod("isErrorEnabled", null)).booleanValue();
}
public void debug(String msg)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(DEBUG_INT, msg, null, null);
}
else
{
invokeLoggerMethod("debug", new Class [] { String.class }, msg);
}
}
public void debug(String format, Object arg)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(DEBUG_INT, format, new Object [] { arg }, null);
}
else
{
invokeLoggerMethod("debug", new Class [] { String.class, Object.class }, format, arg);
}
}
public void debug(String format, Object arg1, Object arg2)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(DEBUG_INT, format, new Object [] { arg1, arg2 }, null);
}
else
{
invokeLoggerMethod("debug", new Class [] { String.class, Object.class, Object.class }, format, arg1, arg2);
}
}
public void debug(String format, Object[] argArray)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(DEBUG_INT, format, argArray, null);
}
else
{
invokeLoggerMethod("debug", new Class [] { String.class, Object [].class }, format, argArray);
}
}
public void debug(String msg, Throwable t)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(DEBUG_INT, msg, null, t);
}
else
{
invokeLoggerMethod("debug", new Class [] { String.class, Throwable.class }, msg, t);
}
}
public void info(String msg)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(INFO_INT, msg, null, null);
}
else
{
invokeLoggerMethod("info", new Class [] { String.class }, msg);
}
}
public void info(String format, Object arg)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(INFO_INT, format, new Object [] { arg }, null);
}
else
{
invokeLoggerMethod("info", new Class [] { String.class, Object.class }, format, arg);
}
}
public void info(String format, Object arg1, Object arg2)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(INFO_INT, format, new Object [] { arg1, arg2 }, null);
}
else
{
invokeLoggerMethod("info", new Class [] { String.class, Object.class, Object.class }, format, arg1, arg2);
}
}
public void info(String format, Object[] argArray)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(INFO_INT, format, argArray, null);
}
else
{
invokeLoggerMethod("info", new Class [] { String.class, Object [].class }, format, argArray);
}
}
public void info(String msg, Throwable t)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(INFO_INT, msg, null, t);
}
else
{
invokeLoggerMethod("info", new Class [] { String.class, Throwable.class }, msg, t);
}
}
public void warn(String msg)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(WARN_INT, msg, null, null);
}
else
{
invokeLoggerMethod("warn", new Class [] { String.class }, msg);
}
}
public void warn(String format, Object arg)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(WARN_INT, format, new Object [] { arg }, null);
}
else
{
invokeLoggerMethod("warn", new Class [] { String.class, Object.class }, format, arg);
}
}
public void warn(String format, Object arg1, Object arg2)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(WARN_INT, format, new Object [] { arg1, arg2 }, null);
}
else
{
invokeLoggerMethod("warn", new Class [] { String.class, Object.class, Object.class }, format, arg1, arg2);
}
}
public void warn(String format, Object[] argArray)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(WARN_INT, format, argArray, null);
}
else
{
invokeLoggerMethod("warn", new Class [] { String.class, Object [].class }, format, argArray);
}
}
public void warn(String msg, Throwable t)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(WARN_INT, msg, null, t);
}
else
{
invokeLoggerMethod("warn", new Class [] { String.class, Throwable.class }, msg, t);
}
}
public void error(String msg)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(ERROR_INT, msg, null, null);
}
else
{
invokeLoggerMethod("error", new Class [] { String.class }, msg);
}
}
public void error(String format, Object arg)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(ERROR_INT, format, new Object [] { arg }, null);
}
else
{
invokeLoggerMethod("error", new Class [] { String.class, Object.class }, format, arg);
}
}
public void error(String format, Object arg1, Object arg2)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(ERROR_INT, format, new Object [] { arg1, arg2 }, null);
}
else
{
invokeLoggerMethod("error", new Class [] { String.class, Object.class, Object.class }, format, arg1, arg2);
}
}
public void error(String format, Object[] argArray)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(ERROR_INT, format, argArray, null);
}
else
{
invokeLoggerMethod("error", new Class [] { String.class, Object [].class }, format, argArray);
}
}
public void error(String msg, Throwable t)
{
if (locationAware)
{
invokeLocationAwareLoggerMethod(ERROR_INT, msg, null, t);
}
else
{
invokeLoggerMethod("error", new Class [] { String.class, Throwable.class }, msg, t);
}
}
private Object invokeLoggerMethod(String methodName, Class [] argTypes, Object ... args)
{
try
{
Method method = targetClazz.getMethod(methodName, argTypes);
return method.invoke(targetLogger, args);
}
catch (Exception e)
{
throw new RuntimeException("Failed to invoke logger method, " + methodName + ", on " + targetLogger + ". " + e);
}
}
private Object invokeLocationAwareLoggerMethod(int level, String format, Object[] argArray, Throwable t)
{
try
{
String msg = null;
if (argArray == null || argArray.length == 0) {
msg = format;
} else {
msg = arrayFormat(format, argArray);
}
if (locationAwareLoggerLogMethodArgsCount == 6) {
return locationAwareLoggerLogMethod.invoke(targetLogger, null, FQCN, level, msg, null, t);
} else {
return locationAwareLoggerLogMethod.invoke(targetLogger, null, FQCN, level, msg, t);
}
}
catch (Exception e)
{
throw new RuntimeException("Failed to invoke location aware logger's log method on " + targetLogger + ". " + e);
}
}
private String arrayFormat(String format, Object [] objectArray)
{
try
{
if (arrayFormatMethod == null)
{
arrayFormatMethod = formatterClazz.getMethod("arrayFormat", String.class, Object [].class);
}
Object ret = arrayFormatMethod.invoke(formatterClazz, format, objectArray);
if (ret == null) {
return null;
} else if (ret instanceof String) {
return (String) ret;
} else {
if (formattingTupleGetMessageMethod == null) {
formattingTupleGetMessageMethod = ret.getClass().getMethod("getMessage", null);
}
return (String) formattingTupleGetMessageMethod.invoke(ret, null);
}
}
catch (Exception e)
{
throw new RuntimeException("Failed to invoke arrayFormat method on " + formatterClazz + ". " + e);
}
}
};
private static class NOOPJetspeedLogger implements JetspeedLogger, Serializable
{
private static final long serialVersionUID = 1L;
public boolean isDebugEnabled()
{
return false;
}
public boolean isInfoEnabled()
{
return false;
}
public boolean isWarnEnabled()
{
return false;
}
public boolean isErrorEnabled()
{
return false;
}
public void debug(String msg)
{
}
public void debug(String format, Object arg)
{
}
public void debug(String format, Object arg1, Object arg2)
{
}
public void debug(String format, Object[] argArray)
{
}
public void debug(String msg, Throwable t)
{
}
public void info(String msg)
{
}
public void info(String format, Object arg)
{
}
public void info(String format, Object arg1, Object arg2)
{
}
public void info(String format, Object[] argArray)
{
}
public void info(String msg, Throwable t)
{
}
public void warn(String msg)
{
}
public void warn(String format, Object arg)
{
}
public void warn(String format, Object[] argArray)
{
}
public void warn(String format, Object arg1, Object arg2)
{
}
public void warn(String msg, Throwable t)
{
}
public void error(String msg)
{
}
public void error(String format, Object arg)
{
}
public void error(String format, Object arg1, Object arg2)
{
}
public void error(String format, Object[] argArray)
{
}
public void error(String msg, Throwable t)
{
}
};
}