org.apache.commons.logging

Class JBossLogFactory

java.lang.Object

org.apache.commons.logging.LogFactory

org.apache.commons.logging.JBossLogFactory

public class JBossLogFactory
extends LogFactory

An implementation of Apache Commons Logging LogFactory for JBoss Log Manager.

Author:

James R. Perkins

Field Summary

Fields inherited from class org.apache.commons.logging.LogFactory

DIAGNOSTICS_DEST_PROPERTY, factories, FACTORY_DEFAULT, FACTORY_PROPERTIES, FACTORY_PROPERTY, HASHTABLE_IMPLEMENTATION_PROPERTY, nullClassLoaderFactory, PRIORITY_KEY, SERVICE_ID, TCCL_KEY

Constructor Summary

Constructors

Constructor and Description
JBossLogFactory()

Method Summary

Modifier and Type	Method and Description
Object	getAttribute(String name) Return the configuration attribute with the specified name (if any), or null if there is no such attribute.
String[]	getAttributeNames() Return an array containing the names of all currently defined configuration attributes.
Log	getInstance(Class clazz) Convenience method to derive a name from the specified class and call getInstance(String) with it.
Log	getInstance(String name) Construct (if necessary) and return a Log instance, using the factory's current set of configuration attributes.
void	release() Release any internal references to previously created Log instances returned by this factory.
void	removeAttribute(String name) Remove any configuration attribute associated with the specified name.
void	setAttribute(String name, Object value) Set the configuration attribute with the specified name.

Methods inherited from class org.apache.commons.logging.LogFactory

directGetContextClassLoader, getClassLoader, getContextClassLoader, getFactory, getLog, getLog, isDiagnosticsEnabled, logRawDiagnostic, newFactory, newFactory, objectId, release, releaseAll

Methods inherited from class java.lang.Object

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

Constructor Detail

JBossLogFactory

public JBossLogFactory()

Method Detail

getAttribute

public Object getAttribute(String name)

Description copied from class: LogFactory

Return the configuration attribute with the specified name (if any), or null if there is no such attribute.

Specified by:

getAttribute in class LogFactory

Parameters:

name - Name of the attribute to return

getAttributeNames

public String[] getAttributeNames()

Description copied from class: LogFactory

Return an array containing the names of all currently defined configuration attributes. If there are no such attributes, a zero length array is returned.

Specified by:

getAttributeNames in class LogFactory

getInstance

public Log getInstance(Class clazz)
                throws LogConfigurationException

Description copied from class: LogFactory

Convenience method to derive a name from the specified class and call getInstance(String) with it.

Specified by:

getInstance in class LogFactory

Parameters:

clazz - Class for which a suitable Log name will be derived

Throws:

LogConfigurationException - if a suitable Log instance cannot be returned

getInstance

public Log getInstance(String name)
                throws LogConfigurationException

Description copied from class: LogFactory

Construct (if necessary) and return a Log instance, using the factory's current set of configuration attributes.

NOTE - Depending upon the implementation of the LogFactory you are using, the Log instance you are returned may or may not be local to the current application, and may or may not be returned again on a subsequent call with the same name argument.

Specified by:

getInstance in class LogFactory

Parameters:

name - Logical name of the Log instance to be returned (the meaning of this name is only known to the underlying org.apache.commons.logging implementation that is being wrapped)

Throws:

LogConfigurationException - if a suitable Log instance cannot be returned

release

public void release()

Description copied from class: LogFactory

Release any internal references to previously created Log instances returned by this factory. This is useful in environments like servlet containers, which implement application reloading by throwing away a ClassLoader. Dangling references to objects in that class loader would prevent garbage collection.

Specified by:

release in class LogFactory

removeAttribute

public void removeAttribute(String name)

Description copied from class: LogFactory

Remove any configuration attribute associated with the specified name. If there is no such attribute, no action is taken.

Specified by:

removeAttribute in class LogFactory

Parameters:

name - Name of the attribute to remove

setAttribute

public void setAttribute(String name,
                         Object value)

Description copied from class: LogFactory

Set the configuration attribute with the specified name. Calling this with a null value is equivalent to calling removeAttribute(name).

Specified by:

setAttribute in class LogFactory

Parameters:

name - Name of the attribute to set

value - Value of the attribute to set, or null to remove any setting for this attribute