Google Git
Sign in
apache / logging-site / 374ddfaf0c8e4e25cf021eeda7558428b615af1e / . / projects / chainsaw / 2.0.0 / apidocs / org / apache / log4j / xml / LogFileXMLReceiver.html
blob: 83cf1b759fd9cb1713946c42cdebb2982111531f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_111) on Sat Jan 20 11:27:19 CST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LogFileXMLReceiver (Apache Chainsaw 2.0.0 API)</title>
<meta name="date" content="2018-01-20">
<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="LogFileXMLReceiver (Apache Chainsaw 2.0.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":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/LogFileXMLReceiver.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&nbsp;Class</li>
<li><a href="../../../../org/apache/log4j/xml/UtilLoggingEntityResolver.html" title="class in org.apache.log4j.xml"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/log4j/xml/LogFileXMLReceiver.html" target="_top">Frames</a></li>
<li><a href="LogFileXMLReceiver.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.log4j.plugins.Receiver">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.xml</div>
<h2 title="Class LogFileXMLReceiver" class="title">Class LogFileXMLReceiver</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/6/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>org.apache.log4j.xml.LogFileXMLReceiver</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/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">LogFileXMLReceiver</span>
extends <a href="../../../../org/apache/log4j/plugins/Receiver.html" title="class in org.apache.log4j.plugins">Receiver</a></pre>
<div class="block">LogFileXMLReceiver will read an xml-formated log file and make the events in the log file
available to the log4j framework.
<p>
This receiver supports log files created using log4j's XMLLayout, as well as java.util.logging
XMLFormatter (via the org.apache.log4j.spi.Decoder interface).
<p>
By default, log4j's XMLLayout is supported (no need to specify a decoder in that case).
<p>
To configure this receiver to support java.util.logging's XMLFormatter, specify a 'decoder' param
of org.apache.log4j.xml.UtilLoggingXMLDecoder.
<p>
Tailing -may- work, but not in all cases (try using a file:// URL). If a process has a log file
open, the receiver may be able to read and tail the file. If the process closes the file and
reopens the file, the receiver may not be able to continue tailing the file.
<p>
An expressionFilter may be specified. Only events passing the expression will be forwarded to the
log4j framework.
<p>
Once the event has been "posted", it will be handled by the appenders currently configured in the
LoggerRespository.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.3</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Scott Deboy &lt;sdeboy@apache.org&gt;</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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.log4j.plugins.Receiver">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;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&nbsp;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&nbsp;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">&nbsp;</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/xml/LogFileXMLReceiver.html#LogFileXMLReceiver--">LogFileXMLReceiver</a></span>()</code>&nbsp;</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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/xml/LogFileXMLReceiver.html#activateOptions--">activateOptions</a></span>()</code>
<div class="block">Process the file</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/xml/LogFileXMLReceiver.html#getDecoder--">getDecoder</a></span>()</code>
<div class="block">Accessor</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/xml/LogFileXMLReceiver.html#getFileURL--">getFileURL</a></span>()</code>
<div class="block">Accessor</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/xml/LogFileXMLReceiver.html#getFilterExpression--">getFilterExpression</a></span>()</code>
<div class="block">Accessor</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/xml/LogFileXMLReceiver.html#isTailing--">isTailing</a></span>()</code>
<div class="block">Accessor</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/xml/LogFileXMLReceiver.html#isUseCurrentThread--">isUseCurrentThread</a></span>()</code>
<div class="block">When true, this property uses the current Thread to perform the import, otherwise when false
(the default), a new Thread is created and started to manage the import.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/xml/LogFileXMLReceiver.html#main-java.lang.String:A-">main</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)</code>&nbsp;</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/xml/LogFileXMLReceiver.html#setDecoder-java.lang.String-">setDecoder</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_decoder)</code>
<div class="block">Specify the class name implementing org.apache.log4j.spi.Decoder that can process the file.</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/xml/LogFileXMLReceiver.html#setFileURL-java.lang.String-">setFileURL</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fileURL)</code>
<div class="block">Specify the URL of the XML-formatted file to process.</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/xml/LogFileXMLReceiver.html#setFilterExpression-java.lang.String-">setFilterExpression</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filterExpression)</code>
<div class="block">Set the filter expression that will cause only events which pass the filter to be forwarded
to the log4j framework.</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/xml/LogFileXMLReceiver.html#setTailing-boolean-">setTailing</a></span>(boolean&nbsp;tailing)</code>
<div class="block">Set the 'tailing' flag - may only work on file:// URLs and may stop tailing if the writing
process closes the file and reopens.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/xml/LogFileXMLReceiver.html#setUseCurrentThread-boolean-">setUseCurrentThread</a></span>(boolean&nbsp;useCurrentThread)</code>
<div class="block">Sets whether the current Thread or a new Thread is created to perform the import, the default
being false (new Thread created).</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/xml/LogFileXMLReceiver.html#shutdown--">shutdown</a></span>()</code>
<div class="block">Close the receiver, release any resources that are accessing the file.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.plugins.Receiver">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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&nbsp;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&nbsp;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&nbsp;java.lang.<a href="http://docs.oracle.com/javase/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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="LogFileXMLReceiver--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LogFileXMLReceiver</h4>
<pre>public&nbsp;LogFileXMLReceiver()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getFileURL--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFileURL</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getFileURL()</pre>
<div class="block">Accessor</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>file URL</dd>
</dl>
</li>
</ul>
<a name="setFileURL-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFileURL</h4>
<pre>public&nbsp;void&nbsp;setFileURL(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fileURL)</pre>
<div class="block">Specify the URL of the XML-formatted file to process.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fileURL</code> - </dd>
</dl>
</li>
</ul>
<a name="getDecoder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDecoder</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDecoder()</pre>
<div class="block">Accessor</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="setDecoder-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDecoder</h4>
<pre>public&nbsp;void&nbsp;setDecoder(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_decoder)</pre>
<div class="block">Specify the class name implementing org.apache.log4j.spi.Decoder that can process the file.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>_decoder</code> - </dd>
</dl>
</li>
</ul>
<a name="getFilterExpression--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilterExpression</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getFilterExpression()</pre>
<div class="block">Accessor</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>filter expression</dd>
</dl>
</li>
</ul>
<a name="isTailing--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTailing</h4>
<pre>public&nbsp;boolean&nbsp;isTailing()</pre>
<div class="block">Accessor</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>tailing flag</dd>
</dl>
</li>
</ul>
<a name="setTailing-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTailing</h4>
<pre>public&nbsp;void&nbsp;setTailing(boolean&nbsp;tailing)</pre>
<div class="block">Set the 'tailing' flag - may only work on file:// URLs and may stop tailing if the writing
process closes the file and reopens.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tailing</code> - </dd>
</dl>
</li>
</ul>
<a name="setFilterExpression-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFilterExpression</h4>
<pre>public&nbsp;void&nbsp;setFilterExpression(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filterExpression)</pre>
<div class="block">Set the filter expression that will cause only events which pass the filter to be forwarded
to the log4j framework.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filterExpression</code> - </dd>
</dl>
</li>
</ul>
<a name="main-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>main</h4>
<pre>public static&nbsp;void&nbsp;main(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)</pre>
</li>
</ul>
<a name="shutdown--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shutdown</h4>
<pre>public&nbsp;void&nbsp;shutdown()</pre>
<div class="block">Close the receiver, release any resources that are accessing the file.</div>
</li>
</ul>
<a name="activateOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>activateOptions</h4>
<pre>public&nbsp;void&nbsp;activateOptions()</pre>
<div class="block">Process the file</div>
</li>
</ul>
<a name="isUseCurrentThread--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUseCurrentThread</h4>
<pre>public final&nbsp;boolean&nbsp;isUseCurrentThread()</pre>
<div class="block">When true, this property uses the current Thread to perform the import, otherwise when false
(the default), a new Thread is created and started to manage the import.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="setUseCurrentThread-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setUseCurrentThread</h4>
<pre>public final&nbsp;void&nbsp;setUseCurrentThread(boolean&nbsp;useCurrentThread)</pre>
<div class="block">Sets whether the current Thread or a new Thread is created to perform the import, the default
being false (new Thread created).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>useCurrentThread</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/LogFileXMLReceiver.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&nbsp;Class</li>
<li><a href="../../../../org/apache/log4j/xml/UtilLoggingEntityResolver.html" title="class in org.apache.log4j.xml"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/log4j/xml/LogFileXMLReceiver.html" target="_top">Frames</a></li>
<li><a href="LogFileXMLReceiver.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.log4j.plugins.Receiver">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2002-2018 <a href="https://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>