ceki 2004/11/22 12:21:02
Modified: src/java/org/apache/log4j/rolling RollingFileAppender.java
RollingPolicy.java TriggeringPolicy.java
src/java/org/apache/log4j/config ConfiguratorBase.java
src/java/org/apache/log4j/joran/util XMLUtil.java
src/java/org/apache/log4j/varia ListModelAppender.java
ListAppender.java
src/java/org/apache/log4j/spi LoggingEvent.java
src/java/org/apache/log4j AsyncAppender.java
FileAppender.java PatternLayout.java
src/java/org/apache/log4j/helpers MessageFormatter.java
tests/src/java/org/apache/log4j/rolling
TimeBasedRollingTest.java
src/java/org/apache/joran ExecutionContext.java
src/java/org/apache/log4j/xml Log4jEntityResolver.java
DOMConfigurator.java
src/java/org/apache/log4j/pattern PatternConverter.java
src/java/org/apache/log4j/net SimpleSocketServer.java
src/java/org/apache/log4j/joran/action
ConfigurationAction.java
Log:
Javadoc fixes
Revision Changes Path
1.19 +16 -6
logging-log4j/src/java/org/apache/log4j/rolling/RollingFileAppender.java
Index: RollingFileAppender.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/rolling/RollingFileAppender.java,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- RollingFileAppender.java 20 Nov 2004 15:51:33 -0000 1.18
+++ RollingFileAppender.java 22 Nov 2004 20:20:58 -0000 1.19
@@ -26,9 +26,16 @@
/**
- * RollingFileAppender extends FileAppender to backup the log files
- * depending on rotation policy.
- *
+ * RollingFileAppender extends [EMAIL PROTECTED] FileAppender} to backup the
log files
+ * depending on [EMAIL PROTECTED] RollingPolicy} and [EMAIL PROTECTED]
TriggeringPolicy}.
+ * <p>
+ * To be of any use, a <code>RollingFileAppender</code> instance must have
both
+ * a <code>RollingPolicy</code> and a <code>TriggeringPolicy</code> set up.
+ * However, if its <code>RollingPolicy</code> also implements the
+ * <code>TriggeringPolicy</code> interface, then only the former needs to be
+ * set up. For example, [EMAIL PROTECTED] TimeBasedRollingPolicy} acts both
as a
+ * <code>RollingPolicy</code> and a <code>TriggeringPolicy</code>.
+ *
* @author Heinz Richter
* @author Ceki Gülcü
* @since 1.3
@@ -55,9 +62,6 @@
}
if (rollingPolicy != null) {
- // Sub components must be activated separately
- //rollingPolicy.activateOptions();
-
String afn = rollingPolicy.getActiveLogFileName();
activeFile = new File(afn);
logger.debug("Active log file name: "+afn);
@@ -146,6 +150,12 @@
return triggeringPolicy;
}
+ /**
+ * Sets the rolling policy. In case the 'policy' argument also implements
+ * [EMAIL PROTECTED] TriggeringPolicy}, then the triggering policy for
this appender
+ * is automatically set to be the policy argument.
+ * @param policy
+ */
public void setRollingPolicy(RollingPolicy policy) {
rollingPolicy = policy;
if(rollingPolicy instanceof TriggeringPolicy) {
1.8 +5 -7
logging-log4j/src/java/org/apache/log4j/rolling/RollingPolicy.java
Index: RollingPolicy.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/rolling/RollingPolicy.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- RollingPolicy.java 31 May 2004 21:29:15 -0000 1.7
+++ RollingPolicy.java 22 Nov 2004 20:20:58 -0000 1.8
@@ -14,22 +14,20 @@
* limitations under the License.
*/
+package org.apache.log4j.rolling;
+
+
+import org.apache.log4j.spi.OptionHandler;
/**
* A <code>RollingPolicy</code> is responsible for copying a log file after
* the occurence of a rollover triggering event. The RollingPolicy is also
* responsible for providing the log file where logging output will be
- * directed.
+ * directed. This file is referred to as the <em>active log file</em>.
*
* @author Ceki Gülcü
* @since 1.3
* */
-package org.apache.log4j.rolling;
-
-
-import org.apache.log4j.spi.OptionHandler;
-
-
public interface RollingPolicy extends OptionHandler {
/**
1.4 +8 -11
logging-log4j/src/java/org/apache/log4j/rolling/TriggeringPolicy.java
Index: TriggeringPolicy.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/rolling/TriggeringPolicy.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- TriggeringPolicy.java 27 Feb 2004 16:47:33 -0000 1.3
+++ TriggeringPolicy.java 22 Nov 2004 20:20:58 -0000 1.4
@@ -14,18 +14,19 @@
* limitations under the License.
*/
-
-/**
- * A <code>TriggeringPolicy</code> determines the time where rollover
- * should occur.
- *
- * @author Ceki Gülcü
- * */
package org.apache.log4j.rolling;
import java.io.File;
import org.apache.log4j.spi.OptionHandler;
+/**
+ * A <code>TriggeringPolicy</code> controls the conditions under which
rollover
+ * occurs. However, triggering policy might depend on time, file size, an
+ * external condition or a combination thereof.
+ *
+ * @author Ceki Gülcü
+ * @since 1.3
+ * */
public interface TriggeringPolicy extends OptionHandler {
/**
@@ -35,8 +36,4 @@
*
* */
public boolean isTriggeringEvent(File file);
-
- //public boolean isTriggeringEvent();
-
- //public boolean isSizeSensitive();
}
1.5 +2 -2
logging-log4j/src/java/org/apache/log4j/config/ConfiguratorBase.java
Index: ConfiguratorBase.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/config/ConfiguratorBase.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ConfiguratorBase.java 22 Nov 2004 17:07:08 -0000 1.4
+++ ConfiguratorBase.java 22 Nov 2004 20:20:59 -0000 1.5
@@ -96,7 +96,7 @@
xLogger.callAppenders(event);
}
}
- listAppender.clearModel();
+ listAppender.clearList();
listAppender.close();
ll.removeAppender(listAppender);
}
@@ -106,7 +106,7 @@
ConsoleAppender appender = new ConsoleAppender();
appender.setLayout(
- new PatternLayout("TEMPORARY CONSOLE APPPENDER: %d %level [%t] %c -
%m%n"));
+ new PatternLayout("LOG4J-INTERNAL: %d %level [%t] %c - %m%n"));
appender.setName(Constants.TEMP_CONSOLE_APPENDER_NAME);
appender.activateOptions();
ll.addAppender(appender);
1.3 +0 -2
logging-log4j/src/java/org/apache/log4j/joran/util/XMLUtil.java
Index: XMLUtil.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/joran/util/XMLUtil.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- XMLUtil.java 22 Nov 2004 17:49:43 -0000 1.2
+++ XMLUtil.java 22 Nov 2004 20:20:59 -0000 1.3
@@ -22,8 +22,6 @@
*/
package org.apache.log4j.joran.util;
-import org.apache.joran.ExecutionContext;
-
import org.apache.log4j.spi.ErrorItem;
import org.xml.sax.InputSource;
1.2 +1 -1
logging-log4j/src/java/org/apache/log4j/varia/ListModelAppender.java
Index: ListModelAppender.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/varia/ListModelAppender.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ListModelAppender.java 18 Oct 2004 22:16:35 -0000 1.1
+++ ListModelAppender.java 22 Nov 2004 20:20:59 -0000 1.2
@@ -37,7 +37,7 @@
* Returns a reference to the ListModel that contains all the LoggingEvents
* that have been appended to this class.
*
- * @return
+ * @return the list model
*/
public final ListModel getModel() {
return model;
1.7 +8 -8
logging-log4j/src/java/org/apache/log4j/varia/ListAppender.java
Index: ListAppender.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/varia/ListAppender.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ListAppender.java 20 Nov 2004 11:34:00 -0000 1.6
+++ ListAppender.java 22 Nov 2004 20:20:59 -0000 1.7
@@ -37,7 +37,7 @@
*
*/
public final class ListAppender extends AppenderSkeleton {
- private List model = new ArrayList();
+ private List list = new ArrayList();
/**
* Returns a writeable, BUT cloned List of all the LoggingEvents that are
contained
@@ -48,8 +48,8 @@
* @return Modifiable List
*/
public final List getList() {
- synchronized (model) {
- return new ArrayList(model);
+ synchronized (list) {
+ return new ArrayList(list);
}
}
@@ -64,8 +64,8 @@
// Extract location info now. Later it might not be possible.
event.getLocationInformation();
- synchronized (model) {
- model.add(event);
+ synchronized (list) {
+ list.add(event);
}
}
@@ -81,9 +81,9 @@
/**
* Removes all the Events from the model
*/
- public void clearModel() {
- synchronized (model) {
- model.clear();
+ public void clearList() {
+ synchronized (list) {
+ list.clear();
}
}
}
1.68 +1 -1
logging-log4j/src/java/org/apache/log4j/spi/LoggingEvent.java
Index: LoggingEvent.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/spi/LoggingEvent.java,v
retrieving revision 1.67
retrieving revision 1.68
diff -u -r1.67 -r1.68
--- LoggingEvent.java 20 Nov 2004 11:35:41 -0000 1.67
+++ LoggingEvent.java 22 Nov 2004 20:20:59 -0000 1.68
@@ -49,7 +49,7 @@
* aware of that some of the LoggingEvent fields are initialized lazily.
* Therefore, an appender wishing to output data to be later correctly read
* by a receiver, must initialize "lazy" fields prior to writing them out.
- * See the [EMAIL PROTECTED] #prepareForSerialization} method for the exact
list.</p>
+ * See the [EMAIL PROTECTED] #prepareForDeferredProcessing()} method for the
exact list.</p>
*
* <p>Moreover, in the absence of certain fields, receivers must set the
* values of null fields to a default non-null value. For example, in the
1.42 +3 -8
logging-log4j/src/java/org/apache/log4j/AsyncAppender.java
Index: AsyncAppender.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/AsyncAppender.java,v
retrieving revision 1.41
retrieving revision 1.42
diff -u -r1.41 -r1.42
--- AsyncAppender.java 20 Nov 2004 11:33:59 -0000 1.41
+++ AsyncAppender.java 22 Nov 2004 20:21:00 -0000 1.42
@@ -41,15 +41,10 @@
* The AsyncAppender uses a separate thread to serve the events in its
bounded
* buffer.
* </p>
- *
- * <p>
- * Refer to the results in [EMAIL PROTECTED]
org.apache.log4j.performance.Logging} for
- * the impact of using this appender.
- * </p>
- *
- * <p>
+
+ * * <p>
* <b>Important note:</b> The <code>AsyncAppender</code> can only be script
- * configured using the [EMAIL PROTECTED]
org.apache.log4j.xml.DOMConfigurator}.
+ * configured using the [EMAIL PROTECTED]
org.apache.log4j.joran.JoranConfigurator}.
* </p>
*
* @author Ceki Gülcü
1.45 +1 -3 logging-log4j/src/java/org/apache/log4j/FileAppender.java
Index: FileAppender.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/FileAppender.java,v
retrieving revision 1.44
retrieving revision 1.45
diff -u -r1.44 -r1.45
--- FileAppender.java 22 Nov 2004 16:43:39 -0000 1.44
+++ FileAppender.java 22 Nov 2004 20:21:00 -0000 1.45
@@ -268,9 +268,7 @@
}
/**
- Sets the quiet writer being used.
-
- This method is overriden by [EMAIL PROTECTED] RollingFileAppender}.
+ * Sets the quiet writer being used.
*/
protected void setQWForFiles(Writer writer) {
this.qw = new QuietWriter(writer, errorHandler);
1.32 +1 -1
logging-log4j/src/java/org/apache/log4j/PatternLayout.java
Index: PatternLayout.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/PatternLayout.java,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -r1.31 -r1.32
--- PatternLayout.java 17 Sep 2004 10:08:31 -0000 1.31
+++ PatternLayout.java 22 Nov 2004 20:21:00 -0000 1.32
@@ -520,7 +520,7 @@
/**
* Will return false if any of the conversion specifiers in the pattern
- * handle [EMAIL PROTECTED] Exceptions}.
+ * handles [EMAIL PROTECTED] Exception Exceptions}.
*/
public boolean ignoresThrowable() {
return !handlesExceptions;
1.3 +2 -2
logging-log4j/src/java/org/apache/log4j/helpers/MessageFormatter.java
Index: MessageFormatter.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/helpers/MessageFormatter.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- MessageFormatter.java 2 Nov 2004 18:16:33 -0000 1.2
+++ MessageFormatter.java 22 Nov 2004 20:21:00 -0000 1.3
@@ -19,8 +19,8 @@
/**
* Formats messages according to very simple rules.
- * See [EMAIL PROTECTED] #formatt(String, Object)} and
- * [EMAIL PROTECTED] #formatt(String, Object, Object)} for more details.
+ * See [EMAIL PROTECTED] #format(String, Object)} and
+ * [EMAIL PROTECTED] #format(String, Object, Object)} for more details.
*
* @author Ceki Gülcü
*/
1.10 +0 -1
logging-log4j/tests/src/java/org/apache/log4j/rolling/TimeBasedRollingTest.java
Index: TimeBasedRollingTest.java
===================================================================
RCS file:
/home/cvs/logging-log4j/tests/src/java/org/apache/log4j/rolling/TimeBasedRollingTest.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- TimeBasedRollingTest.java 22 Nov 2004 17:07:08 -0000 1.9
+++ TimeBasedRollingTest.java 22 Nov 2004 20:21:01 -0000 1.10
@@ -337,7 +337,6 @@
jc.doConfigure("./input/rolling/time1.xml",
LogManager.getLoggerRepository());
jc.dumpErrors();
-
String datePattern = "yyyy-MM-dd_HH_mm_ss";
SimpleDateFormat sdf = new SimpleDateFormat(datePattern);
1.14 +2 -2
logging-log4j/src/java/org/apache/joran/ExecutionContext.java
Index: ExecutionContext.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/joran/ExecutionContext.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- ExecutionContext.java 19 Nov 2004 15:20:06 -0000 1.13
+++ ExecutionContext.java 22 Nov 2004 20:21:01 -0000 1.14
@@ -33,8 +33,8 @@
/**
*
* The ExecutionContext contains the contextual state of a Joran parsing
- * session. [EMAIL PROTECTED] Action Actions} depend on this context to
exchange and
- * storeinformation.
+ * session. [EMAIL PROTECTED] org.apache.joran.action.Action Actions} depend
on this
+ * context to exchange and store information.
*
* @author Ceki Gülcü
*/
1.9 +1 -1
logging-log4j/src/java/org/apache/log4j/xml/Log4jEntityResolver.java
Index: Log4jEntityResolver.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/xml/Log4jEntityResolver.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- Log4jEntityResolver.java 18 Nov 2004 22:14:38 -0000 1.8
+++ Log4jEntityResolver.java 22 Nov 2004 20:21:01 -0000 1.9
@@ -31,7 +31,7 @@
* file.
*
* @author Paul Austin
- * @authir Ceki Gulcu (adapted for log4j)
+ * @author Ceki Gulcu (adapted for log4j)
* */
public class Log4jEntityResolver implements EntityResolver {
public InputSource resolveEntity(String publicId, String systemId) {
1.67 +1 -1
logging-log4j/src/java/org/apache/log4j/xml/DOMConfigurator.java
Index: DOMConfigurator.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/xml/DOMConfigurator.java,v
retrieving revision 1.66
retrieving revision 1.67
diff -u -r1.66 -r1.67
--- DOMConfigurator.java 26 May 2004 18:19:53 -0000 1.66
+++ DOMConfigurator.java 22 Nov 2004 20:21:01 -0000 1.67
@@ -68,7 +68,7 @@
@author Christopher Taylor
@author Ceki Gülcü
@author Anders Kristensen
- @deprecated Replaced by the much more flexible [EMAIL PROTECTED]
org.apache.log4j.joran.JoranConfigrator}.
+ @deprecated Replaced by the much more flexible [EMAIL PROTECTED]
org.apache.log4j.joran.JoranConfigurator}.
@since 0.8.3 */
public class DOMConfigurator implements Configurator {
static Logger logger =
1.10 +1 -1
logging-log4j/src/java/org/apache/log4j/pattern/PatternConverter.java
Index: PatternConverter.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/pattern/PatternConverter.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- PatternConverter.java 4 Nov 2004 15:44:56 -0000 1.9
+++ PatternConverter.java 22 Nov 2004 20:21:02 -0000 1.10
@@ -167,7 +167,7 @@
* or not.
*
* @param head The first element of the chain
- * @return
+ * @return true if can handle the throwable contained in logging events
*/
public static boolean chainHandlesThrowable(PatternConverter head) {
PatternConverter c = head;
1.10 +2 -2
logging-log4j/src/java/org/apache/log4j/net/SimpleSocketServer.java
Index: SimpleSocketServer.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/net/SimpleSocketServer.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- SimpleSocketServer.java 6 Sep 2004 14:03:48 -0000 1.9
+++ SimpleSocketServer.java 22 Nov 2004 20:21:02 -0000 1.10
@@ -33,12 +33,12 @@
where <em>port</em> is a part number where the server listens and
<em>configFile</em> is a configuration file fed to the [EMAIL PROTECTED]
- PropertyConfigurator} or to [EMAIL PROTECTED] DOMConfigurator} if an XML
file.
+ PropertyConfigurator} or to [EMAIL PROTECTED] JoranConfigurator} if an
XML file.
</pre>
*
* @author Ceki Gülcü
*
- * @since 0.8.4
+ * @since 0.8.4
* */
public class SimpleSocketServer {
final static Logger logger = Logger.getLogger(SimpleSocketServer.class);
1.6 +2 -0
logging-log4j/src/java/org/apache/log4j/joran/action/ConfigurationAction.java
Index: ConfigurationAction.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/joran/action/ConfigurationAction.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ConfigurationAction.java 22 Nov 2004 17:07:09 -0000 1.5
+++ ConfigurationAction.java 22 Nov 2004 20:21:02 -0000 1.6
@@ -41,12 +41,14 @@
} else {
LoggerRepository repository = (LoggerRepository) ec.getObject(0);
ConfiguratorBase.attachTemporaryConsoleAppender(repository);
+ getLogger().debug("Starting internal logs on console.");
attachment = true;
}
}
public void end(ExecutionContext ec, String name) {
if (attachment) {
+ getLogger().debug("Will stop writing internal logs on console.");
LoggerRepository repository = (LoggerRepository) ec.getObject(0);
List errorList = ec.getErrorList();
ConfiguratorBase.detachTemporaryConsoleAppender(repository, errorList);
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
