/usr/share/doc/liblog4j1.2-java/api/org/apache/log4j/net/JMSAppender.html is in liblog4j1.2-java-doc 1.2.17-7ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 | <!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_01-internal) on Mon Mar 07 15:34:17 UTC 2016 -->
<title>JMSAppender (Log4j Version 1.2.17)</title>
<meta name="date" content="2016-03-07">
<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="JMSAppender (Log4j Version 1.2.17)";
}
}
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,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":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/JMSAppender.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Log4j 1.2.17</b><!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the 'License'); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../org/apache/log4j/net/JMSSink.html" title="class in org.apache.log4j.net"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/log4j/net/JMSAppender.html" target="_top">Frames</a></li>
<li><a href="JMSAppender.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="#fields.inherited.from.class.org.apache.log4j.AppenderSkeleton">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.log4j.net</div>
<h2 title="Class JMSAppender" class="title">Class JMSAppender</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/log4j/AppenderSkeleton.html" title="class in org.apache.log4j">org.apache.log4j.AppenderSkeleton</a></li>
<li>
<ul class="inheritance">
<li>org.apache.log4j.net.JMSAppender</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/Appender.html" title="interface in org.apache.log4j">Appender</a>, <a href="../../../../org/apache/log4j/spi/OptionHandler.html" title="interface in org.apache.log4j.spi">OptionHandler</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">JMSAppender</span>
extends <a href="../../../../org/apache/log4j/AppenderSkeleton.html" title="class in org.apache.log4j">AppenderSkeleton</a></pre>
<div class="block">A simple appender that publishes events to a JMS Topic. The events
are serialized and transmitted as JMS message type <code>ObjectMessage</code>.
<p>JMS <code>topics</code> and <code>topic
connection factories</code> are administered objects that are retrieved
using JNDI messaging which in turn requires the retrieval of a JNDI
<code>Context</code>.
<p>There are two common methods for retrieving a JNDI <code>Context</code>. If a file resource named <em>jndi.properties</em> is
available to the JNDI API, it will use the information found
therein to retrieve an initial JNDI context. To obtain an initial
context, your code will simply call:
<pre>
InitialContext jndiContext = new InitialContext();
</pre>
<p>Calling the no-argument <code>InitialContext()</code> method
will also work from within Enterprise Java Beans (EJBs) because it
is part of the EJB contract for application servers to provide each
bean an environment naming context (ENC).
<p>In the second approach, several predetermined properties are set
and these properties are passed to the <code>InitialContext</code>
constructor to connect to the naming service provider. For example,
to connect to JBoss naming service one would write:
<pre>
Properties env = new Properties( );
env.put(Context.INITIAL_CONTEXT_FACTORY, "org.jnp.interfaces.NamingContextFactory");
env.put(Context.PROVIDER_URL, "jnp://hostname:1099");
env.put(Context.URL_PKG_PREFIXES, "org.jboss.naming:org.jnp.interfaces");
InitialContext jndiContext = new InitialContext(env);
</pre>
where <em>hostname</em> is the host where the JBoss application
server is running.
<p>To connect to the the naming service of Weblogic application
server one would write:
<pre>
Properties env = new Properties( );
env.put(Context.INITIAL_CONTEXT_FACTORY, "weblogic.jndi.WLInitialContextFactory");
env.put(Context.PROVIDER_URL, "t3://localhost:7001");
InitialContext jndiContext = new InitialContext(env);
</pre>
<p>Other JMS providers will obviously require different values.
The initial JNDI context can be obtained by calling the
no-argument <code>InitialContext()</code> method in EJBs. Only
clients running in a separate JVM need to be concerned about the
<em>jndi.properties</em> file and calling <code>InitialContext.InitialContext()</code> or alternatively correctly
setting the different properties before calling <code>InitialContext.InitialContext(java.util.Hashtable)</code> method.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Ceki Gülcü</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.AppenderSkeleton">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.log4j.<a href="../../../../org/apache/log4j/AppenderSkeleton.html" title="class in org.apache.log4j">AppenderSkeleton</a></h3>
<code><a href="../../../../org/apache/log4j/AppenderSkeleton.html#closed">closed</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#errorHandler">errorHandler</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#headFilter">headFilter</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#layout">layout</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#name">name</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#tailFilter">tailFilter</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#threshold">threshold</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/JMSAppender.html#JMSAppender--">JMSAppender</a></span>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#activateOptions--">activateOptions</a></span>()</code>
<div class="block">Options are activated and become effective only after calling
this method.</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/JMSAppender.html#append-org.apache.log4j.spi.LoggingEvent-">append</a></span>(<a href="../../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi">LoggingEvent</a> event)</code>
<div class="block">This method called by <a href="../../../../org/apache/log4j/AppenderSkeleton.html#doAppend-org.apache.log4j.spi.LoggingEvent-"><code>AppenderSkeleton.doAppend(org.apache.log4j.spi.LoggingEvent)</code></a> method to
do most of the real appending work.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#checkEntryConditions--">checkEntryConditions</a></span>()</code> </td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#close--">close</a></span>()</code>
<div class="block">Close this JMSAppender.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#getInitialContextFactoryName--">getInitialContextFactoryName</a></span>()</code>
<div class="block">Returns the value of the <b>InitialContextFactoryName</b> option.</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/net/JMSAppender.html#getLocationInfo--">getLocationInfo</a></span>()</code>
<div class="block">Returns value of the <b>LocationInfo</b> property which
determines whether location (stack) info is sent to the remote
subscriber.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#getPassword--">getPassword</a></span>()</code> </td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#getProviderURL--">getProviderURL</a></span>()</code> </td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#getSecurityCredentials--">getSecurityCredentials</a></span>()</code> </td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#getSecurityPrincipalName--">getSecurityPrincipalName</a></span>()</code> </td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#getTopicBindingName--">getTopicBindingName</a></span>()</code>
<div class="block">Returns the value of the <b>TopicBindingName</b> option.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected TopicConnection</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#getTopicConnection--">getTopicConnection</a></span>()</code>
<div class="block">Returns the TopicConnection used for this appender.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#getTopicConnectionFactoryBindingName--">getTopicConnectionFactoryBindingName</a></span>()</code>
<div class="block">Returns the value of the <b>TopicConnectionFactoryBindingName</b> option.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected TopicPublisher</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#getTopicPublisher--">getTopicPublisher</a></span>()</code>
<div class="block">Returns the TopicPublisher used for this appender.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>protected TopicSession</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#getTopicSession--">getTopicSession</a></span>()</code>
<div class="block">Returns the TopicSession used for this appender.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#getUserName--">getUserName</a></span>()</code> </td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>protected java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#lookup-javax.naming.Context-java.lang.String-">lookup</a></span>(javax.naming.Context ctx,
java.lang.String name)</code> </td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#requiresLayout--">requiresLayout</a></span>()</code>
<div class="block">The JMSAppender sends serialized events and consequently does not
require a layout.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#setInitialContextFactoryName-java.lang.String-">setInitialContextFactoryName</a></span>(java.lang.String initialContextFactoryName)</code>
<div class="block">Setting the <b>InitialContextFactoryName</b> method will cause
this <code>JMSAppender</code> instance to use the <code>InitialContext.InitialContext(Hashtable)</code> method instead of the
no-argument constructor.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#setLocationInfo-boolean-">setLocationInfo</a></span>(boolean locationInfo)</code>
<div class="block">If true, the information sent to the remote subscriber will
include caller's location information.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#setPassword-java.lang.String-">setPassword</a></span>(java.lang.String password)</code>
<div class="block">The paswword to use when creating a topic session.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#setProviderURL-java.lang.String-">setProviderURL</a></span>(java.lang.String providerURL)</code> </td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#setSecurityCredentials-java.lang.String-">setSecurityCredentials</a></span>(java.lang.String securityCredentials)</code> </td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#setSecurityPrincipalName-java.lang.String-">setSecurityPrincipalName</a></span>(java.lang.String securityPrincipalName)</code> </td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#setTopicBindingName-java.lang.String-">setTopicBindingName</a></span>(java.lang.String topicBindingName)</code>
<div class="block">The <b>TopicBindingName</b> option takes a
string value.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#setTopicConnectionFactoryBindingName-java.lang.String-">setTopicConnectionFactoryBindingName</a></span>(java.lang.String tcfBindingName)</code>
<div class="block">The <b>TopicConnectionFactoryBindingName</b> option takes a
string value.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#setURLPkgPrefixes-java.lang.String-">setURLPkgPrefixes</a></span>(java.lang.String urlPkgPrefixes)</code> </td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/JMSAppender.html#setUserName-java.lang.String-">setUserName</a></span>(java.lang.String userName)</code>
<div class="block">The user name to use when <code>creating a topic session</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.AppenderSkeleton">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.log4j.<a href="../../../../org/apache/log4j/AppenderSkeleton.html" title="class in org.apache.log4j">AppenderSkeleton</a></h3>
<code><a href="../../../../org/apache/log4j/AppenderSkeleton.html#addFilter-org.apache.log4j.spi.Filter-">addFilter</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#clearFilters--">clearFilters</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#doAppend-org.apache.log4j.spi.LoggingEvent-">doAppend</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#finalize--">finalize</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#getErrorHandler--">getErrorHandler</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#getFilter--">getFilter</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#getFirstFilter--">getFirstFilter</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#getLayout--">getLayout</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#getName--">getName</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#getThreshold--">getThreshold</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#isAsSevereAsThreshold-org.apache.log4j.Priority-">isAsSevereAsThreshold</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#setErrorHandler-org.apache.log4j.spi.ErrorHandler-">setErrorHandler</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#setLayout-org.apache.log4j.Layout-">setLayout</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#setName-java.lang.String-">setName</a>, <a href="../../../../org/apache/log4j/AppenderSkeleton.html#setThreshold-org.apache.log4j.Priority-">setThreshold</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.Object</h3>
<code>clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JMSAppender--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JMSAppender</h4>
<pre>public JMSAppender()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setTopicConnectionFactoryBindingName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTopicConnectionFactoryBindingName</h4>
<pre>public void setTopicConnectionFactoryBindingName(java.lang.String tcfBindingName)</pre>
<div class="block">The <b>TopicConnectionFactoryBindingName</b> option takes a
string value. Its value will be used to lookup the appropriate
<code>TopicConnectionFactory</code> from the JNDI context.</div>
</li>
</ul>
<a name="getTopicConnectionFactoryBindingName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTopicConnectionFactoryBindingName</h4>
<pre>public java.lang.String getTopicConnectionFactoryBindingName()</pre>
<div class="block">Returns the value of the <b>TopicConnectionFactoryBindingName</b> option.</div>
</li>
</ul>
<a name="setTopicBindingName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTopicBindingName</h4>
<pre>public void setTopicBindingName(java.lang.String topicBindingName)</pre>
<div class="block">The <b>TopicBindingName</b> option takes a
string value. Its value will be used to lookup the appropriate
<code>Topic</code> from the JNDI context.</div>
</li>
</ul>
<a name="getTopicBindingName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTopicBindingName</h4>
<pre>public java.lang.String getTopicBindingName()</pre>
<div class="block">Returns the value of the <b>TopicBindingName</b> option.</div>
</li>
</ul>
<a name="getLocationInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocationInfo</h4>
<pre>public boolean getLocationInfo()</pre>
<div class="block">Returns value of the <b>LocationInfo</b> property which
determines whether location (stack) info is sent to the remote
subscriber.</div>
</li>
</ul>
<a name="activateOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>activateOptions</h4>
<pre>public void activateOptions()</pre>
<div class="block">Options are activated and become effective only after calling
this method.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/log4j/spi/OptionHandler.html#activateOptions--">activateOptions</a></code> in interface <code><a href="../../../../org/apache/log4j/spi/OptionHandler.html" title="interface in org.apache.log4j.spi">OptionHandler</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/apache/log4j/AppenderSkeleton.html#activateOptions--">activateOptions</a></code> in class <code><a href="../../../../org/apache/log4j/AppenderSkeleton.html" title="class in org.apache.log4j">AppenderSkeleton</a></code></dd>
</dl>
</li>
</ul>
<a name="lookup-javax.naming.Context-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lookup</h4>
<pre>protected java.lang.Object lookup(javax.naming.Context ctx,
java.lang.String name)
throws javax.naming.NamingException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.naming.NamingException</code></dd>
</dl>
</li>
</ul>
<a name="checkEntryConditions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkEntryConditions</h4>
<pre>protected boolean checkEntryConditions()</pre>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public void close()</pre>
<div class="block">Close this JMSAppender. Closing releases all resources used by the
appender. A closed appender cannot be re-opened.</div>
</li>
</ul>
<a name="append-org.apache.log4j.spi.LoggingEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre>public void append(<a href="../../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi">LoggingEvent</a> event)</pre>
<div class="block">This method called by <a href="../../../../org/apache/log4j/AppenderSkeleton.html#doAppend-org.apache.log4j.spi.LoggingEvent-"><code>AppenderSkeleton.doAppend(org.apache.log4j.spi.LoggingEvent)</code></a> method to
do most of the real appending work.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/log4j/AppenderSkeleton.html#append-org.apache.log4j.spi.LoggingEvent-">append</a></code> in class <code><a href="../../../../org/apache/log4j/AppenderSkeleton.html" title="class in org.apache.log4j">AppenderSkeleton</a></code></dd>
</dl>
</li>
</ul>
<a name="getInitialContextFactoryName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitialContextFactoryName</h4>
<pre>public java.lang.String getInitialContextFactoryName()</pre>
<div class="block">Returns the value of the <b>InitialContextFactoryName</b> option.
See <a href="../../../../org/apache/log4j/net/JMSAppender.html#setInitialContextFactoryName-java.lang.String-"><code>setInitialContextFactoryName(java.lang.String)</code></a> for more details on the
meaning of this option.</div>
</li>
</ul>
<a name="setInitialContextFactoryName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInitialContextFactoryName</h4>
<pre>public void setInitialContextFactoryName(java.lang.String initialContextFactoryName)</pre>
<div class="block">Setting the <b>InitialContextFactoryName</b> method will cause
this <code>JMSAppender</code> instance to use the <code>InitialContext.InitialContext(Hashtable)</code> method instead of the
no-argument constructor. If you set this option, you should also
at least set the <b>ProviderURL</b> option.
<p>See also <a href="../../../../org/apache/log4j/net/JMSAppender.html#setProviderURL-java.lang.String-"><code>setProviderURL(String)</code></a>.</div>
</li>
</ul>
<a name="getProviderURL--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProviderURL</h4>
<pre>public java.lang.String getProviderURL()</pre>
</li>
</ul>
<a name="setProviderURL-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProviderURL</h4>
<pre>public void setProviderURL(java.lang.String providerURL)</pre>
</li>
</ul>
<a name="setURLPkgPrefixes-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setURLPkgPrefixes</h4>
<pre>public void setURLPkgPrefixes(java.lang.String urlPkgPrefixes)</pre>
</li>
</ul>
<a name="getSecurityCredentials--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSecurityCredentials</h4>
<pre>public java.lang.String getSecurityCredentials()</pre>
</li>
</ul>
<a name="setSecurityCredentials-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSecurityCredentials</h4>
<pre>public void setSecurityCredentials(java.lang.String securityCredentials)</pre>
</li>
</ul>
<a name="getSecurityPrincipalName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSecurityPrincipalName</h4>
<pre>public java.lang.String getSecurityPrincipalName()</pre>
</li>
</ul>
<a name="setSecurityPrincipalName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSecurityPrincipalName</h4>
<pre>public void setSecurityPrincipalName(java.lang.String securityPrincipalName)</pre>
</li>
</ul>
<a name="getUserName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserName</h4>
<pre>public java.lang.String getUserName()</pre>
</li>
</ul>
<a name="setUserName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUserName</h4>
<pre>public void setUserName(java.lang.String userName)</pre>
<div class="block">The user name to use when <code>creating a topic session</code>. If you set this option, you should
also set the <b>Password</b> option. See <a href="../../../../org/apache/log4j/net/JMSAppender.html#setPassword-java.lang.String-"><code>setPassword(String)</code></a>.</div>
</li>
</ul>
<a name="getPassword--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPassword</h4>
<pre>public java.lang.String getPassword()</pre>
</li>
</ul>
<a name="setPassword-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPassword</h4>
<pre>public void setPassword(java.lang.String password)</pre>
<div class="block">The paswword to use when creating a topic session.</div>
</li>
</ul>
<a name="setLocationInfo-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLocationInfo</h4>
<pre>public void setLocationInfo(boolean locationInfo)</pre>
<div class="block">If true, the information sent to the remote subscriber will
include caller's location information. By default no location
information is sent to the subscriber.</div>
</li>
</ul>
<a name="getTopicConnection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTopicConnection</h4>
<pre>protected TopicConnection getTopicConnection()</pre>
<div class="block">Returns the TopicConnection used for this appender. Only valid after
activateOptions() method has been invoked.</div>
</li>
</ul>
<a name="getTopicSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTopicSession</h4>
<pre>protected TopicSession getTopicSession()</pre>
<div class="block">Returns the TopicSession used for this appender. Only valid after
activateOptions() method has been invoked.</div>
</li>
</ul>
<a name="getTopicPublisher--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTopicPublisher</h4>
<pre>protected TopicPublisher getTopicPublisher()</pre>
<div class="block">Returns the TopicPublisher used for this appender. Only valid after
activateOptions() method has been invoked.</div>
</li>
</ul>
<a name="requiresLayout--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>requiresLayout</h4>
<pre>public boolean requiresLayout()</pre>
<div class="block">The JMSAppender sends serialized events and consequently does not
require a layout.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/JMSAppender.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Log4j 1.2.17</b><!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the 'License'); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../org/apache/log4j/net/JMSSink.html" title="class in org.apache.log4j.net"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/log4j/net/JMSAppender.html" target="_top">Frames</a></li>
<li><a href="JMSAppender.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="#fields.inherited.from.class.org.apache.log4j.AppenderSkeleton">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright 2000-2007 Apache Software Foundation.</small></p>
</body>
</html>
|