org.apache.jetspeed.util

Class JetspeedLoggerUtil

java.lang.Object

org.apache.jetspeed.util.JetspeedLoggerUtil

public class JetspeedLoggerUtil
extends Object

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 $

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LOGGER_FACTORY Default logger factory class name
static String	DEFAULT_LOGGER_FACTORY_METHOD Default logger factory method to create a logger object.
static String	LOCATION_AWARE_LOGGER_FQN LocationAwareLogger SLF4J SPI Interface FQN
static String	MESSAGE_FORMATTER_FQN SLF4J MessageFormatter FQN

Method Summary

Methods

Modifier and Type	Method and Description
static JetspeedLogger	getLocalLogger(Class<?> clazz) Returns a JetspeedLogger from the portlet application.
static JetspeedLogger	getLocalLogger(String name) Returns a JetspeedLogger from the portlet application.
static JetspeedLogger	getSharedLogger(Class<?> clazz) Returns a JetspeedLogger from the portal services component.
static JetspeedLogger	getSharedLogger(String name) Returns a JetspeedLogger from the portal services component.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_LOGGER_FACTORY

public static final String DEFAULT_LOGGER_FACTORY

Default logger factory class name

See Also:

Constant Field Values

DEFAULT_LOGGER_FACTORY_METHOD

public static final String DEFAULT_LOGGER_FACTORY_METHOD

Default logger factory method to create a logger object.

See Also:

Constant Field Values

LOCATION_AWARE_LOGGER_FQN

public static final String LOCATION_AWARE_LOGGER_FQN

LocationAwareLogger SLF4J SPI Interface FQN

See Also:

Constant Field Values

MESSAGE_FORMATTER_FQN

public static final String MESSAGE_FORMATTER_FQN

SLF4J MessageFormatter FQN

See Also:

Constant Field Values

Method Detail

getLocalLogger

public static JetspeedLogger getLocalLogger(Class<?> clazz)

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.

Parameters:

clazz -

Returns:

getLocalLogger

public static JetspeedLogger getLocalLogger(String name)

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.

Parameters:

name -

Returns:

getSharedLogger

public static JetspeedLogger getSharedLogger(Class<?> clazz)

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.

Parameters:

clazz -

Returns:

getSharedLogger

public static JetspeedLogger getSharedLogger(String name)

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.

Parameters:

name -

Returns: