blob: 7eeff6eff07397bf92ff851cdbe1670a26706763 [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.util.HashMap;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Map;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.Layout;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.appender.OutputStreamManager;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * Abstract base class for managing sockets.<a name="line.29"></a>
<span class="sourceLineNo">030</span> */<a name="line.30"></a>
<span class="sourceLineNo">031</span>public abstract class AbstractSocketManager extends OutputStreamManager {<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span> /**<a name="line.33"></a>
<span class="sourceLineNo">034</span> * The Internet address of the host.<a name="line.34"></a>
<span class="sourceLineNo">035</span> */<a name="line.35"></a>
<span class="sourceLineNo">036</span> protected final InetAddress inetAddress;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span> /**<a name="line.38"></a>
<span class="sourceLineNo">039</span> * The name of the host.<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span> protected final String host;<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> /**<a name="line.43"></a>
<span class="sourceLineNo">044</span> * The port on the host.<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span> protected final int port;<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> /**<a name="line.48"></a>
<span class="sourceLineNo">049</span> * The Constructor.<a name="line.49"></a>
<span class="sourceLineNo">050</span> * @param name The unique name of this connection.<a name="line.50"></a>
<span class="sourceLineNo">051</span> * @param os The OutputStream to manage.<a name="line.51"></a>
<span class="sourceLineNo">052</span> * @param inetAddress The Internet address.<a name="line.52"></a>
<span class="sourceLineNo">053</span> * @param host The target host name.<a name="line.53"></a>
<span class="sourceLineNo">054</span> * @param port The target port number.<a name="line.54"></a>
<span class="sourceLineNo">055</span> * @param bufferSize The buffer size.<a name="line.55"></a>
<span class="sourceLineNo">056</span> */<a name="line.56"></a>
<span class="sourceLineNo">057</span> public AbstractSocketManager(final String name, final OutputStream os, final InetAddress inetAddress,<a name="line.57"></a>
<span class="sourceLineNo">058</span> final String host, final int port, final Layout&lt;? extends Serializable&gt; layout, final boolean writeHeader,<a name="line.58"></a>
<span class="sourceLineNo">059</span> final int bufferSize) {<a name="line.59"></a>
<span class="sourceLineNo">060</span> super(os, name, layout, writeHeader, bufferSize);<a name="line.60"></a>
<span class="sourceLineNo">061</span> this.inetAddress = inetAddress;<a name="line.61"></a>
<span class="sourceLineNo">062</span> this.host = host;<a name="line.62"></a>
<span class="sourceLineNo">063</span> this.port = port;<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> /**<a name="line.66"></a>
<span class="sourceLineNo">067</span> * Gets this AbstractSocketManager's content format. Specified by:<a name="line.67"></a>
<span class="sourceLineNo">068</span> * &lt;ul&gt;<a name="line.68"></a>
<span class="sourceLineNo">069</span> * &lt;li&gt;Key: "port" Value: provided "port" param&lt;/li&gt;<a name="line.69"></a>
<span class="sourceLineNo">070</span> * &lt;li&gt;Key: "address" Value: provided "address" param&lt;/li&gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span> * &lt;/ul&gt;<a name="line.71"></a>
<span class="sourceLineNo">072</span> *<a name="line.72"></a>
<span class="sourceLineNo">073</span> * @return Map of content format keys supporting AbstractSocketManager<a name="line.73"></a>
<span class="sourceLineNo">074</span> */<a name="line.74"></a>
<span class="sourceLineNo">075</span> @Override<a name="line.75"></a>
<span class="sourceLineNo">076</span> public Map&lt;String, String&gt; getContentFormat() {<a name="line.76"></a>
<span class="sourceLineNo">077</span> final Map&lt;String, String&gt; result = new HashMap&lt;&gt;(super.getContentFormat());<a name="line.77"></a>
<span class="sourceLineNo">078</span> result.put("port", Integer.toString(port));<a name="line.78"></a>
<span class="sourceLineNo">079</span> result.put("address", inetAddress.getHostAddress());<a name="line.79"></a>
<span class="sourceLineNo">080</span> return result;<a name="line.80"></a>
<span class="sourceLineNo">081</span> }<a name="line.81"></a>
<span class="sourceLineNo">082</span>}<a name="line.82"></a>
</pre>
</div>
</body>
</html>