/usr/share/doc/liblog4j1.2-java/api/org/apache/log4j/PropertyConfigurator.html is in liblog4j1.2-java-doc 1.2.17-8.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>PropertyConfigurator (Log4j Version 1.2.17)</title>
<meta name="date" content="2017-10-21">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PropertyConfigurator (Log4j Version 1.2.17)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PropertyConfigurator.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Log4j 1.2.17</b><!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You 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. --></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/apache/log4j/Priority.html" title="class in org.apache.log4j"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/apache/log4j/RollingFileAppender.html" title="class in org.apache.log4j"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/log4j/PropertyConfigurator.html" target="_top">Frames</a></li>
<li><a href="PropertyConfigurator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.log4j</div>
<h2 title="Class PropertyConfigurator" class="title">Class PropertyConfigurator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.log4j.PropertyConfigurator</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../org/apache/log4j/spi/Configurator.html" title="interface in org.apache.log4j.spi">Configurator</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">PropertyConfigurator</span>
extends java.lang.Object
implements <a href="../../../org/apache/log4j/spi/Configurator.html" title="interface in org.apache.log4j.spi">Configurator</a></pre>
<div class="block">Allows the configuration of log4j from an external file. See
<b><a href="../../../org/apache/log4j/PropertyConfigurator.html#doConfigure-java.lang.String-org.apache.log4j.spi.LoggerRepository-"><code>doConfigure(String, LoggerRepository)</code></a></b> for the
expected format.
<p>It is sometimes useful to see how log4j is reading configuration
files. You can enable log4j internal logging by defining the
<b>log4j.debug</b> variable.
<P>As of log4j version 0.8.5, at class initialization time class,
the file <b>log4j.properties</b> will be searched from the search
path used to load classes. If the file can be found, then it will
be fed to the <a href="../../../org/apache/log4j/PropertyConfigurator.html#configure-java.net.URL-"><code>configure(java.net.URL)</code></a>
method.
<p>The <code>PropertyConfigurator</code> does not handle the
advanced configuration features supported by the <a href="../../../org/apache/log4j/xml/DOMConfigurator.html" title="class in org.apache.log4j.xml"><code>DOMConfigurator</code></a> such as
support custom <a href="../../../org/apache/log4j/spi/ErrorHandler.html" title="interface in org.apache.log4j.spi"><code>ErrorHandlers</code></a>,
nested appenders such as the <a href="../../../org/apache/log4j/AsyncAppender.html" title="class in org.apache.log4j"><code>AsyncAppender</code></a>, etc.
<p>All option <em>values</em> admit variable substitution. The
syntax of variable substitution is similar to that of Unix
shells. The string between an opening <b>"${"</b> and
closing <b>"}"</b> is interpreted as a key. The value of
the substituted variable can be defined as a system property or in
the configuration file itself. The value of the key is first
searched in the system properties, and if not found there, it is
then searched in the configuration file being parsed. The
corresponding value replaces the ${variableName} sequence. For
example, if <code>java.home</code> system property is set to
<code>/home/xyz</code>, then every occurrence of the sequence
<code>${java.home}</code> will be interpreted as
<code>/home/xyz</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.8.1</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Ceki Gülcü, Anders Kristensen</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/PropertyConfigurator.html#LOGGER_FACTORY_KEY">LOGGER_FACTORY_KEY</a></span></code>
<div class="block">Key for specifying the <a href="../../../org/apache/log4j/spi/LoggerFactory.html" title="interface in org.apache.log4j.spi"><code>LoggerFactory</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../org/apache/log4j/spi/LoggerFactory.html" title="interface in org.apache.log4j.spi">LoggerFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/PropertyConfigurator.html#loggerFactory">loggerFactory</a></span></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Hashtable</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/PropertyConfigurator.html#registry">registry</a></span></code>
<div class="block">Used internally to keep track of configured appenders.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.log4j.spi.Configurator">
<!-- -->
</a>
<h3>Fields inherited from interface org.apache.log4j.spi.<a href="../../../org/apache/log4j/spi/Configurator.html" title="interface in org.apache.log4j.spi">Configurator</a></h3>
<code><a href="../../../org/apache/log4j/spi/Configurator.html#INHERITED">INHERITED</a>, <a href="../../../org/apache/log4j/spi/Configurator.html#NULL">NULL</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/PropertyConfigurator.html#PropertyConfigurator--">PropertyConfigurator</a></span>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/PropertyConfigurator.html#configure-java.io.InputStream-">configure</a></span>(java.io.InputStream inputStream)</code>
<div class="block">Reads configuration options from an InputStream.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/PropertyConfigurator.html#configure-java.util.Properties-">configure</a></span>(java.util.Properties properties)</code>
<div class="block">Read configuration options from <code>properties</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/PropertyConfigurator.html#configure-java.lang.String-">configure</a></span>(java.lang.String configFilename)</code> </td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/PropertyConfigurator.html#configure-java.net.URL-">configure</a></span>(java.net.URL configURL)</code>
<div class="block">Read configuration options from url <code>configURL</code>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/PropertyConfigurator.html#configureAndWatch-java.lang.String-">configureAndWatch</a></span>(java.lang.String configFilename)</code>
<div class="block">Like <a href="../../../org/apache/log4j/PropertyConfigurator.html#configureAndWatch-java.lang.String-long-"><code>configureAndWatch(String, long)</code></a> except that the
default delay as defined by <a href="../../../org/apache/log4j/helpers/FileWatchdog.html#DEFAULT_DELAY"><code>FileWatchdog.DEFAULT_DELAY</code></a> is
used.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/PropertyConfigurator.html#configureAndWatch-java.lang.String-long-">configureAndWatch</a></span>(java.lang.String configFilename,
long delay)</code>
<div class="block">Read the configuration file <code>configFilename</code> if it
exists.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/PropertyConfigurator.html#configureLoggerFactory-java.util.Properties-">configureLoggerFactory</a></span>(java.util.Properties props)</code>
<div class="block">Check the provided <code>Properties</code> object for a
<a href="../../../org/apache/log4j/spi/LoggerFactory.html" title="interface in org.apache.log4j.spi"><code>LoggerFactory</code></a>
entry specified by <a href="../../../org/apache/log4j/PropertyConfigurator.html#LOGGER_FACTORY_KEY"><code>LOGGER_FACTORY_KEY</code></a>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/PropertyConfigurator.html#doConfigure-java.io.InputStream-org.apache.log4j.spi.LoggerRepository-">doConfigure</a></span>(java.io.InputStream inputStream,
<a href="../../../org/apache/log4j/spi/LoggerRepository.html" title="interface in org.apache.log4j.spi">LoggerRepository</a> hierarchy)</code>
<div class="block">Read configuration options from url <code>configURL</code>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/PropertyConfigurator.html#doConfigure-java.util.Properties-org.apache.log4j.spi.LoggerRepository-">doConfigure</a></span>(java.util.Properties properties,
<a href="../../../org/apache/log4j/spi/LoggerRepository.html" title="interface in org.apache.log4j.spi">LoggerRepository</a> hierarchy)</code>
<div class="block">Read configuration options from <code>properties</code>.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/PropertyConfigurator.html#doConfigure-java.lang.String-org.apache.log4j.spi.LoggerRepository-">doConfigure</a></span>(java.lang.String configFileName,
<a href="../../../org/apache/log4j/spi/LoggerRepository.html" title="interface in org.apache.log4j.spi">LoggerRepository</a> hierarchy)</code>
<div class="block">Read configuration from a file.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/PropertyConfigurator.html#doConfigure-java.net.URL-org.apache.log4j.spi.LoggerRepository-">doConfigure</a></span>(java.net.URL configURL,
<a href="../../../org/apache/log4j/spi/LoggerRepository.html" title="interface in org.apache.log4j.spi">LoggerRepository</a> hierarchy)</code>
<div class="block">Read configuration options from url <code>configURL</code>.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/PropertyConfigurator.html#parseCatsAndRenderers-java.util.Properties-org.apache.log4j.spi.LoggerRepository-">parseCatsAndRenderers</a></span>(java.util.Properties props,
<a href="../../../org/apache/log4j/spi/LoggerRepository.html" title="interface in org.apache.log4j.spi">LoggerRepository</a> hierarchy)</code>
<div class="block">Parse non-root elements, such non-root categories and renderers.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="registry">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registry</h4>
<pre>protected java.util.Hashtable registry</pre>
<div class="block">Used internally to keep track of configured appenders.</div>
</li>
</ul>
<a name="loggerFactory">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loggerFactory</h4>
<pre>protected <a href="../../../org/apache/log4j/spi/LoggerFactory.html" title="interface in org.apache.log4j.spi">LoggerFactory</a> loggerFactory</pre>
</li>
</ul>
<a name="LOGGER_FACTORY_KEY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LOGGER_FACTORY_KEY</h4>
<pre>public static final java.lang.String LOGGER_FACTORY_KEY</pre>
<div class="block">Key for specifying the <a href="../../../org/apache/log4j/spi/LoggerFactory.html" title="interface in org.apache.log4j.spi"><code>LoggerFactory</code></a>. Currently set to "<code>log4j.loggerFactory</code>".</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#org.apache.log4j.PropertyConfigurator.LOGGER_FACTORY_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PropertyConfigurator--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PropertyConfigurator</h4>
<pre>public PropertyConfigurator()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="doConfigure-java.lang.String-org.apache.log4j.spi.LoggerRepository-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doConfigure</h4>
<pre>public void doConfigure(java.lang.String configFileName,
<a href="../../../org/apache/log4j/spi/LoggerRepository.html" title="interface in org.apache.log4j.spi">LoggerRepository</a> hierarchy)</pre>
<div class="block">Read configuration from a file. <b>The existing configuration is
not cleared nor reset.</b> If you require a different behavior,
then call <a href="../../../org/apache/log4j/LogManager.html#resetConfiguration--"><code>resetConfiguration</code></a> method before calling
<code>doConfigure</code>.
<p>The configuration file consists of statements in the format
<code>key=value</code>. The syntax of different configuration
elements are discussed below.
<h3>Repository-wide threshold</h3>
<p>The repository-wide threshold filters logging requests by level
regardless of logger. The syntax is:
<pre>
log4j.threshold=[level]
</pre>
<p>The level value can consist of the string values OFF, FATAL,
ERROR, WARN, INFO, DEBUG, ALL or a <em>custom level</em> value. A
custom level value can be specified in the form
level#classname. By default the repository-wide threshold is set
to the lowest possible value, namely the level <code>ALL</code>.
</p>
<h3>Appender configuration</h3>
<p>Appender configuration syntax is:
<pre>
# For appender named <i>appenderName</i>, set its class.
# Note: The appender name can contain dots.
log4j.appender.appenderName=fully.qualified.name.of.appender.class
# Set appender specific options.
log4j.appender.appenderName.option1=value1
...
log4j.appender.appenderName.optionN=valueN
</pre>
For each named appender you can configure its <a href="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j"><code>Layout</code></a>. The
syntax for configuring an appender's layout is:
<pre>
log4j.appender.appenderName.layout=fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1=value1
....
log4j.appender.appenderName.layout.optionN=valueN
</pre>
The syntax for adding <a href="../../../org/apache/log4j/spi/Filter.html" title="class in org.apache.log4j.spi"><code>Filter</code></a>s to an appender is:
<pre>
log4j.appender.appenderName.filter.ID=fully.qualified.name.of.filter.class
log4j.appender.appenderName.filter.ID.option1=value1
...
log4j.appender.appenderName.filter.ID.optionN=valueN
</pre>
The first line defines the class name of the filter identified by ID;
subsequent lines with the same ID specify filter option - value
paris. Multiple filters are added to the appender in the lexicographic
order of IDs.
The syntax for adding an <a href="../../../org/apache/log4j/spi/ErrorHandler.html" title="interface in org.apache.log4j.spi"><code>ErrorHandler</code></a> to an appender is:
<pre>
log4j.appender.appenderName.errorhandler=fully.qualified.name.of.filter.class
log4j.appender.appenderName.errorhandler.root-ref={true|false}
log4j.appender.appenderName.errorhandler.logger-ref=loggerName
log4j.appender.appenderName.errorhandler.appender-ref=appenderName
log4j.appender.appenderName.errorhandler.option1=value1
...
log4j.appender.appenderName.errorhandler.optionN=valueN
</pre>
<h3>Configuring loggers</h3>
<p>The syntax for configuring the root logger is:
<pre>
log4j.rootLogger=[level], appenderName, appenderName, ...
</pre>
<p>This syntax means that an optional <em>level</em> can be
supplied followed by appender names separated by commas.
<p>The level value can consist of the string values OFF, FATAL,
ERROR, WARN, INFO, DEBUG, ALL or a <em>custom level</em> value. A
custom level value can be specified in the form
<code>level#classname</code>.
<p>If a level value is specified, then the root level is set
to the corresponding level. If no level value is specified,
then the root level remains untouched.
<p>The root logger can be assigned multiple appenders.
<p>Each <i>appenderName</i> (separated by commas) will be added to
the root logger. The named appender is defined using the
appender syntax defined above.
<p>For non-root categories the syntax is almost the same:
<pre>
log4j.logger.logger_name=[level|INHERITED|NULL], appenderName, appenderName, ...
</pre>
<p>The meaning of the optional level value is discussed above
in relation to the root logger. In addition however, the value
INHERITED can be specified meaning that the named logger should
inherit its level from the logger hierarchy.
<p>If no level value is supplied, then the level of the
named logger remains untouched.
<p>By default categories inherit their level from the
hierarchy. However, if you set the level of a logger and later
decide that that logger should inherit its level, then you should
specify INHERITED as the value for the level value. NULL is a
synonym for INHERITED.
<p>Similar to the root logger syntax, each <i>appenderName</i>
(separated by commas) will be attached to the named logger.
<p>See the <a href="../../../../manual.html#additivity">appender
additivity rule</a> in the user manual for the meaning of the
<code>additivity</code> flag.
<h3>ObjectRenderers</h3>
You can customize the way message objects of a given type are
converted to String before being logged. This is done by
specifying an <a href="../../../org/apache/log4j/or/ObjectRenderer.html" title="interface in org.apache.log4j.or"><code>ObjectRenderer</code></a>
for the object type would like to customize.
<p>The syntax is:
<pre>
log4j.renderer.fully.qualified.name.of.rendered.class=fully.qualified.name.of.rendering.class
</pre>
As in,
<pre>
log4j.renderer.my.Fruit=my.FruitRenderer
</pre>
<h3>ThrowableRenderer</h3>
You can customize the way an instance of Throwable is
converted to String before being logged. This is done by
specifying an <a href="../../../org/apache/log4j/spi/ThrowableRenderer.html" title="interface in org.apache.log4j.spi"><code>ThrowableRenderer</code></a>.
<p>The syntax is:
<pre>
log4j.throwableRenderer=fully.qualified.name.of.rendering.class
log4j.throwableRenderer.paramName=paramValue
</pre>
As in,
<pre>
log4j.throwableRenderer=org.apache.log4j.EnhancedThrowableRenderer
</pre>
<h3>Logger Factories</h3>
The usage of custom logger factories is discouraged and no longer
documented.
<h3>Resetting Hierarchy</h3>
The hierarchy will be reset before configuration when
log4j.reset=true is present in the properties file.
<h3>Example</h3>
<p>An example configuration is given below. Other configuration
file examples are given in the <code>examples</code> folder.
<pre>
# Set options for appender named "A1".
# Appender "A1" will be a SyslogAppender
log4j.appender.A1=org.apache.log4j.net.SyslogAppender
# The syslog daemon resides on www.abc.net
log4j.appender.A1.SyslogHost=www.abc.net
# A1's layout is a PatternLayout, using the conversion pattern
# <b>%r %-5p %c{2} %M.%L %x - %m\n</b>. Thus, the log output will
# include # the relative time since the start of the application in
# milliseconds, followed by the level of the log request,
# followed by the two rightmost components of the logger name,
# followed by the callers method name, followed by the line number,
# the nested disgnostic context and finally the message itself.
# Refer to the documentation of <a href="../../../org/apache/log4j/PatternLayout.html" title="class in org.apache.log4j"><code>PatternLayout</code></a> for further information
# on the syntax of the ConversionPattern key.
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %c{2} %M.%L %x - %m\n
# Set options for appender named "A2"
# A2 should be a RollingFileAppender, with maximum file size of 10 MB
# using at most one backup file. A2's layout is TTCC, using the
# ISO8061 date format with context printing enabled.
log4j.appender.A2=org.apache.log4j.RollingFileAppender
log4j.appender.A2.MaxFileSize=10MB
log4j.appender.A2.MaxBackupIndex=1
log4j.appender.A2.layout=org.apache.log4j.TTCCLayout
log4j.appender.A2.layout.ContextPrinting=enabled
log4j.appender.A2.layout.DateFormat=ISO8601
# Root logger set to DEBUG using the A2 appender defined above.
log4j.rootLogger=DEBUG, A2
# Logger definitions:
# The SECURITY logger inherits is level from root. However, it's output
# will go to A1 appender defined above. It's additivity is non-cumulative.
log4j.logger.SECURITY=INHERIT, A1
log4j.additivity.SECURITY=false
# Only warnings or above will be logged for the logger "SECURITY.access".
# Output will go to A1.
log4j.logger.SECURITY.access=WARN
# The logger "class.of.the.day" inherits its level from the
# logger hierarchy. Output will go to the appender's of the root
# logger, A2 in this case.
log4j.logger.class.of.the.day=INHERIT
</pre>
<p>Refer to the <b>setOption</b> method in each Appender and
Layout for class specific options.
<p>Use the <code>#</code> or <code>!</code> characters at the
beginning of a line for comments.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configFileName</code> - The name of the configuration file where the
configuration information is stored.</dd>
</dl>
</li>
</ul>
<a name="configure-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre>public static void configure(java.lang.String configFilename)</pre>
</li>
</ul>
<a name="configure-java.net.URL-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre>public static void configure(java.net.URL configURL)</pre>
<div class="block">Read configuration options from url <code>configURL</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.8.2</dd>
</dl>
</li>
</ul>
<a name="configure-java.io.InputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre>public static void configure(java.io.InputStream inputStream)</pre>
<div class="block">Reads configuration options from an InputStream.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2.17</dd>
</dl>
</li>
</ul>
<a name="configure-java.util.Properties-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre>public static void configure(java.util.Properties properties)</pre>
<div class="block">Read configuration options from <code>properties</code>.
See <a href="../../../org/apache/log4j/PropertyConfigurator.html#doConfigure-java.lang.String-org.apache.log4j.spi.LoggerRepository-"><code>doConfigure(String, LoggerRepository)</code></a> for the expected format.</div>
</li>
</ul>
<a name="configureAndWatch-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureAndWatch</h4>
<pre>public static void configureAndWatch(java.lang.String configFilename)</pre>
<div class="block">Like <a href="../../../org/apache/log4j/PropertyConfigurator.html#configureAndWatch-java.lang.String-long-"><code>configureAndWatch(String, long)</code></a> except that the
default delay as defined by <a href="../../../org/apache/log4j/helpers/FileWatchdog.html#DEFAULT_DELAY"><code>FileWatchdog.DEFAULT_DELAY</code></a> is
used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configFilename</code> - A file in key=value format.</dd>
</dl>
</li>
</ul>
<a name="configureAndWatch-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureAndWatch</h4>
<pre>public static void configureAndWatch(java.lang.String configFilename,
long delay)</pre>
<div class="block">Read the configuration file <code>configFilename</code> if it
exists. Moreover, a thread will be created that will periodically
check if <code>configFilename</code> has been created or
modified. The period is determined by the <code>delay</code>
argument. If a change or file creation is detected, then
<code>configFilename</code> is read to configure log4j.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configFilename</code> - A file in key=value format.</dd>
<dd><code>delay</code> - The delay in milliseconds to wait between each check.</dd>
</dl>
</li>
</ul>
<a name="doConfigure-java.util.Properties-org.apache.log4j.spi.LoggerRepository-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doConfigure</h4>
<pre>public void doConfigure(java.util.Properties properties,
<a href="../../../org/apache/log4j/spi/LoggerRepository.html" title="interface in org.apache.log4j.spi">LoggerRepository</a> hierarchy)</pre>
<div class="block">Read configuration options from <code>properties</code>.
See <a href="../../../org/apache/log4j/PropertyConfigurator.html#doConfigure-java.lang.String-org.apache.log4j.spi.LoggerRepository-"><code>doConfigure(String, LoggerRepository)</code></a> for the expected format.</div>
</li>
</ul>
<a name="doConfigure-java.io.InputStream-org.apache.log4j.spi.LoggerRepository-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doConfigure</h4>
<pre>public void doConfigure(java.io.InputStream inputStream,
<a href="../../../org/apache/log4j/spi/LoggerRepository.html" title="interface in org.apache.log4j.spi">LoggerRepository</a> hierarchy)</pre>
<div class="block">Read configuration options from url <code>configURL</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/log4j/spi/Configurator.html#doConfigure-java.io.InputStream-org.apache.log4j.spi.LoggerRepository-">doConfigure</a></code> in interface <code><a href="../../../org/apache/log4j/spi/Configurator.html" title="interface in org.apache.log4j.spi">Configurator</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inputStream</code> - The InputStream to parse</dd>
<dd><code>hierarchy</code> - The hierarchy to operation upon.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2.17</dd>
</dl>
</li>
</ul>
<a name="doConfigure-java.net.URL-org.apache.log4j.spi.LoggerRepository-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doConfigure</h4>
<pre>public void doConfigure(java.net.URL configURL,
<a href="../../../org/apache/log4j/spi/LoggerRepository.html" title="interface in org.apache.log4j.spi">LoggerRepository</a> hierarchy)</pre>
<div class="block">Read configuration options from url <code>configURL</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/log4j/spi/Configurator.html#doConfigure-java.net.URL-org.apache.log4j.spi.LoggerRepository-">doConfigure</a></code> in interface <code><a href="../../../org/apache/log4j/spi/Configurator.html" title="interface in org.apache.log4j.spi">Configurator</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configURL</code> - The URL to parse</dd>
<dd><code>hierarchy</code> - The hierarchy to operation upon.</dd>
</dl>
</li>
</ul>
<a name="configureLoggerFactory-java.util.Properties-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureLoggerFactory</h4>
<pre>protected void configureLoggerFactory(java.util.Properties props)</pre>
<div class="block">Check the provided <code>Properties</code> object for a
<a href="../../../org/apache/log4j/spi/LoggerFactory.html" title="interface in org.apache.log4j.spi"><code>LoggerFactory</code></a>
entry specified by <a href="../../../org/apache/log4j/PropertyConfigurator.html#LOGGER_FACTORY_KEY"><code>LOGGER_FACTORY_KEY</code></a>. If such an entry
exists, an attempt is made to create an instance using the default
constructor. This instance is used for subsequent Category creations
within this configurator.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/apache/log4j/PropertyConfigurator.html#parseCatsAndRenderers-java.util.Properties-org.apache.log4j.spi.LoggerRepository-"><code>parseCatsAndRenderers(java.util.Properties, org.apache.log4j.spi.LoggerRepository)</code></a></dd>
</dl>
</li>
</ul>
<a name="parseCatsAndRenderers-java.util.Properties-org.apache.log4j.spi.LoggerRepository-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>parseCatsAndRenderers</h4>
<pre>protected void parseCatsAndRenderers(java.util.Properties props,
<a href="../../../org/apache/log4j/spi/LoggerRepository.html" title="interface in org.apache.log4j.spi">LoggerRepository</a> hierarchy)</pre>
<div class="block">Parse non-root elements, such non-root categories and renderers.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PropertyConfigurator.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Log4j 1.2.17</b><!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You 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. --></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/apache/log4j/Priority.html" title="class in org.apache.log4j"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/apache/log4j/RollingFileAppender.html" title="class in org.apache.log4j"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/log4j/PropertyConfigurator.html" target="_top">Frames</a></li>
<li><a href="PropertyConfigurator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright 2000-2007 Apache Software Foundation.</small></p>
</body>
</html>
|