blob: eed003fb22e5b8c36383b43233fc654995bfdd08 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.net;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.OutputStream;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.Serializable;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.net.InetAddress;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.net.UnknownHostException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.HashMap;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Map;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.Layout;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.appender.ManagerFactory;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.util.Strings;<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>/**<a name="line.30"></a>
<span class="sourceLineNo">031</span> * Socket Manager for UDP connections.<a name="line.31"></a>
<span class="sourceLineNo">032</span> */<a name="line.32"></a>
<span class="sourceLineNo">033</span>public class DatagramSocketManager extends AbstractSocketManager {<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span> private static final DatagramSocketManagerFactory FACTORY = new DatagramSocketManagerFactory();<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> /**<a name="line.37"></a>
<span class="sourceLineNo">038</span> * The Constructor.<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @param name The unique name of the connection.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @param os The OutputStream.<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @param inetAddress<a name="line.41"></a>
<span class="sourceLineNo">042</span> * @param host The host to connect to.<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @param port The port on the host.<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @param layout The layout<a name="line.44"></a>
<span class="sourceLineNo">045</span> * @param bufferSize The buffer size<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span> protected DatagramSocketManager(final String name, final OutputStream os, final InetAddress inetAddress, final String host,<a name="line.47"></a>
<span class="sourceLineNo">048</span> final int port, final Layout&lt;? extends Serializable&gt; layout, final int bufferSize) {<a name="line.48"></a>
<span class="sourceLineNo">049</span> super(name, os, inetAddress, host, port, layout, true, bufferSize);<a name="line.49"></a>
<span class="sourceLineNo">050</span> }<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> /**<a name="line.52"></a>
<span class="sourceLineNo">053</span> * Obtain a SocketManager.<a name="line.53"></a>
<span class="sourceLineNo">054</span> * @param host The host to connect to.<a name="line.54"></a>
<span class="sourceLineNo">055</span> * @param port The port on the host.<a name="line.55"></a>
<span class="sourceLineNo">056</span> * @param layout The layout.<a name="line.56"></a>
<span class="sourceLineNo">057</span> * @param bufferSize The buffer size.<a name="line.57"></a>
<span class="sourceLineNo">058</span> * @return A DatagramSocketManager.<a name="line.58"></a>
<span class="sourceLineNo">059</span> */<a name="line.59"></a>
<span class="sourceLineNo">060</span> public static DatagramSocketManager getSocketManager(final String host, final int port,<a name="line.60"></a>
<span class="sourceLineNo">061</span> final Layout&lt;? extends Serializable&gt; layout, final int bufferSize) {<a name="line.61"></a>
<span class="sourceLineNo">062</span> if (Strings.isEmpty(host)) {<a name="line.62"></a>
<span class="sourceLineNo">063</span> throw new IllegalArgumentException("A host name is required");<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span> if (port &lt;= 0) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> throw new IllegalArgumentException("A port value is required");<a name="line.66"></a>
<span class="sourceLineNo">067</span> }<a name="line.67"></a>
<span class="sourceLineNo">068</span> return (DatagramSocketManager) getManager("UDP:" + host + ':' + port,<a name="line.68"></a>
<span class="sourceLineNo">069</span> new FactoryData(host, port, layout, bufferSize), FACTORY);<a name="line.69"></a>
<span class="sourceLineNo">070</span> }<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> /**<a name="line.72"></a>
<span class="sourceLineNo">073</span> * Gets this DatagramSocketManager's content format. Specified by:<a name="line.73"></a>
<span class="sourceLineNo">074</span> * &lt;ul&gt;<a name="line.74"></a>
<span class="sourceLineNo">075</span> * &lt;li&gt;Key: "protocol" Value: "udp"&lt;/li&gt;<a name="line.75"></a>
<span class="sourceLineNo">076</span> * &lt;li&gt;Key: "direction" Value: "out"&lt;/li&gt;<a name="line.76"></a>
<span class="sourceLineNo">077</span> * &lt;/ul&gt;<a name="line.77"></a>
<span class="sourceLineNo">078</span> *<a name="line.78"></a>
<span class="sourceLineNo">079</span> * @return Map of content format keys supporting DatagramSocketManager<a name="line.79"></a>
<span class="sourceLineNo">080</span> */<a name="line.80"></a>
<span class="sourceLineNo">081</span> @Override<a name="line.81"></a>
<span class="sourceLineNo">082</span> public Map&lt;String, String&gt; getContentFormat() {<a name="line.82"></a>
<span class="sourceLineNo">083</span> final Map&lt;String, String&gt; result = new HashMap&lt;&gt;(super.getContentFormat());<a name="line.83"></a>
<span class="sourceLineNo">084</span> result.put("protocol", "udp");<a name="line.84"></a>
<span class="sourceLineNo">085</span> result.put("direction", "out");<a name="line.85"></a>
<span class="sourceLineNo">086</span> return result;<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> /**<a name="line.89"></a>
<span class="sourceLineNo">090</span> * Data for the factory.<a name="line.90"></a>
<span class="sourceLineNo">091</span> */<a name="line.91"></a>
<span class="sourceLineNo">092</span> private static class FactoryData {<a name="line.92"></a>
<span class="sourceLineNo">093</span> private final String host;<a name="line.93"></a>
<span class="sourceLineNo">094</span> private final int port;<a name="line.94"></a>
<span class="sourceLineNo">095</span> private final Layout&lt;? extends Serializable&gt; layout;<a name="line.95"></a>
<span class="sourceLineNo">096</span> private final int bufferSize;<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> public FactoryData(final String host, final int port, final Layout&lt;? extends Serializable&gt; layout, final int bufferSize) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> this.host = host;<a name="line.99"></a>
<span class="sourceLineNo">100</span> this.port = port;<a name="line.100"></a>
<span class="sourceLineNo">101</span> this.layout = layout;<a name="line.101"></a>
<span class="sourceLineNo">102</span> this.bufferSize = bufferSize;<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> /**<a name="line.106"></a>
<span class="sourceLineNo">107</span> * Factory to create the DatagramSocketManager.<a name="line.107"></a>
<span class="sourceLineNo">108</span> */<a name="line.108"></a>
<span class="sourceLineNo">109</span> private static class DatagramSocketManagerFactory implements ManagerFactory&lt;DatagramSocketManager, FactoryData&gt; {<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> @Override<a name="line.111"></a>
<span class="sourceLineNo">112</span> public DatagramSocketManager createManager(final String name, final FactoryData data) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> InetAddress inetAddress;<a name="line.113"></a>
<span class="sourceLineNo">114</span> try {<a name="line.114"></a>
<span class="sourceLineNo">115</span> inetAddress = InetAddress.getByName(data.host);<a name="line.115"></a>
<span class="sourceLineNo">116</span> } catch (final UnknownHostException ex) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> LOGGER.error("Could not find address of " + data.host, ex);<a name="line.117"></a>
<span class="sourceLineNo">118</span> return null;<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span> final OutputStream os = new DatagramOutputStream(data.host, data.port, data.layout.getHeader(),<a name="line.120"></a>
<span class="sourceLineNo">121</span> data.layout.getFooter());<a name="line.121"></a>
<span class="sourceLineNo">122</span> return new DatagramSocketManager(name, os, inetAddress, data.host, data.port, data.layout, data.bufferSize);<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span>}<a name="line.125"></a>
</pre>
</div>
</body>
</html>