blob: 0d144ea576243f8d144b23b823174b132b31ea62 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT> *<a name="line.8"></a>
<FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT> *<a name="line.10"></a>
<FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT> * See the license for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT> * limitations under the license.<a name="line.15"></a>
<FONT color="green">016</FONT> */<a name="line.16"></a>
<FONT color="green">017</FONT> package org.apache.logging.log4j.core.appender;<a name="line.17"></a>
<FONT color="green">018</FONT> <a name="line.18"></a>
<FONT color="green">019</FONT> import org.apache.logging.log4j.core.Filter;<a name="line.19"></a>
<FONT color="green">020</FONT> import org.apache.logging.log4j.core.Layout;<a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.logging.log4j.core.LogEvent;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.logging.log4j.core.config.plugins.PluginAttr;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.logging.log4j.core.layout.SerializedLayout;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.logging.log4j.core.net.JMSQueueManager;<a name="line.27"></a>
<FONT color="green">028</FONT> <a name="line.28"></a>
<FONT color="green">029</FONT> /**<a name="line.29"></a>
<FONT color="green">030</FONT> * Appender to write to a JMS Queue.<a name="line.30"></a>
<FONT color="green">031</FONT> */<a name="line.31"></a>
<FONT color="green">032</FONT> @Plugin(name = "JMSQueue", type = "Core", elementType = "appender", printObject = true)<a name="line.32"></a>
<FONT color="green">033</FONT> public final class JMSQueueAppender extends AppenderBase {<a name="line.33"></a>
<FONT color="green">034</FONT> <a name="line.34"></a>
<FONT color="green">035</FONT> private final JMSQueueManager manager;<a name="line.35"></a>
<FONT color="green">036</FONT> <a name="line.36"></a>
<FONT color="green">037</FONT> private JMSQueueAppender(String name, Filter filter, Layout layout, JMSQueueManager manager,<a name="line.37"></a>
<FONT color="green">038</FONT> boolean handleExceptions) {<a name="line.38"></a>
<FONT color="green">039</FONT> super(name, filter, layout, handleExceptions);<a name="line.39"></a>
<FONT color="green">040</FONT> this.manager = manager;<a name="line.40"></a>
<FONT color="green">041</FONT> }<a name="line.41"></a>
<FONT color="green">042</FONT> <a name="line.42"></a>
<FONT color="green">043</FONT> /**<a name="line.43"></a>
<FONT color="green">044</FONT> * Actual writing occurs here.<a name="line.44"></a>
<FONT color="green">045</FONT> * &lt;p/&gt;<a name="line.45"></a>
<FONT color="green">046</FONT> * @param event The LogEvent.<a name="line.46"></a>
<FONT color="green">047</FONT> */<a name="line.47"></a>
<FONT color="green">048</FONT> public void append(LogEvent event) {<a name="line.48"></a>
<FONT color="green">049</FONT> try {<a name="line.49"></a>
<FONT color="green">050</FONT> manager.send(getLayout().formatAs(event));<a name="line.50"></a>
<FONT color="green">051</FONT> } catch (Exception ex) {<a name="line.51"></a>
<FONT color="green">052</FONT> throw new AppenderRuntimeException(ex);<a name="line.52"></a>
<FONT color="green">053</FONT> }<a name="line.53"></a>
<FONT color="green">054</FONT> }<a name="line.54"></a>
<FONT color="green">055</FONT> <a name="line.55"></a>
<FONT color="green">056</FONT> /**<a name="line.56"></a>
<FONT color="green">057</FONT> * Create a JMSQueueAppender.<a name="line.57"></a>
<FONT color="green">058</FONT> * @param factoryName The fully qualified class name of the InitialContextFactory.<a name="line.58"></a>
<FONT color="green">059</FONT> * @param providerURL The URL of the provider to use.<a name="line.59"></a>
<FONT color="green">060</FONT> * @param urlPkgPrefixes A colon-separated list of package prefixes for the class name of the factory class that<a name="line.60"></a>
<FONT color="green">061</FONT> * will create a URL context factory<a name="line.61"></a>
<FONT color="green">062</FONT> * @param securityPrincipalName The name of the identity of the Principal.<a name="line.62"></a>
<FONT color="green">063</FONT> * @param securityCredentials The security credentials of the Principal.<a name="line.63"></a>
<FONT color="green">064</FONT> * @param factoryBindingName The name to locate in the Context that provides the QueueConnectionFactory.<a name="line.64"></a>
<FONT color="green">065</FONT> * @param queueBindingName The name to use to locate the Queue.<a name="line.65"></a>
<FONT color="green">066</FONT> * @param userName The userid to use to create the Queue Connection.<a name="line.66"></a>
<FONT color="green">067</FONT> * @param password The password to use to create the Queue Connection.<a name="line.67"></a>
<FONT color="green">068</FONT> * @param layout The layout to use (defaults to SerlializedLayout).<a name="line.68"></a>
<FONT color="green">069</FONT> * @param filter The Filter or null.<a name="line.69"></a>
<FONT color="green">070</FONT> * @param suppress "true" if exceptions should be hidden from the application, "false" otherwise.<a name="line.70"></a>
<FONT color="green">071</FONT> * The default is "true".<a name="line.71"></a>
<FONT color="green">072</FONT> * @return The JMSQueueAppender.<a name="line.72"></a>
<FONT color="green">073</FONT> */<a name="line.73"></a>
<FONT color="green">074</FONT> @PluginFactory<a name="line.74"></a>
<FONT color="green">075</FONT> public static JMSQueueAppender createAppender(@PluginAttr("factoryName") String factoryName,<a name="line.75"></a>
<FONT color="green">076</FONT> @PluginAttr("providerURL") String providerURL,<a name="line.76"></a>
<FONT color="green">077</FONT> @PluginAttr("urlPkgPrefixes") String urlPkgPrefixes,<a name="line.77"></a>
<FONT color="green">078</FONT> @PluginAttr("securityPrincipalName") String securityPrincipalName,<a name="line.78"></a>
<FONT color="green">079</FONT> @PluginAttr("securityCredentials") String securityCredentials,<a name="line.79"></a>
<FONT color="green">080</FONT> @PluginAttr("factoryBindingName") String factoryBindingName,<a name="line.80"></a>
<FONT color="green">081</FONT> @PluginAttr("queueBindingName") String queueBindingName,<a name="line.81"></a>
<FONT color="green">082</FONT> @PluginAttr("userName") String userName,<a name="line.82"></a>
<FONT color="green">083</FONT> @PluginAttr("password") String password,<a name="line.83"></a>
<FONT color="green">084</FONT> @PluginElement("layout") Layout layout,<a name="line.84"></a>
<FONT color="green">085</FONT> @PluginElement("filter") Filter filter,<a name="line.85"></a>
<FONT color="green">086</FONT> @PluginAttr("suppressExceptions") String suppress) {<a name="line.86"></a>
<FONT color="green">087</FONT> <a name="line.87"></a>
<FONT color="green">088</FONT> String name = "JMSQueue" + factoryBindingName + "." + queueBindingName;<a name="line.88"></a>
<FONT color="green">089</FONT> boolean handleExceptions = suppress == null ? true : Boolean.valueOf(suppress);<a name="line.89"></a>
<FONT color="green">090</FONT> JMSQueueManager manager = JMSQueueManager.getJMSQueueManager(factoryName, providerURL, urlPkgPrefixes,<a name="line.90"></a>
<FONT color="green">091</FONT> securityPrincipalName, securityCredentials, factoryBindingName, queueBindingName, userName, password);<a name="line.91"></a>
<FONT color="green">092</FONT> if (manager == null) {<a name="line.92"></a>
<FONT color="green">093</FONT> return null;<a name="line.93"></a>
<FONT color="green">094</FONT> }<a name="line.94"></a>
<FONT color="green">095</FONT> if (layout == null) {<a name="line.95"></a>
<FONT color="green">096</FONT> layout = SerializedLayout.createLayout();<a name="line.96"></a>
<FONT color="green">097</FONT> }<a name="line.97"></a>
<FONT color="green">098</FONT> return new JMSQueueAppender(name, filter, layout, manager, handleExceptions);<a name="line.98"></a>
<FONT color="green">099</FONT> }<a name="line.99"></a>
<FONT color="green">100</FONT> }<a name="line.100"></a>
</PRE>
</BODY>
</HTML>