You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by ni...@apache.org on 2004/02/25 01:01:30 UTC
cvs commit: avalon/logging/site/xdocs/impl/log4j index.xml
niclas 2004/02/24 16:01:30
Added: logging/site/xdocs/impl/log4j index.xml
Log:
Some documentation for the Log4J plugin.
Revision Changes Path
1.1 avalon/logging/site/xdocs/impl/log4j/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
<properties>
<author email="niclas@apache.org">Niclas Hedhman</author>
<title>Avalon Logging</title>
</properties>
<body>
<section name="Avalon Log4J Logging Plugin">
<subsection name="Overview">
<p>
The Log4J plugin for Avalon Logging allows for the usage of
Apache Log4J log system to be driving your Avalon application.
It is a very thin wrapper to Log4J, introducing a single extra
method call (non reflected) for the log output methods.
</p>
<p>
Instead of mixing in the Log4J configuration into the rest
of Avalon configuration files, they remain external and
are instead referenced. Both XML and Properties files are
supported, and by giving an optional <strong>update</strong>
element, the configureAndWatch() method will be used.
</p>
<p>
<strong>NOTE! </strong> "Base Directory"
(property "avalon.logging.basedir") is NOT SUPPORTED, and
all relative filenames inside the Log4J configuration will
relative to <strong>user.dir</strong> (current directory).
</p>
</subsection>
<subsection name="XML Specification">
<table>
<tr><th>Nested Element</th><th>Description</th></tr>
<tr>
<td>src</td>
<td>
The filename or URL of the Log4J configuration file. This
file can either be an XML or a Properties configuration file,
but MUST end with <strong>".xml"</strong> if it is
the former.
</td>
</tr>
<tr>
<td>update</td>
<td>
The Update Interval. For files, unlike URLs, it is
possible for Log4J to check for the file being modified
externally, and if so reload the configuration. If this
element is specified and has a positive value, this
FileWatch feature of Log4J will be used. The time is
specified in milliseconds.
</td>
</tr>
</table>
</subsection>
<subsection name="Example">
<source><![CDATA[
<logging>
<src>conf/log4j.xml</src>
<!-- Check for Update once every minute. -->
<update>60000</src>
</logging>
]]></source>
</subsection>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org