| <!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>XMLSocketReceiver (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="XMLSocketReceiver (Apache Chainsaw 2.0.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":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/XMLSocketReceiver.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><a href="../../../../org/apache/log4j/net/XMLSocketNode.html" title="class in org.apache.log4j.net"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/log4j/net/XMLSocketReceiver.html" target="_top">Frames</a></li> |
| <li><a href="XMLSocketReceiver.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.net</div> |
| <h2 title="Class XMLSocketReceiver" class="title">Class XMLSocketReceiver</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.net.XMLSocketReceiver</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="http://docs.oracle.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>, <a href="../../../../org/apache/log4j/net/NetworkBased.html" title="interface in org.apache.log4j.net">NetworkBased</a>, <a href="../../../../org/apache/log4j/net/PortBased.html" title="interface in org.apache.log4j.net">PortBased</a>, <a href="../../../../org/apache/log4j/plugins/Pauseable.html" title="interface in org.apache.log4j.plugins">Pauseable</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">XMLSocketReceiver</span> |
| extends <a href="../../../../org/apache/log4j/plugins/Receiver.html" title="class in org.apache.log4j.plugins">Receiver</a> |
| implements <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>, <a href="../../../../org/apache/log4j/net/PortBased.html" title="interface in org.apache.log4j.net">PortBased</a>, <a href="../../../../org/apache/log4j/plugins/Pauseable.html" title="interface in org.apache.log4j.plugins">Pauseable</a></pre> |
| <div class="block">XMLSocketReceiver receives a remote logging event via XML on a configured |
| socket and "posts" it to a LoggerRepository as if the event were |
| generated locally. This class is designed to receive events from |
| the XMLSocketAppender class (or classes that send compatible events). |
| <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> |
| Once the event has been "posted", it will be handled by the |
| appenders currently configured in the LoggerRespository.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Mark Womack, Scott Deboy <sdeboy@apache.org></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>protected <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/net/XMLSocketReceiver.html#decoder">decoder</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/XMLSocketReceiver.html#DEFAULT_PORT">DEFAULT_PORT</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/XMLSocketReceiver.html#port">port</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/net/XMLSocketReceiver.html#ZONE">ZONE</a></span></code> |
| <div class="block">The MulticastDNS zone advertised by an XMLSocketReceiver</div> |
| </td> |
| </tr> |
| </table> |
| <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/net/XMLSocketReceiver.html#XMLSocketReceiver--">XMLSocketReceiver</a></span>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/XMLSocketReceiver.html#XMLSocketReceiver-int-">XMLSocketReceiver</a></span>(int _port)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/XMLSocketReceiver.html#XMLSocketReceiver-int-org.apache.log4j.spi.LoggerRepository-">XMLSocketReceiver</a></span>(int _port, |
| org.apache.log4j.spi.LoggerRepository _repository)</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/net/XMLSocketReceiver.html#activateOptions--">activateOptions</a></span>()</code> |
| <div class="block">Starts the SocketReceiver with the current options.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/XMLSocketReceiver.html#doPost-org.apache.log4j.spi.LoggingEvent-">doPost</a></span>(org.apache.log4j.spi.LoggingEvent event)</code> |
| <div class="block">Posts the logging event to a logger in the configured logger |
| repository.</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/net/XMLSocketReceiver.html#getDecoder--">getDecoder</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/XMLSocketReceiver.html#getPort--">getPort</a></span>()</code> |
| <div class="block">Get the port to receive logging events on.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/XMLSocketReceiver.html#hashCode--">hashCode</a></span>()</code> </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/net/XMLSocketReceiver.html#isAdvertiseViaMulticastDNS--">isAdvertiseViaMulticastDNS</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/XMLSocketReceiver.html#isEquivalent-org.apache.log4j.plugins.Plugin-">isEquivalent</a></span>(<a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a> testPlugin)</code> |
| <div class="block">Returns true if the receiver is the same class and they are |
| configured for the same properties, and super class also considers |
| them to be equivalent.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/XMLSocketReceiver.html#isPaused--">isPaused</a></span>()</code> |
| <div class="block">Get paused state.</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/net/XMLSocketReceiver.html#run--">run</a></span>()</code> |
| <div class="block">Loop, accepting new socket connections.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/XMLSocketReceiver.html#setActive-boolean-">setActive</a></span>(boolean b)</code> |
| <div class="block">Sets the flag to indicate if receiver is active or not.</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/net/XMLSocketReceiver.html#setAdvertiseViaMulticastDNS-boolean-">setAdvertiseViaMulticastDNS</a></span>(boolean advertiseViaMulticastDNS)</code> </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/net/XMLSocketReceiver.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> _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="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/XMLSocketReceiver.html#setPaused-boolean-">setPaused</a></span>(boolean b)</code> |
| <div class="block">Set paused state.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/XMLSocketReceiver.html#setPort-int-">setPort</a></span>(int _port)</code> |
| <div class="block">Set the port to receive logging events on.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/XMLSocketReceiver.html#shutdown--">shutdown</a></span>()</code> |
| <div class="block">Called when the receiver should be stopped.</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 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#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#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/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#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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.net.NetworkBased"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.log4j.net.<a href="../../../../org/apache/log4j/net/NetworkBased.html" title="interface in org.apache.log4j.net">NetworkBased</a></h3> |
| <code><a href="../../../../org/apache/log4j/net/NetworkBased.html#getName--">getName</a>, <a href="../../../../org/apache/log4j/net/NetworkBased.html#isActive--">isActive</a></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="decoder"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decoder</h4> |
| <pre>protected <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> decoder</pre> |
| </li> |
| </ul> |
| <a name="DEFAULT_PORT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_PORT</h4> |
| <pre>public static final int DEFAULT_PORT</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.log4j.net.XMLSocketReceiver.DEFAULT_PORT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="port"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>port</h4> |
| <pre>protected int port</pre> |
| </li> |
| </ul> |
| <a name="ZONE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ZONE</h4> |
| <pre>public static final <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> ZONE</pre> |
| <div class="block">The MulticastDNS zone advertised by an XMLSocketReceiver</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.log4j.net.XMLSocketReceiver.ZONE">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="XMLSocketReceiver--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>XMLSocketReceiver</h4> |
| <pre>public XMLSocketReceiver()</pre> |
| </li> |
| </ul> |
| <a name="XMLSocketReceiver-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>XMLSocketReceiver</h4> |
| <pre>public XMLSocketReceiver(int _port)</pre> |
| </li> |
| </ul> |
| <a name="XMLSocketReceiver-int-org.apache.log4j.spi.LoggerRepository-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>XMLSocketReceiver</h4> |
| <pre>public XMLSocketReceiver(int _port, |
| org.apache.log4j.spi.LoggerRepository _repository)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getPort--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPort</h4> |
| <pre>public int getPort()</pre> |
| <div class="block">Get the port to receive logging events on.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/net/PortBased.html#getPort--">getPort</a></code> in interface <code><a href="../../../../org/apache/log4j/net/PortBased.html" title="interface in org.apache.log4j.net">PortBased</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>int port number</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPort-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPort</h4> |
| <pre>public void setPort(int _port)</pre> |
| <div class="block">Set the port to receive logging events on.</div> |
| </li> |
| </ul> |
| <a name="getDecoder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDecoder</h4> |
| <pre>public <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> getDecoder()</pre> |
| </li> |
| </ul> |
| <a name="setDecoder-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDecoder</h4> |
| <pre>public void 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> _decoder)</pre> |
| <div class="block">Specify the class name implementing org.apache.log4j.spi.Decoder that can process the file.</div> |
| </li> |
| </ul> |
| <a name="isPaused--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPaused</h4> |
| <pre>public boolean isPaused()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/log4j/plugins/Pauseable.html#isPaused--">Pauseable</a></code></span></div> |
| <div class="block">Get paused state.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/plugins/Pauseable.html#isPaused--">isPaused</a></code> in interface <code><a href="../../../../org/apache/log4j/plugins/Pauseable.html" title="interface in org.apache.log4j.plugins">Pauseable</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>paused state.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPaused-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPaused</h4> |
| <pre>public void setPaused(boolean b)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/log4j/plugins/Pauseable.html#setPaused-boolean-">Pauseable</a></code></span></div> |
| <div class="block">Set paused state.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/plugins/Pauseable.html#setPaused-boolean-">setPaused</a></code> in interface <code><a href="../../../../org/apache/log4j/plugins/Pauseable.html" title="interface in org.apache.log4j.plugins">Pauseable</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>b</code> - new value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isEquivalent-org.apache.log4j.plugins.Plugin-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEquivalent</h4> |
| <pre>public boolean isEquivalent(<a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a> testPlugin)</pre> |
| <div class="block">Returns true if the receiver is the same class and they are |
| configured for the same properties, and super class also considers |
| them to be equivalent. This is used by PluginRegistry when determining |
| if the a similarly configured receiver is being started.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/plugins/Plugin.html#isEquivalent-org.apache.log4j.plugins.Plugin-">isEquivalent</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/plugins/PluginSkeleton.html#isEquivalent-org.apache.log4j.plugins.Plugin-">isEquivalent</a></code> in class <code><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html" title="class in org.apache.log4j.plugins">PluginSkeleton</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>testPlugin</code> - The plugin to test equivalency against.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean True if the testPlugin is equivalent to this plugin.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hashCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setActive-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setActive</h4> |
| <pre>protected void setActive(boolean b)</pre> |
| <div class="block">Sets the flag to indicate if receiver is active or not.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>b</code> - new value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="activateOptions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>activateOptions</h4> |
| <pre>public void activateOptions()</pre> |
| <div class="block">Starts the SocketReceiver with the current options.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>activateOptions</code> in interface <code>org.apache.log4j.spi.OptionHandler</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAdvertiseViaMulticastDNS-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAdvertiseViaMulticastDNS</h4> |
| <pre>public void setAdvertiseViaMulticastDNS(boolean advertiseViaMulticastDNS)</pre> |
| </li> |
| </ul> |
| <a name="isAdvertiseViaMulticastDNS--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAdvertiseViaMulticastDNS</h4> |
| <pre>public boolean isAdvertiseViaMulticastDNS()</pre> |
| </li> |
| </ul> |
| <a name="shutdown--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shutdown</h4> |
| <pre>public void shutdown()</pre> |
| <div class="block">Called when the receiver should be stopped. Closes the |
| server socket and all of the open sockets.</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> |
| </dl> |
| </li> |
| </ul> |
| <a name="run--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>run</h4> |
| <pre>public void run()</pre> |
| <div class="block">Loop, accepting new socket connections.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true#run--" title="class or interface in java.lang">run</a></code> in interface <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="doPost-org.apache.log4j.spi.LoggingEvent-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>doPost</h4> |
| <pre>public void doPost(org.apache.log4j.spi.LoggingEvent event)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/log4j/plugins/Receiver.html#doPost-org.apache.log4j.spi.LoggingEvent-">Receiver</a></code></span></div> |
| <div class="block">Posts the logging event to a logger in the configured logger |
| repository.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/plugins/Receiver.html#doPost-org.apache.log4j.spi.LoggingEvent-">doPost</a></code> in class <code><a href="../../../../org/apache/log4j/plugins/Receiver.html" title="class in org.apache.log4j.plugins">Receiver</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - the log event to post to the local log4j environment.</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/XMLSocketReceiver.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><a href="../../../../org/apache/log4j/net/XMLSocketNode.html" title="class in org.apache.log4j.net"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/log4j/net/XMLSocketReceiver.html" target="_top">Frames</a></li> |
| <li><a href="XMLSocketReceiver.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><p align="center">Copyright © 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> |