org.apache.commons.logging.impl

Class Log4jFactory


public final class Log4jFactory
extends LogFactory

Concrete subclass of LogFactory specific to log4j.
Author:
Costin Manolache

Field Summary

private Hashtable
attributes
The configuration attributes for this LogFactory.
private Hashtable
instances

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

FACTORY_DEFAULT, FACTORY_PROPERTIES, FACTORY_PROPERTY, SERVICE_ID, factories

Constructor Summary

Log4jFactory()
Protected constructor that is not available for public use.

Method Summary

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

cacheFactory, getAttribute, getAttributeNames, getCachedFactory, getContextClassLoader, getFactory, getInstance, getInstance, getLog, getLog, getResourceAsStream, newFactory, release, release, releaseAll, removeAttribute, setAttribute

Field Details

attributes

private Hashtable attributes

instances

private Hashtable instances

Constructor Details

Log4jFactory

public Log4jFactory()
Protected constructor that is not available for public use.

Method Details

getAttribute

public Object getAttribute(String name)
Return the configuration attribute with the specified name (if any), or null if there is no such attribute.
Overrides:
getAttribute in interface LogFactory
Parameters:
name - Name of the attribute to return

getAttributeNames

public String[] getAttributeNames()
Return an array containing the names of all currently defined configuration attributes. If there are no such attributes, a zero length array is returned.
Overrides:
getAttributeNames in interface LogFactory

getInstance

public Log getInstance(Class clazz)
            throws LogConfigurationException
Convenience method to derive a name from the specified class and call getInstance(String) with it.
Overrides:
getInstance in interface 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
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.

Overrides:
getInstance in interface LogFactory
Parameters:
name - Logical name of the Log instance to be returned (the meaning of this name is only known to the underlying logging implementation that is being wrapped)
Throws:
LogConfigurationException - if a suitable Log instance cannot be returned

release

public void release()
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.
Overrides:
release in interface LogFactory

removeAttribute

public void removeAttribute(String name)
Remove any configuration attribute associated with the specified name. If there is no such attribute, no action is taken.
Overrides:
removeAttribute in interface LogFactory
Parameters:
name - Name of the attribute to remove

setAttribute

public void setAttribute(String name,
                         Object value)
Set the configuration attribute with the specified name. Calling this with a null value is equivalent to calling removeAttribute(name).
Overrides:
setAttribute in interface 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

Copyright 2002-2004 The Apache Software Foundation.