| java.lang.Object
 org.apache.commons.logging.LogFactory
All known Subclasses: org.apache.commons.logging.impl.SLF4JLogFactory,
| LogFactory | | abstract public class LogFactory (Code) | |
Factory for creating
Log instances, which always delegates to an instance of
SLF4JLogFactory .
author:
Craig R. McClanahan
author:
Costin Manolache
author:
Richard A. Sitze
author:
Ceki Gülcü |
| Constructor Summary | |
| protected | LogFactory()
Protected constructor that is not available for public use. |
| Method Summary | |
| abstract public Object | getAttribute(String name)
Return the configuration attribute with the specified name (if any), or
null if there is no such attribute. | | abstract public String[] | getAttributeNames()
Return an array containing the names of all currently defined configuration
attributes. | | public static LogFactory | getFactory()
Construct (if necessary) and return a LogFactory instance,
using the following ordered lookup procedure to determine the name of the
implementation class to be loaded.
- The
org.apache.commons.logging.LogFactory system
property.
- The JDK 1.3 Service Discovery mechanism
- Use the properties file
commons-logging.properties
file, if found in the class path of this class. | | abstract public Log | getInstance(Class clazz)
Convenience method to derive a name from the specified class and call
getInstance(String) with it. | | abstract public Log | getInstance(String name)
Construct (if necessary) and return a Log instance, using
the factory's current set of configuration attributes. | | public static Log | getLog(Class clazz)
Convenience method to return a named logger, without the application having
to care about factories. | | public static Log | getLog(String name)
Convenience method to return a named logger, without the application having
to care about factories. | | abstract public void | release()
Release any internal references to previously created
Log instances
returned by this factory. | | public static void | release(ClassLoader classLoader)
Release any internal references to previously created
LogFactory instances that have been associated with the specified class loader (if
any), after calling the instance method release() on each of
them. | | public static void | releaseAll()
Release any internal references to previously created
LogFactory instances, after calling the instance method release() on
each of them. | | abstract public void | removeAttribute(String name)
Remove any configuration attribute associated with the specified name. | | abstract public void | setAttribute(String name, Object value)
Set the configuration attribute with the specified name. |
| FACTORY_DEFAULT | | final public static String FACTORY_DEFAULT(Code) | | The fully qualified class name of the fallback LogFactory
implementation class to use, if no other can be found.
This property is not used but preserved here for compatibility.
|
| FACTORY_PROPERTIES | | final public static String FACTORY_PROPERTIES(Code) | | The name of the properties file to search for.
This property is not used but preserved here for compatibility.
|
| FACTORY_PROPERTY | | final public static String FACTORY_PROPERTY(Code) | | The name of the property used to identify the LogFactory implementation
class name.
This property is not used but preserved here for compatibility.
|
| LogFactory | | protected LogFactory()(Code) | | Protected constructor that is not available for public use.
|
| getAttribute | | abstract public Object getAttribute(String name)(Code) | | Return the configuration attribute with the specified name (if any), or
null if there is no such attribute.
Parameters:
name - Name of the attribute to return |
| getAttributeNames | | abstract public String[] getAttributeNames()(Code) | | Return an array containing the names of all currently defined configuration
attributes. If there are no such attributes, a zero length array is
returned.
|
| getFactory | | public static LogFactory getFactory() throws LogConfigurationException(Code) | |
Construct (if necessary) and return a LogFactory instance,
using the following ordered lookup procedure to determine the name of the
implementation class to be loaded.
- The
org.apache.commons.logging.LogFactory system
property.
- The JDK 1.3 Service Discovery mechanism
- Use the properties file
commons-logging.properties
file, if found in the class path of this class. The configuration file is
in standard java.util.Properties format and contains the
fully qualified name of the implementation class with the key being the
system property defined above.
- Fall back to a default implementation class (
org.apache.commons.logging.impl.SLF4FLogFactory).
NOTE- If the properties file method of identifying the
LogFactory implementation class is utilized, all of the
properties defined in this file will be set as configuration attributes on
the corresponding LogFactory instance.
exception:
LogConfigurationException - if the implementation class is not available or cannot beinstantiated. |
| getInstance | | abstract public Log getInstance(Class clazz) throws LogConfigurationException(Code) | | Convenience method to derive a name from the specified class and call
getInstance(String) with it.
Parameters:
clazz - Class for which a suitable Log name will be derived
exception:
LogConfigurationException - if a suitable Log instance cannot be returned |
| getInstance | | abstract public Log getInstance(String name) throws LogConfigurationException(Code) | |
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.
Parameters:
name - Logical name of the Log instance to be returned(the meaning of this name is only known to the underlying loggingimplementation that is being wrapped)
exception:
LogConfigurationException - if a suitable Log instance cannot be returned |
| getLog | | public static Log getLog(Class clazz) throws LogConfigurationException(Code) | | Convenience method to return a named logger, without the application having
to care about factories.
Parameters:
clazz - Class from which a log name will be derived
exception:
LogConfigurationException - if a suitable Log instance cannot be returned |
| getLog | | public static Log getLog(String name) throws LogConfigurationException(Code) | | Convenience method to return a named logger, without the application having
to care about factories.
Parameters:
name - Logical name of the Log instance to be returned(the meaning of this name is only known to the underlying loggingimplementation that is being wrapped)
exception:
LogConfigurationException - if a suitable Log instance cannot be returned |
| release | | abstract public void release()(Code) | | 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.
|
| release | | public static void release(ClassLoader classLoader)(Code) | | Release any internal references to previously created
LogFactory instances that have been associated with the specified class loader (if
any), after calling the instance method release() on each of
them.
Parameters:
classLoader - ClassLoader for which to release the LogFactory |
| releaseAll | | public static void releaseAll()(Code) | | Release any internal references to previously created
LogFactory instances, after calling the instance method release() on
each of them. 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.
|
| removeAttribute | | abstract public void removeAttribute(String name)(Code) | | Remove any configuration attribute associated with the specified name. If
there is no such attribute, no action is taken.
Parameters:
name - Name of the attribute to remove |
| setAttribute | | abstract public void setAttribute(String name, Object value)(Code) | | Set the configuration attribute with the specified name. Calling this with
a null value is equivalent to calling
removeAttribute(name).
Parameters:
name - Name of the attribute to set
Parameters:
value - Value of the attribute to set, or null to removeany setting for this attribute |
|
|