Google Git
Sign in
apache / logging-log4j-site / d0d0de55986756593c08e5d2b8059541eacaf428 / . / log4j-2.0-alpha1-SNAPSHOT / log4j-core / xref / org / apache / logging / log4j / core / appender / JMSQueueAppender.html
blob: 7c9341489b0d3d5ea88023a8723d2b62ceb7b9c4 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>JMSQueueAppender xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/logging/log4j/core/appender/JMSQueueAppender.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache license, Version 2.0</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * limitations under the license.</em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.core.appender;
<a class="jxr_linenumber" name="18" href="#18">18</a>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.Filter;
<a class="jxr_linenumber" name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.Layout;
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.LogEvent;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.Plugin;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginAttr;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginElement;
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginFactory;
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.layout.SerializedLayout;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.net.JMSQueueManager;
<a class="jxr_linenumber" name="28" href="#28">28</a>
<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * Appender to write to a JMS Queue.</em>
<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="32" href="#32">32</a> @Plugin(name = <span class="jxr_string">"JMSQueue"</span>, type = <span class="jxr_string">"Core"</span>, elementType = <span class="jxr_string">"appender"</span>, printObject = <strong class="jxr_keyword">true</strong>)
<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/JMSQueueAppender.html">JMSQueueAppender</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/AppenderBase.html">AppenderBase</a> {
<a class="jxr_linenumber" name="34" href="#34">34</a>
<a class="jxr_linenumber" name="35" href="#35">35</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/net/JMSQueueManager.html">JMSQueueManager</a> manager;
<a class="jxr_linenumber" name="36" href="#36">36</a>
<a class="jxr_linenumber" name="37" href="#37">37</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/JMSQueueAppender.html">JMSQueueAppender</a>(String name, <a href="../../../../../../org/apache/logging/log4j/core/Filter.html">Filter</a> filter, <a href="../../../../../../org/apache/logging/log4j/core/Layout.html">Layout</a> layout, <a href="../../../../../../org/apache/logging/log4j/core/net/JMSQueueManager.html">JMSQueueManager</a> manager,
<a class="jxr_linenumber" name="38" href="#38">38</a> <strong class="jxr_keyword">boolean</strong> handleExceptions) {
<a class="jxr_linenumber" name="39" href="#39">39</a> <strong class="jxr_keyword">super</strong>(name, filter, layout, handleExceptions);
<a class="jxr_linenumber" name="40" href="#40">40</a> <strong class="jxr_keyword">this</strong>.manager = manager;
<a class="jxr_linenumber" name="41" href="#41">41</a> }
<a class="jxr_linenumber" name="42" href="#42">42</a>
<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * Actual writing occurs here.</em>
<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * @param event The LogEvent.</em>
<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="48" href="#48">48</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> append(<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event) {
<a class="jxr_linenumber" name="49" href="#49">49</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="50" href="#50">50</a> manager.send(getLayout().formatAs(event));
<a class="jxr_linenumber" name="51" href="#51">51</a> } <strong class="jxr_keyword">catch</strong> (Exception ex) {
<a class="jxr_linenumber" name="52" href="#52">52</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/AppenderRuntimeException.html">AppenderRuntimeException</a>(ex);
<a class="jxr_linenumber" name="53" href="#53">53</a> }
<a class="jxr_linenumber" name="54" href="#54">54</a> }
<a class="jxr_linenumber" name="55" href="#55">55</a>
<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * Create a JMSQueueAppender.</em>
<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * @param factoryName The fully qualified class name of the InitialContextFactory.</em>
<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * @param providerURL The URL of the provider to use.</em>
<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * @param urlPkgPrefixes A colon-separated list of package prefixes for the class name of the factory class that</em>
<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * will create a URL context factory</em>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @param securityPrincipalName The name of the identity of the Principal.</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @param securityCredentials The security credentials of the Principal.</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @param factoryBindingName The name to locate in the Context that provides the QueueConnectionFactory.</em>
<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * @param queueBindingName The name to use to locate the Queue.</em>
<a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * @param userName The userid to use to create the Queue Connection.</em>
<a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @param password The password to use to create the Queue Connection.</em>
<a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * @param layout The layout to use (defaults to SerlializedLayout).</em>
<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * @param filter The Filter or null.</em>
<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * @param suppress "true" if exceptions should be hidden from the application, "false" otherwise.</em>
<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * The default is "true".</em>
<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @return The JMSQueueAppender.</em>
<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="74" href="#74">74</a> @PluginFactory
<a class="jxr_linenumber" name="75" href="#75">75</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/JMSQueueAppender.html">JMSQueueAppender</a> createAppender(@PluginAttr(<span class="jxr_string">"factoryName"</span>) String factoryName,
<a class="jxr_linenumber" name="76" href="#76">76</a> @PluginAttr(<span class="jxr_string">"providerURL"</span>) String providerURL,
<a class="jxr_linenumber" name="77" href="#77">77</a> @PluginAttr(<span class="jxr_string">"urlPkgPrefixes"</span>) String urlPkgPrefixes,
<a class="jxr_linenumber" name="78" href="#78">78</a> @PluginAttr(<span class="jxr_string">"securityPrincipalName"</span>) String securityPrincipalName,
<a class="jxr_linenumber" name="79" href="#79">79</a> @PluginAttr(<span class="jxr_string">"securityCredentials"</span>) String securityCredentials,
<a class="jxr_linenumber" name="80" href="#80">80</a> @PluginAttr(<span class="jxr_string">"factoryBindingName"</span>) String factoryBindingName,
<a class="jxr_linenumber" name="81" href="#81">81</a> @PluginAttr(<span class="jxr_string">"queueBindingName"</span>) String queueBindingName,
<a class="jxr_linenumber" name="82" href="#82">82</a> @PluginAttr(<span class="jxr_string">"userName"</span>) String userName,
<a class="jxr_linenumber" name="83" href="#83">83</a> @PluginAttr(<span class="jxr_string">"password"</span>) String password,
<a class="jxr_linenumber" name="84" href="#84">84</a> @PluginElement(<span class="jxr_string">"layout"</span>) <a href="../../../../../../org/apache/logging/log4j/core/Layout.html">Layout</a> layout,
<a class="jxr_linenumber" name="85" href="#85">85</a> @PluginElement(<span class="jxr_string">"filter"</span>) <a href="../../../../../../org/apache/logging/log4j/core/Filter.html">Filter</a> filter,
<a class="jxr_linenumber" name="86" href="#86">86</a> @PluginAttr(<span class="jxr_string">"suppressExceptions"</span>) String suppress) {
<a class="jxr_linenumber" name="87" href="#87">87</a>
<a class="jxr_linenumber" name="88" href="#88">88</a> String name = <span class="jxr_string">"JMSQueue"</span> + factoryBindingName + <span class="jxr_string">"."</span> + queueBindingName;
<a class="jxr_linenumber" name="89" href="#89">89</a> <strong class="jxr_keyword">boolean</strong> handleExceptions = suppress == <strong class="jxr_keyword">null</strong> ? <strong class="jxr_keyword">true</strong> : Boolean.valueOf(suppress);
<a class="jxr_linenumber" name="90" href="#90">90</a> <a href="../../../../../../org/apache/logging/log4j/core/net/JMSQueueManager.html">JMSQueueManager</a> manager = JMSQueueManager.getJMSQueueManager(factoryName, providerURL, urlPkgPrefixes,
<a class="jxr_linenumber" name="91" href="#91">91</a> securityPrincipalName, securityCredentials, factoryBindingName, queueBindingName, userName, password);
<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">if</strong> (manager == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="93" href="#93">93</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="94" href="#94">94</a> }
<a class="jxr_linenumber" name="95" href="#95">95</a> <strong class="jxr_keyword">if</strong> (layout == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="96" href="#96">96</a> layout = SerializedLayout.createLayout();
<a class="jxr_linenumber" name="97" href="#97">97</a> }
<a class="jxr_linenumber" name="98" href="#98">98</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/JMSQueueAppender.html">JMSQueueAppender</a>(name, filter, layout, manager, handleExceptions);
<a class="jxr_linenumber" name="99" href="#99">99</a> }
<a class="jxr_linenumber" name="100" href="#100">100</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>