File	Doc	Category	Size	Date	Package
LogFactory.java	API Doc	Apache Tomcat 6.0.14	13860	Fri Jul 20 04:20:34 BST 2007	org.apache.juli.logging

LogFactory

• java.lang.Object

Fields Summary
public static final String	FACTORY_PROPERTY The name of the property used to identify the LogFactory implementation class name.
public static final String	FACTORY_DEFAULT The fully qualified class name of the fallback LogFactory implementation class to use, if no other can be found.
public static final String	FACTORY_PROPERTIES The name of the properties file to search for.
public static final String	HASHTABLE_IMPLEMENTATION_PROPERTY Setting this system property value allows the Hashtable used to store classloaders to be substituted by an alternative implementation. Note: LogFactory will print: [ERROR] LogFactory: Load of custom hashtable failed to system error and then continue using a standard Hashtable. Usage: Set this property when Java is invoked and LogFactory will attempt to load a new instance of the given implementation class. For example, running the following ant scriplet: <java classname="${test.runner}" fork="yes" failonerror="${test.failonerror}"> ... <sysproperty key="org.apache.commons.logging.LogFactory.HashtableImpl" value="org.apache.commons.logging.AltHashtable"/> </java> will mean that LogFactory will load an instance of org.apache.commons.logging.AltHashtable. A typical use case is to allow a custom Hashtable implementation using weak references to be substituted. This will allow classloaders to be garbage collected without the need to release them (on 1.3+ JVMs only, of course ;)
private static LogFactory	singleton
Properties	logConfig

Constructors Summary
private LogFactory() Protected constructor that is not available for public use. // ----------------------------------------------------------- Constructors logConfig=new Properties();

Methods Summary
public java.lang.Object	getAttribute(java.lang.String name) Return the configuration attribute with the specified name (if any), or null if there is no such attribute. param name Name of the attribute to return return logConfig.get(name);
public java.lang.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. return (String[])logConfig.keySet().toArray();
public static org.apache.juli.logging.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. 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.LogFactoryImpl). 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 be instantiated. return singleton;
public Log	getInstance(java.lang.String name) 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. param 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) exception LogConfigurationException if a suitable Log instance cannot be returned return DirectJDKLog.getInstance(name);
public Log	getInstance(java.lang.Class clazz) Convenience method to derive a name from the specified class and call getInstance(String) with it. param clazz Class for which a suitable Log name will be derived exception LogConfigurationException if a suitable Log instance cannot be returned return getInstance( clazz.getName());
public static Log	getLog(java.lang.Class clazz) Convenience method to return a named logger, without the application having to care about factories. param clazz Class from which a log name will be derived exception LogConfigurationException if a suitable Log instance cannot be returned return (getFactory().getInstance(clazz));
public static Log	getLog(java.lang.String name) Convenience method to return a named logger, without the application having to care about factories. param 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) exception LogConfigurationException if a suitable Log instance cannot be returned return (getFactory().getInstance(name));
public static java.lang.String	objectId(java.lang.Object o) Returns a string that uniquely identifies the specified object, including its class. The returned string is of form "classname@hashcode", ie is the same as the return value of the Object.toString() method, but works even when the specified object's class has overidden the toString method. param o may be null. return a string of form classname@hashcode, or "null" if param o is null. if (o == null) { return "null"; } else { return o.getClass().getName() + "@" + System.identityHashCode(o); }
public static void	release(java.lang.ClassLoader classLoader) Release any internal references to previously created {@link LogFactory} instances that have been associated with the specified class loader (if any), after calling the instance method release() on each of them. param classLoader ClassLoader for which to release the LogFactory // nothing - we don't use any class loaders
public void	release() Release any internal references to previously created {@link 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. DirectJDKLog.release();
public static void	releaseAll() Release any internal references to previously created {@link 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. singleton.release();
public void	removeAttribute(java.lang.String name) Remove any configuration attribute associated with the specified name. If there is no such attribute, no action is taken. param name Name of the attribute to remove logConfig.remove(name);
public void	setAttribute(java.lang.String name, java.lang.Object value) Set the configuration attribute with the specified name. Calling this with a null value is equivalent to calling removeAttribute(name). param name Name of the attribute to set param value Value of the attribute to set, or null to remove any setting for this attribute logConfig.put(name, value);
void	setLogConfig(java.util.Properties p) this.logConfig=p;