blob: 9d716750d9cd7702e864f9278742048001c9b712 [file] [log] [blame]
<!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:21 CEST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>JMSReceiver (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="JMSReceiver (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,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":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/JMSReceiver.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/AddressBased.html" title="interface in org.apache.log4j.net"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/log4j/net/JMSReceiverBeanInfo.html" title="class in org.apache.log4j.net"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/log4j/net/JMSReceiver.html" target="_top">Frames</a></li>
<li><a href="JMSReceiver.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="#field.summary">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><a href="#field.detail">Field</a>&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.net</div>
<h2 title="Class JMSReceiver" class="title">Class JMSReceiver</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>org.apache.log4j.net.JMSReceiver</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>javax.jms.MessageListener, <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">JMSReceiver</span>
extends <a href="../../../../org/apache/log4j/plugins/Receiver.html" title="class in org.apache.log4j.plugins">Receiver</a>
implements javax.jms.MessageListener</pre>
<div class="block">JMSReceiver receives a remote logging event on a configured
JSM topic and "posts" it to a LoggerRepository as if the event was
generated locally. This class is designed to receive events from
the JMSAppender class (or classes that send compatible events).
<p>Once the event has been "posted", it will be handled by the
appenders currently configured in the LoggerRespository.
<p>This implementation borrows heavily from the JMSSink
implementation.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Mark Womack, Paul Smith, Stephen Pain</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">&nbsp;</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/1.4.2/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/JMSReceiver.html#jndiPath">jndiPath</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.4.2/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/JMSReceiver.html#password">password</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected javax.jms.TopicConnection</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSReceiver.html#topicConnection">topicConnection</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.4.2/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/JMSReceiver.html#topicFactoryName">topicFactoryName</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.4.2/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/JMSReceiver.html#topicName">topicName</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.4.2/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/JMSReceiver.html#userId">userId</a></span></code>&nbsp;</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&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#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/net/JMSReceiver.html#JMSReceiver--">JMSReceiver</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSReceiver.html#JMSReceiver-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">JMSReceiver</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_topicFactoryName,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_topicName,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_userId,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_password,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_jndiPath)</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="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/net/JMSReceiver.html#activateOptions--">activateOptions</a></span>()</code>
<div class="block">Starts the JMSReceiver with the current options.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/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/JMSReceiver.html#getJndiPath--">getJndiPath</a></span>()</code>
<div class="block">Gets the path to a properties file containing
the initial context and jndi provider url</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/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/JMSReceiver.html#getPassword--">getPassword</a></span>()</code>
<div class="block">Gets the curernt password property.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/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/JMSReceiver.html#getTopicFactoryName--">getTopicFactoryName</a></span>()</code>
<div class="block">Gets the curernt JMS topic factory name property.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/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/JMSReceiver.html#getTopicName--">getTopicName</a></span>()</code>
<div class="block">Gets the curernt JMS topic name property.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/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/JMSReceiver.html#getUserId--">getUserId</a></span>()</code>
<div class="block">Gets the current user id property.</div>
</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/JMSReceiver.html#isActive--">isActive</a></span>()</code>
<div class="block">Returns true if this receiver is active.</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/JMSReceiver.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>&nbsp;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="i8" class="altColor">
<td class="colFirst"><code>protected <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSReceiver.html#lookup-javax.naming.Context-java.lang.String-">lookup</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/javax/naming/Context.html?is-external=true" title="class or interface in javax.naming">Context</a>&nbsp;ctx,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>&nbsp;</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/net/JMSReceiver.html#onMessage-javax.jms.Message-">onMessage</a></span>(javax.jms.Message&nbsp;message)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSReceiver.html#setActive-boolean-">setActive</a></span>(boolean&nbsp;_active)</code>
<div class="block">Sets the flag to indicate if receiver is active or not.</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/net/JMSReceiver.html#setJndiPath-java.lang.String-">setJndiPath</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_jndiPath)</code>
<div class="block">Sets the path to a properties file containing
the initial context and jndi provider url</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/JMSReceiver.html#setPassword-java.lang.String-">setPassword</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_password)</code>
<div class="block">Sets the password to use when creating the
JMS connection.</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/JMSReceiver.html#setTopicFactoryName-java.lang.String-">setTopicFactoryName</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_topicFactoryName)</code>
<div class="block">Sets the JMS topic factory name to use when creating the
JMS connection.</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/JMSReceiver.html#setTopicName-java.lang.String-">setTopicName</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_topicName)</code>
<div class="block">Sets the JMS topic name to use when creating the
JMS connection.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSReceiver.html#setUserId-java.lang.String-">setUserId</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_userId)</code>
<div class="block">Sets the user id to use when creating the
JMS connection.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSReceiver.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&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#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/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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="topicFactoryName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>topicFactoryName</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topicFactoryName</pre>
</li>
</ul>
<a name="topicName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>topicName</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topicName</pre>
</li>
</ul>
<a name="userId">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>userId</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> userId</pre>
</li>
</ul>
<a name="password">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>password</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password</pre>
</li>
</ul>
<a name="topicConnection">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>topicConnection</h4>
<pre>protected&nbsp;javax.jms.TopicConnection topicConnection</pre>
</li>
</ul>
<a name="jndiPath">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>jndiPath</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> jndiPath</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JMSReceiver--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JMSReceiver</h4>
<pre>public&nbsp;JMSReceiver()</pre>
</li>
</ul>
<a name="JMSReceiver-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JMSReceiver</h4>
<pre>public&nbsp;JMSReceiver(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_topicFactoryName,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_topicName,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_userId,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_password,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_jndiPath)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setJndiPath-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setJndiPath</h4>
<pre>public&nbsp;void&nbsp;setJndiPath(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_jndiPath)</pre>
<div class="block">Sets the path to a properties file containing
the initial context and jndi provider url</div>
</li>
</ul>
<a name="getJndiPath--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJndiPath</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getJndiPath()</pre>
<div class="block">Gets the path to a properties file containing
the initial context and jndi provider url</div>
</li>
</ul>
<a name="setTopicFactoryName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTopicFactoryName</h4>
<pre>public&nbsp;void&nbsp;setTopicFactoryName(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_topicFactoryName)</pre>
<div class="block">Sets the JMS topic factory name to use when creating the
JMS connection.</div>
</li>
</ul>
<a name="getTopicFactoryName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTopicFactoryName</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getTopicFactoryName()</pre>
<div class="block">Gets the curernt JMS topic factory name property.</div>
</li>
</ul>
<a name="setTopicName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTopicName</h4>
<pre>public&nbsp;void&nbsp;setTopicName(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_topicName)</pre>
<div class="block">Sets the JMS topic name to use when creating the
JMS connection.</div>
</li>
</ul>
<a name="getTopicName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTopicName</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getTopicName()</pre>
<div class="block">Gets the curernt JMS topic name property.</div>
</li>
</ul>
<a name="setUserId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUserId</h4>
<pre>public&nbsp;void&nbsp;setUserId(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_userId)</pre>
<div class="block">Sets the user id to use when creating the
JMS connection.</div>
</li>
</ul>
<a name="getUserId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserId</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getUserId()</pre>
<div class="block">Gets the current user id property.</div>
</li>
</ul>
<a name="setPassword-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPassword</h4>
<pre>public&nbsp;void&nbsp;setPassword(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;_password)</pre>
<div class="block">Sets the password to use when creating the
JMS connection.</div>
</li>
</ul>
<a name="getPassword--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPassword</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getPassword()</pre>
<div class="block">Gets the curernt password property.</div>
</li>
</ul>
<a name="isEquivalent-org.apache.log4j.plugins.Plugin-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEquivalent</h4>
<pre>public&nbsp;boolean&nbsp;isEquivalent(<a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a>&nbsp;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>&nbsp;in interface&nbsp;<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>&nbsp;in class&nbsp;<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="isActive--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isActive</h4>
<pre>public&nbsp;boolean&nbsp;isActive()</pre>
<div class="block">Returns true if this receiver is active.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/log4j/plugins/Plugin.html#isActive--">isActive</a></code>&nbsp;in interface&nbsp;<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#isActive--">isActive</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html" title="class in org.apache.log4j.plugins">PluginSkeleton</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true/false</dd>
</dl>
</li>
</ul>
<a name="setActive-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setActive</h4>
<pre>protected&nbsp;void&nbsp;setActive(boolean&nbsp;_active)</pre>
<div class="block">Sets the flag to indicate if receiver is active or not.</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">Starts the JMSReceiver with the current options.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>activateOptions</code>&nbsp;in interface&nbsp;<code>org.apache.log4j.spi.OptionHandler</code></dd>
</dl>
</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">Called when the receiver should be stopped.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/log4j/plugins/Plugin.html#shutdown--">shutdown</a></code>&nbsp;in interface&nbsp;<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="onMessage-javax.jms.Message-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onMessage</h4>
<pre>public&nbsp;void&nbsp;onMessage(javax.jms.Message&nbsp;message)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>onMessage</code>&nbsp;in interface&nbsp;<code>javax.jms.MessageListener</code></dd>
</dl>
</li>
</ul>
<a name="lookup-javax.naming.Context-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>lookup</h4>
<pre>protected&nbsp;<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>&nbsp;lookup(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/javax/naming/Context.html?is-external=true" title="class or interface in javax.naming">Context</a>&nbsp;ctx,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)
throws <a href="http://docs.oracle.com/javase/1.4.2/docs/api/javax/naming/NamingException.html?is-external=true" title="class or interface in javax.naming">NamingException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/javax/naming/NamingException.html?is-external=true" title="class or interface in javax.naming">NamingException</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/JMSReceiver.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/AddressBased.html" title="interface in org.apache.log4j.net"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/log4j/net/JMSReceiverBeanInfo.html" title="class in org.apache.log4j.net"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/log4j/net/JMSReceiver.html" target="_top">Frames</a></li>
<li><a href="JMSReceiver.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="#field.summary">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><a href="#field.detail">Field</a>&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-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>