|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.logging.LogFactory
public class LogFactory
This is an adaptation of the Jakarta Commons Logging API for OSGi usage.
The client code that wishes to use this adaptation of Jakarta Commons Logging and have the log output to be directed to the Pax Logging Service backend, which is driven by Log4J, it is necessary to;
import org.apache.commons.logging.LogFactory;
import org.apache.commons.logging.Log;
public class Activator
implements BundleActivator
{
public void start( BundleContext context ) throws Exception
{
LogFactory.getFactory().setBundleContext( context );
}
}
Field Summary | |
---|---|
static java.lang.String |
FACTORY_DEFAULT
The fully qualified class name of the fallback LogFactory
implementation class to use, if no other can be found. |
static java.lang.String |
FACTORY_PROPERTIES
The name of the properties file to search for. |
static java.lang.String |
FACTORY_PROPERTY
ps4j/pax/logging/providers The name of the property used to identify the LogFactory implementation class name. |
Constructor Summary | |
---|---|
LogFactory()
|
Method Summary | |
---|---|
static void |
dispose()
Pax Logging internal method. |
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. |
java.lang.String[] |
getAttributeNames()
Return an array containing the names of all currently defined configuration attributes. |
static LogFactory |
getFactory()
|
Log |
getInstance(java.lang.Class clazz)
Convenience method to derive a name from the specified class and call getInstance(String) with it. |
Log |
getInstance(java.lang.String name)
Construct (if necessary) and return a Log instance, using
the factory's current set of configuration attributes. |
static Log |
getLog(java.lang.Class clazz)
Convenience method to return a named logger, without the application having to care about factories. |
static Log |
getLog(java.lang.String name)
Convenience method to return a named logger, without the application having to care about factories. |
static void |
release()
Release any internal references to previously created Log
instances returned by this factory. |
static void |
release(java.lang.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. |
static void |
releaseAll()
Release any internal references to previously created LogFactory
instances, after calling the instance method release() on
each of them. |
void |
removeAttribute(java.lang.String name)
Remove any configuration attribute associated with the specified name. |
void |
setAttribute(java.lang.String name,
java.lang.Object value)
Set the configuration attribute with the specified name. |
static void |
setBundleContext(org.osgi.framework.BundleContext ctx)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String FACTORY_PROPERTY
public static final java.lang.String FACTORY_DEFAULT
LogFactory
implementation class to use, if no other can be found.
public static final java.lang.String FACTORY_PROPERTIES
Constructor Detail |
---|
public LogFactory()
Method Detail |
---|
public static void setBundleContext(org.osgi.framework.BundleContext ctx)
public static LogFactory getFactory() throws LogConfigurationException
LogConfigurationException
- if the implementation class is not available or cannot be
instantiated.public static Log getLog(java.lang.Class clazz) throws LogConfigurationException
clazz
- Class from which a log name will be derived
LogConfigurationException
- if a suitable Log
instance cannot be returnedpublic static Log getLog(java.lang.String name) throws LogConfigurationException
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)
LogConfigurationException
- if a suitable Log
instance cannot be returnedpublic static void release(java.lang.ClassLoader classLoader)
LogFactory
instances that have been associated with the specified class loader (if
any), after calling the instance method release()
on each
of them.
classLoader
- ClassLoader for which to release the LogFactorypublic static void releaseAll()
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.
public java.lang.Object getAttribute(java.lang.String name)
null
if there is no such attribute.
name
- Name of the attribute to return
public java.lang.String[] getAttributeNames()
public Log getInstance(java.lang.Class clazz) throws LogConfigurationException
getInstance(String)
with it.
clazz
- Class for which a suitable Log name will be derived
LogConfigurationException
- if a suitable Log
instance cannot be returnedpublic Log getInstance(java.lang.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.
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)
LogConfigurationException
- if a suitable Log
instance cannot be returnedpublic static void release()
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.
public void removeAttribute(java.lang.String name)
name
- Name of the attribute to removepublic void setAttribute(java.lang.String name, java.lang.Object value)
null
value is equivalent to calling
removeAttribute(name)
.
name
- Name of the attribute to setvalue
- Value of the attribute to set, or null
to
remove any setting for this attributepublic static void dispose()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |