Adding JMCR-Stable version
[Benchmarks_CSolver.git] / JMCR-Stable / real-world application / jigsaw / WWW / Doc / Reference / org.w3c.jigsaw.http.LoggingProp.html
diff --git a/JMCR-Stable/real-world application/jigsaw/WWW/Doc/Reference/org.w3c.jigsaw.http.LoggingProp.html b/JMCR-Stable/real-world application/jigsaw/WWW/Doc/Reference/org.w3c.jigsaw.http.LoggingProp.html
new file mode 100644 (file)
index 0000000..8b56411
--- /dev/null
@@ -0,0 +1,229 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"\r
+                      "http://www.w3.org/TR/REC-html40/loose.dtd">\r
+<html>\r
+<head>\r
+  <link rel="stylesheet" type="text/css" href="../style/doc.css"><style type="text/css">body { margin: 20pt; color: black; background: white; font-family: helvetica;} </style>\r
+  <title>The LoggingProp reference manual</title>\r
+  <link href="jigsaw@w3.org" rel="made">\r
+  <meta http-equiv="Content-Type" content="text/html">\r
+</head>\r
+\r
+<body>\r
+<p><a href="../../.." target="_top_"><img\r
+src="../../../Icons//WWW/w3c_home.gif" alt="W3C" border="0" width="72"\r
+height="48"> </a><a href="../../" target="_top_"> <img\r
+src="../../../Icons//jigsaw" alt="Jigsaw" border="0"></a></p>\r
+<hr noshade size="1">\r
+\r
+<a href="resources.html">All resources</a> <a href="frames.html">All frames\r
+</a>\r
+<hr noshade size="1">\r
+\r
+\r
+<h1>LoggingProp</h1>\r
+\r
+<p>This resource class provides access to <b>Jigsaw</b> logging properties. It\r
+allows you to change the logging properties of <b>Jigsaw</b>.</p>\r
+\r
+<p></p>\r
+<hr noshade size="1">\r
+\r
+\r
+<h2>Inherits</h2>\r
+\r
+<p>The <a\r
+href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/jigsaw/http/LoggingProp.html">LoggingProp</a>\r
+class inerits from the following classes:</p>\r
+<ul>\r
+  <li><a href="org.w3c.tools.resources.Resource.html">Resource</a></li>\r
+  <li><a href="org.w3c.jigsaw.config.PropertySet.html">PropertySet</a></li>\r
+</ul>\r
+\r
+<p></p>\r
+<hr noshade size="1">\r
+\r
+\r
+<h2>Attributes description</h2>\r
+\r
+<p>The LoggingProp defines the following attributes:</p>\r
+<ul>\r
+  <li><a href="#org.w3c.jigsaw.logger">org.w3c.jigsaw.logger</a></li>\r
+  <li><a\r
+    href="#org.w3c.jigsaw.logger.errlogname">org.w3c.jigsaw.logger.errlogname</a></li>\r
+  <li><a\r
+    href="#org.w3c.jigsaw.logger.logname">org.w3c.jigsaw.logger.logname</a></li>\r
+  <li><a\r
+    href="#org.w3c.jigsaw.logger.tracelogname">org.w3c.jigsaw.logger.tracelogname</a></li>\r
+  <li><a\r
+    href="#org.w3c.jigsaw.logger.logdirname">org.w3c.jigsaw.logger.logdirname</a></li>\r
+  <li><a\r
+    href="#org.w3c.jigsaw.logger.rotateLevel">org.w3c.jigsaw.logger.rotateLevel</a></li>\r
+  <li><a\r
+    href="#org.w3c.jigsaw.logger.bufferSize">org.w3c.jigsaw.logger.bufferSize</a></li>\r
+</ul>\r
+\r
+<p></p>\r
+<hr noshade size="1">\r
+\r
+<code><a name="org.w3c.jigsaw.logger">org.w3c.jigsaw.logger</a></code>\r
+<dl>\r
+  <dt><i>semantics</i></dt>\r
+    <dd>This property gives the name of the logger class to use. The logger\r
+      class can be any class that implements the <a\r
+      href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/jigsaw/http/Logger.html">logger\r
+      interface</a>. Right now, the only implemented logger is the <a\r
+      href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/jigsaw/http/CommonLogger.html">CommonLogger</a>.\r
+      If undefined, <b>Jigsaw</b> will not log any requests, and emit a\r
+      warning at startup time.</dd>\r
+  <dt><i>type</i></dt>\r
+    <dd>This attribute is an editable <a\r
+      href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/ClassAttribute.html">ClassAttribute</a></dd>\r
+  <dt><i>default value</i></dt>\r
+    <dd>This attribute defaults to <b>null</b>.</dd>\r
+</dl>\r
+\r
+<p></p>\r
+<hr noshade size="1">\r
+\r
+<code><a\r
+name="org.w3c.jigsaw.logger.errlogname">org.w3c.jigsaw.logger.errlogname</a></code>\r
+<dl>\r
+  <dt><i>semantics</i></dt>\r
+    <dd>This property should give the name of the error log file. The error\r
+      log file is used when some abnormal situation is encoutered inside the\r
+      server. Abnormal, here, means a situation that the server can't cope\r
+      with (i.e., implementation bugs), rather than just HTTP errors (which\r
+      are logged in the above log file). This file is also used by the server\r
+      to trace important configuration actions.</dd>\r
+  <dt><i>type</i></dt>\r
+    <dd>This attribute is an editable <a\r
+      href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/FileAttribute.html">FileAttribute</a></dd>\r
+  <dt><i>default value</i></dt>\r
+    <dd>This attribute defaults to <i>&lt;<a\r
+      href="org.w3c.jigsaw.http.GeneralProp.html#org.w3c.jigsaw.root">w3c.jigsaw.root</a>></i>/logs/errlog</dd>\r
+</dl>\r
+\r
+<p></p>\r
+<hr noshade size="1">\r
+\r
+<code><a\r
+name="org.w3c.jigsaw.logger.logname">org.w3c.jigsaw.logger.logname</a></code>\r
+<dl>\r
+  <dt><i>semantics</i></dt>\r
+    <dd>This property should give the name of the log file to which the\r
+      logging record will be emited. Note that this property is a property of\r
+      the CommonLogger (and any of its subclasses), rather than a property of\r
+      the logging system as a whole.</dd>\r
+  <dt><i>type</i></dt>\r
+    <dd>This attribute is an editable <a\r
+      href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/FileAttribute.html">FileAttribute</a></dd>\r
+  <dt><i>default value</i></dt>\r
+    <dd>This attribute defaults to <i>&lt;<a\r
+      href="org.w3c.jigsaw.http.GeneralProp.html#org.w3c.jigsaw.root">w3c.jigsaw.root</a>></i>/logs/log</dd>\r
+</dl>\r
+\r
+<p></p>\r
+<hr noshade size="1">\r
+\r
+<code><a\r
+name="org.w3c.jigsaw.logger.tracelogname">org.w3c.jigsaw.logger.tracelogname</a></code>\r
+<dl>\r
+  <dt><i>semantics</i></dt>\r
+    <dd>This property should provide the name of the trace log. The trace log\r
+      is used to output debugging information when the server is turned into\r
+      debug mode. To turn the server into debug mode, two properties have to\r
+      be turned to true (depending on what part of the server you want to\r
+      debug):\r
+      <ul>\r
+        <li><i><a\r
+          href="org.w3c.jigsaw.http.GeneralProp.html#org.w3c.jigsaw.trace">org.w3c.jigsaw.trace</a></i>\r
+          Make the core server emit traces.</li>\r
+        <li><i><a\r
+          href="org.w3c.jigsaw.http.ConnectionProp.html#org.w3c.jigsaw.client.debug">org.w3c.jigsaw.client.debug</a></i>\r
+          Make every clients emit traces.</li>\r
+      </ul>\r
+    </dd>\r
+  <dt><i>type</i></dt>\r
+    <dd>This attribute is an editable <a\r
+      href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/FileAttribute.html">FileAttribute</a></dd>\r
+  <dt><i>default value</i></dt>\r
+    <dd>This attribute defaults to <i>&lt;<a\r
+      href="org.w3c.jigsaw.http.GeneralProp.html#org.w3c.jigsaw.root">w3c.jigsaw.root</a>></i>/logs/tracelog.</dd>\r
+</dl>\r
+\r
+<p></p>\r
+<hr noshade size="1">\r
+\r
+\r
+<p><code><a\r
+name="org.w3c.jigsaw.logger.logdirname">org.w3c.jigsaw.logger.logdirname</a></code></p>\r
+<dl>\r
+  <dt><i>semantics</i></dt>\r
+    <dd>This property gives the name of name of the directory where to put the\r
+      log files.</dd>\r
+  <dt><i>type</i></dt>\r
+    <dd>This attribute is an editable <a\r
+      href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/FileAttribute.html">FileAttribute</a></dd>\r
+  <dt><i>default value</i></dt>\r
+    <dd>This attribute defaults to <b>null</b>. Default inferred value is\r
+      vv<code>&lt;instdir>/Jigsaw/logs/</code></dd>\r
+</dl>\r
+\r
+<p></p>\r
+<hr noshade size="1">\r
+\r
+\r
+<p><code><a\r
+name="org.w3c.jigsaw.logger.rotateLevel">org.w3c.jigsaw.rotateLevel</a></code></p>\r
+<dl>\r
+  <dt><i>semantics</i></dt>\r
+    <dd>This property gives the level of log rotation used in the logger. \r
+      <ul>\r
+        <li>0 - log name is defined by\r
+          <code>org.w3c.jigsaw.logger.logname</code>, no rotation done</li>\r
+        <li>1 - log name is as above with _yyyy added, rotation done every\r
+          year on January 1st 00:00.</li>\r
+        <li>2 - log name as 0 with _yyyy_mm added, rotation done every month\r
+          on the 1st at midnight.</li>\r
+        <li>3 - log name as 0 with _yyy_mm_dd added, rotation done every day\r
+          at 00:00.</li>\r
+        <li>If set to 0, the name of the logfile will be the one defined by\r
+        </li>\r
+      </ul>\r
+    </dd>\r
+  <dt><i>type</i></dt>\r
+    <dd>This attribute is an editable <a\r
+      href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/IntegerAttribute.html">IntegerAttribute</a></dd>\r
+  <dt><i>default value</i></dt>\r
+    <dd>This attribute defaults to <b>0</b>.</dd>\r
+</dl>\r
+\r
+<p></p>\r
+<hr noshade size="1">\r
+\r
+<code><a\r
+name="org.w3c.jigsaw.logger.bufferSize">org.w3c.jigsaw.logger.bufferSize</a></code>\r
+<dl>\r
+  <dt><i>semantics</i></dt>\r
+    <dd>The size of the log buffer to use. This property defines the size of\r
+      the buffer used before flushing the output log. It is highly recommended\r
+      to keep this value at least as high as it is. You may still, however,\r
+      set it to 0 in order to prevent any buffering of log writing.</dd>\r
+  <dt><i>type</i></dt>\r
+    <dd>This attribute is an editable <a\r
+      href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/IntegerAttribute.html">IntegerAttribute</a></dd>\r
+  <dt><i>default value</i></dt>\r
+    <dd>This attribute defaults to <b>8192</b>.</dd>\r
+</dl>\r
+\r
+<p></p>\r
+\r
+<p></p>\r
+<hr noshade size="1">\r
+\r
+\r
+<p><i><a href="mailto:jigsaw@w3.org">Jigsaw Team</a><br>\r
+$Id: org.w3c.jigsaw.http.LoggingProp.html,v 1.2 1998/03/27 08:19:56 bmahe Exp\r
+$</i></p>\r
+</body>\r
+</html>\r