| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_131) on Wed Aug 02 06:39:26 CEST 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>VFSLogFilePatternReceiver (Apache Chainsaw 2.1.0-SNAPSHOT API)</title> |
| <meta name="date" content="2017-08-02"> |
| <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="VFSLogFilePatternReceiver (Apache Chainsaw 2.1.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All 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/VFSLogFilePatternReceiver.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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../org/apache/log4j/chainsaw/vfs/VFSLogFilePatternReceiver.UserNamePasswordDialog.html" title="class in org.apache.log4j.chainsaw.vfs"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/log4j/chainsaw/vfs/VFSLogFilePatternReceiver.html" target="_top">Frames</a></li> |
| <li><a href="VFSLogFilePatternReceiver.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.log4j.varia.LogFilePatternReceiver">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>Field | </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.chainsaw.vfs</div> |
| <h2 title="Class VFSLogFilePatternReceiver" class="title">Class VFSLogFilePatternReceiver</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/log4j/spi/ComponentBase.html" title="class in org.apache.log4j.spi">org.apache.log4j.spi.ComponentBase</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html" title="class in org.apache.log4j.plugins">org.apache.log4j.plugins.PluginSkeleton</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/log4j/plugins/Receiver.html" title="class in org.apache.log4j.plugins">org.apache.log4j.plugins.Receiver</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html" title="class in org.apache.log4j.varia">org.apache.log4j.varia.LogFilePatternReceiver</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.log4j.chainsaw.vfs.VFSLogFilePatternReceiver</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </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/chainsaw/receivers/VisualReceiver.html" title="interface in org.apache.log4j.chainsaw.receivers">VisualReceiver</a>, <a href="../../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a>, <a href="../../../../../org/apache/log4j/spi/Component.html" title="interface in org.apache.log4j.spi">Component</a>, org.apache.log4j.spi.OptionHandler, <a href="../../../../../org/apache/log4j/spi/Thresholdable.html" title="interface in org.apache.log4j.spi">Thresholdable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">VFSLogFilePatternReceiver</span> |
| extends <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html" title="class in org.apache.log4j.varia">LogFilePatternReceiver</a> |
| implements <a href="../../../../../org/apache/log4j/chainsaw/receivers/VisualReceiver.html" title="interface in org.apache.log4j.chainsaw.receivers">VisualReceiver</a></pre> |
| <div class="block">A VFS-enabled version of org.apache.log4j.varia.LogFilePatternReceiver. |
| |
| VFSLogFilePatternReceiver can parse and tail log files, converting entries into |
| LoggingEvents. If the file doesn't exist when the receiver is initialized, the |
| receiver will look for the file once every 10 seconds. |
| <p> |
| See the Chainsaw page (http://logging.apache.org/log4j/docs/chainsaw.html) for information |
| on how to set up Chainsaw with VFS. |
| <p> |
| See http://jakarta.apache.org/commons/vfs/filesystems.html for a list of VFS-supported |
| file systems and the URIs needed to access the file systems. |
| <p> |
| Because some VFS file systems allow you to provide username/password, this receiver |
| provides an optional GUI dialog for entering the username/password fields instead |
| of requiring you to hard code usernames and passwords into the URI. |
| <p> |
| If the 'promptForUserInfo' param is set to true (default is false), |
| the receiver will wait for a call to 'setContainer', and then display |
| a username/password dialog. |
| <p> |
| If you are using this receiver without a GUI, don't set promptForUserInfo |
| to true - it will block indefinitely waiting for a visual component. |
| <p> |
| If the 'promptForUserInfo' param is set to true, the fileURL should -leave out- |
| the username/password portion of the VFS-supported URI. Examples: |
| <p> |
| An sftp URI that would be used with promptForUserInfo=true: |
| sftp://192.168.1.100:22/home/thisuser/logfile.txt |
| <p> |
| An sftp URI that would be used with promptForUserInfo=false: |
| sftp://username:password@192.168.1.100:22/home/thisuser/logfile.txt |
| <p> |
| This receiver relies on java.util.regex features to perform the parsing of text in the |
| log file, however the only regular expression field explicitly supported is |
| a glob-style wildcard used to ignore fields in the log file if needed. All other |
| fields are parsed by using the supplied keywords. |
| <p> |
| <b>Features:</b><br> |
| - specify the URL of the log file to be processed<br> |
| - specify the timestamp format in the file (if one exists, using patterns from <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text"><code>SimpleDateFormat</code></a>)<br> |
| - specify the pattern (logFormat) used in the log file using keywords, a wildcard character (*) and fixed text<br> |
| - 'tail' the file (allows the contents of the file to be continually read and new events processed)<br> |
| - supports the parsing of multi-line messages and exceptions |
| - to access |
| <p> |
| <b>Keywords:</b><br> |
| TIMESTAMP<br> |
| LOGGER<br> |
| LEVEL<br> |
| THREAD<br> |
| CLASS<br> |
| FILE<br> |
| LINE<br> |
| METHOD<br> |
| RELATIVETIME<br> |
| MESSAGE<br> |
| NDC<br> |
| PROP(key)<br> |
| <p> |
| Use a * to ignore portions of the log format that should be ignored |
| <p> |
| Example:<br> |
| If your file's patternlayout is this:<br> |
| <b>%d %-5p [%t] %C{2} (%F:%L) - %m%n</b> |
| <p> |
| specify this as the log format:<br> |
| <b>TIMESTAMP LEVEL [THREAD] CLASS (FILE:LINE) - MESSAGE</b> |
| <p> |
| To define a PROPERTY field, use PROP(key) |
| <p> |
| Example:<br> |
| If you used the RELATIVETIME pattern layout character in the file, |
| you can use PROP(RELATIVETIME) in the logFormat definition to assign |
| the RELATIVETIME field as a property on the event. |
| <p> |
| If your file's patternlayout is this:<br> |
| <b>%r [%t] %-5p %c %x - %m%n</b> |
| <p> |
| specify this as the log format:<br> |
| <b>PROP(RELATIVETIME) [THREAD] LEVEL LOGGER * - MESSAGE</b> |
| <p> |
| Note the * - it can be used to ignore a single word or sequence of words in the log file |
| (in order for the wildcard to ignore a sequence of words, the text being ignored must be |
| followed by some delimiter, like '-' or '[') - ndc is being ignored in this example. |
| <p> |
| Assign a filterExpression in order to only process events which match a filter. |
| If a filterExpression is not assigned, all events are processed. |
| <p> |
| <b>Limitations:</b><br> |
| - no support for the single-line version of throwable supported by patternlayout<br> |
| (this version of throwable will be included as the last line of the message)<br> |
| - the relativetime patternLayout character must be set as a property: PROP(RELATIVETIME)<br> |
| - messages should appear as the last field of the logFormat because the variability in message content<br> |
| - exceptions are converted if the exception stack trace (other than the first line of the exception)<br> |
| is stored in the log file with a tab followed by the word 'at' as the first characters in the line<br> |
| - tailing may fail if the file rolls over. |
| <p> |
| <b>Example receiver configuration settings</b> (add these as params, specifying a LogFilePatternReceiver 'plugin'):<br> |
| param: "timestampFormat" value="yyyy-MM-d HH:mm:ss,SSS"<br> |
| param: "logFormat" value="RELATIVETIME [THREAD] LEVEL LOGGER * - MESSAGE"<br> |
| param: "fileURL" value="file:///c:/events.log"<br> |
| param: "tailing" value="true" |
| param: "promptForUserInfo" value="false" |
| <p> |
| This configuration will be able to process these sample events:<br> |
| 710 [ Thread-0] DEBUG first.logger first - <test> <test2>something here</test2> <test3 blah=something/> <test4> <test5>something else</test5> </test4></test><br> |
| 880 [ Thread-2] DEBUG first.logger third - <test> <test2>something here</test2> <test3 blah=something/> <test4> <test5>something else</test5> </test4></test><br> |
| 880 [ Thread-0] INFO first.logger first - infomsg-0<br> |
| java.lang.Exception: someexception-first<br> |
| at Generator2.run(Generator2.java:102)<br></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Scott Deboy</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/log4j/chainsaw/vfs/VFSLogFilePatternReceiver.UserNamePasswordDialog.html" title="class in org.apache.log4j.chainsaw.vfs">VFSLogFilePatternReceiver.UserNamePasswordDialog</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.log4j.varia.LogFilePatternReceiver"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.log4j.varia.<a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html" title="class in org.apache.log4j.varia">LogFilePatternReceiver</a></h3> |
| <code><a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#MISSING_FILE_RETRY_MILLIS">MISSING_FILE_RETRY_MILLIS</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.log4j.plugins.Receiver"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.log4j.plugins.<a href="../../../../../org/apache/log4j/plugins/Receiver.html" title="class in org.apache.log4j.plugins">Receiver</a></h3> |
| <code><a href="../../../../../org/apache/log4j/plugins/Receiver.html#thresholdLevel">thresholdLevel</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.log4j.plugins.PluginSkeleton"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.log4j.plugins.<a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html" title="class in org.apache.log4j.plugins">PluginSkeleton</a></h3> |
| <code><a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html#active">active</a>, <a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html#name">name</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.log4j.spi.ComponentBase"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.log4j.spi.<a href="../../../../../org/apache/log4j/spi/ComponentBase.html" title="class in org.apache.log4j.spi">ComponentBase</a></h3> |
| <code><a href="../../../../../org/apache/log4j/spi/ComponentBase.html#repository">repository</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/chainsaw/vfs/VFSLogFilePatternReceiver.html#VFSLogFilePatternReceiver--">VFSLogFilePatternReceiver</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="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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/log4j/chainsaw/vfs/VFSLogFilePatternReceiver.html#activateOptions--">activateOptions</a></span>()</code> |
| <div class="block">Read and process the log file.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/log4j/chainsaw/vfs/VFSLogFilePatternReceiver.html#isAutoReconnect--">isAutoReconnect</a></span>()</code> |
| <div class="block">Accessor</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/log4j/chainsaw/vfs/VFSLogFilePatternReceiver.html#isPromptForUserInfo--">isPromptForUserInfo</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/log4j/chainsaw/vfs/VFSLogFilePatternReceiver.html#setAutoReconnect-boolean-">setAutoReconnect</a></span>(boolean autoReconnect)</code> |
| <div class="block">Mutator</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/log4j/chainsaw/vfs/VFSLogFilePatternReceiver.html#setContainer-java.awt.Container-">setContainer</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/awt/Container.html?is-external=true" title="class or interface in java.awt">Container</a> container)</code> |
| <div class="block">Implementation of VisualReceiver interface - allows this receiver to provide |
| a username/password dialog.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/log4j/chainsaw/vfs/VFSLogFilePatternReceiver.html#setPromptForUserInfo-boolean-">setPromptForUserInfo</a></span>(boolean promptForUserInfo)</code> |
| <div class="block">If set to true, will cause the receiver to block indefinitely until 'setContainer' has been called, |
| at which point a username/password dialog will appear.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/log4j/chainsaw/vfs/VFSLogFilePatternReceiver.html#shutdown--">shutdown</a></span>()</code> |
| <div class="block">Close the reader.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.varia.LogFilePatternReceiver"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.log4j.varia.<a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html" title="class in org.apache.log4j.varia">LogFilePatternReceiver</a></h3> |
| <code><a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#createPattern--">createPattern</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#getCustomLevelDefinitions--">getCustomLevelDefinitions</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#getFileURL--">getFileURL</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#getFilterExpression--">getFilterExpression</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#getGroup--">getGroup</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#getLogFormat--">getLogFormat</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#getPath--">getPath</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#getTimestampFormat--">getTimestampFormat</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#getWaitMillis--">getWaitMillis</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#initialize--">initialize</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#isAppendNonMatches--">isAppendNonMatches</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#isTailing--">isTailing</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#isUseCurrentThread--">isUseCurrentThread</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#process-java.io.BufferedReader-">process</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#setAppendNonMatches-boolean-">setAppendNonMatches</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#setCustomLevelDefinitions-java.lang.String-">setCustomLevelDefinitions</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#setFileURL-java.lang.String-">setFileURL</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#setFilterExpression-java.lang.String-">setFilterExpression</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#setGroup-java.lang.String-">setGroup</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#setHost-java.lang.String-">setHost</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#setLogFormat-java.lang.String-">setLogFormat</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#setPath-java.lang.String-">setPath</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#setTailing-boolean-">setTailing</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#setTimestampFormat-java.lang.String-">setTimestampFormat</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#setUseCurrentThread-boolean-">setUseCurrentThread</a>, <a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#setWaitMillis-long-">setWaitMillis</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.plugins.Receiver"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.log4j.plugins.<a href="../../../../../org/apache/log4j/plugins/Receiver.html" title="class in org.apache.log4j.plugins">Receiver</a></h3> |
| <code><a href="../../../../../org/apache/log4j/plugins/Receiver.html#doPost-org.apache.log4j.spi.LoggingEvent-">doPost</a>, <a href="../../../../../org/apache/log4j/plugins/Receiver.html#getThreshold--">getThreshold</a>, <a href="../../../../../org/apache/log4j/plugins/Receiver.html#isAsSevereAsThreshold-org.apache.log4j.Level-">isAsSevereAsThreshold</a>, <a href="../../../../../org/apache/log4j/plugins/Receiver.html#setThreshold-org.apache.log4j.Level-">setThreshold</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.plugins.PluginSkeleton"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.log4j.plugins.<a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html" title="class in org.apache.log4j.plugins">PluginSkeleton</a></h3> |
| <code><a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html#addPropertyChangeListener-java.beans.PropertyChangeListener-">addPropertyChangeListener</a>, <a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html#addPropertyChangeListener-java.lang.String-java.beans.PropertyChangeListener-">addPropertyChangeListener</a>, <a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html#firePropertyChange-java.beans.PropertyChangeEvent-">firePropertyChange</a>, <a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html#firePropertyChange-java.lang.String-boolean-boolean-">firePropertyChange</a>, <a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html#firePropertyChange-java.lang.String-int-int-">firePropertyChange</a>, <a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html#firePropertyChange-java.lang.String-java.lang.Object-java.lang.Object-">firePropertyChange</a>, <a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html#getLoggerRepository--">getLoggerRepository</a>, <a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html#getName--">getName</a>, <a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html#isActive--">isActive</a>, <a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html#isEquivalent-org.apache.log4j.plugins.Plugin-">isEquivalent</a>, <a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html#removePropertyChangeListener-java.beans.PropertyChangeListener-">removePropertyChangeListener</a>, <a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html#removePropertyChangeListener-java.lang.String-java.beans.PropertyChangeListener-">removePropertyChangeListener</a>, <a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html#setLoggerRepository-org.apache.log4j.spi.LoggerRepository-">setLoggerRepository</a>, <a href="../../../../../org/apache/log4j/plugins/PluginSkeleton.html#setName-java.lang.String-">setName</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.spi.ComponentBase"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.log4j.spi.<a href="../../../../../org/apache/log4j/spi/ComponentBase.html" title="class in org.apache.log4j.spi">ComponentBase</a></h3> |
| <code><a href="../../../../../org/apache/log4j/spi/ComponentBase.html#getLogger--">getLogger</a>, <a href="../../../../../org/apache/log4j/spi/ComponentBase.html#getNonFloodingLogger--">getNonFloodingLogger</a>, <a href="../../../../../org/apache/log4j/spi/ComponentBase.html#resetErrorCount--">resetErrorCount</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="VFSLogFilePatternReceiver--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>VFSLogFilePatternReceiver</h4> |
| <pre>public VFSLogFilePatternReceiver()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="shutdown--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shutdown</h4> |
| <pre>public void shutdown()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#shutdown--">LogFilePatternReceiver</a></code></span></div> |
| <div class="block">Close the reader.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/log4j/plugins/Plugin.html#shutdown--">shutdown</a></code> in interface <code><a href="../../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#shutdown--">shutdown</a></code> in class <code><a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html" title="class in org.apache.log4j.varia">LogFilePatternReceiver</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPromptForUserInfo-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPromptForUserInfo</h4> |
| <pre>public void setPromptForUserInfo(boolean promptForUserInfo)</pre> |
| <div class="block">If set to true, will cause the receiver to block indefinitely until 'setContainer' has been called, |
| at which point a username/password dialog will appear.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>promptForUserInfo</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isPromptForUserInfo--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPromptForUserInfo</h4> |
| <pre>public boolean isPromptForUserInfo()</pre> |
| </li> |
| </ul> |
| <a name="isAutoReconnect--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAutoReconnect</h4> |
| <pre>public boolean isAutoReconnect()</pre> |
| <div class="block">Accessor</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAutoReconnect-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAutoReconnect</h4> |
| <pre>public void setAutoReconnect(boolean autoReconnect)</pre> |
| <div class="block">Mutator</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>autoReconnect</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setContainer-java.awt.Container-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContainer</h4> |
| <pre>public void setContainer(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/awt/Container.html?is-external=true" title="class or interface in java.awt">Container</a> container)</pre> |
| <div class="block">Implementation of VisualReceiver interface - allows this receiver to provide |
| a username/password dialog.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/log4j/chainsaw/receivers/VisualReceiver.html#setContainer-java.awt.Container-">setContainer</a></code> in interface <code><a href="../../../../../org/apache/log4j/chainsaw/receivers/VisualReceiver.html" title="interface in org.apache.log4j.chainsaw.receivers">VisualReceiver</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="activateOptions--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>activateOptions</h4> |
| <pre>public void activateOptions()</pre> |
| <div class="block">Read and process the log file.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>activateOptions</code> in interface <code>org.apache.log4j.spi.OptionHandler</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html#activateOptions--">activateOptions</a></code> in class <code><a href="../../../../../org/apache/log4j/varia/LogFilePatternReceiver.html" title="class in org.apache.log4j.varia">LogFilePatternReceiver</a></code></dd> |
| </dl> |
| </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/VFSLogFilePatternReceiver.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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../org/apache/log4j/chainsaw/vfs/VFSLogFilePatternReceiver.UserNamePasswordDialog.html" title="class in org.apache.log4j.chainsaw.vfs"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/log4j/chainsaw/vfs/VFSLogFilePatternReceiver.html" target="_top">Frames</a></li> |
| <li><a href="VFSLogFilePatternReceiver.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.log4j.varia.LogFilePatternReceiver">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>Field | </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><p align="center">Copyright © 2002-2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.<br /> Apache Logging, Apache Log4j, Log4j, Apache Chainsaw, Chainsaw, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.</p></small></p> |
| </body> |
| </html> |
