blob: f339354e9cc6963561bd5caade59822360225713 [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.util;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.File;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.net.InetAddress;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.net.MalformedURLException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.net.NetworkInterface;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.net.SocketException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.net.URI;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.net.URISyntaxException;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.net.URL;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.net.UnknownHostException;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.Arrays;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.Enumeration;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.Logger;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>/**<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Networking-related convenience methods.<a name="line.35"></a>
<span class="sourceLineNo">036</span> */<a name="line.36"></a>
<span class="sourceLineNo">037</span>public final class NetUtils {<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.39"></a>
<span class="sourceLineNo">040</span> private static final String UNKNOWN_LOCALHOST = "UNKNOWN_LOCALHOST";<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> private NetUtils() {<a name="line.42"></a>
<span class="sourceLineNo">043</span> // empty<a name="line.43"></a>
<span class="sourceLineNo">044</span> }<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> /**<a name="line.46"></a>
<span class="sourceLineNo">047</span> * This method gets the network name of the machine we are running on. Returns "UNKNOWN_LOCALHOST" in the unlikely<a name="line.47"></a>
<span class="sourceLineNo">048</span> * case where the host name cannot be found.<a name="line.48"></a>
<span class="sourceLineNo">049</span> *<a name="line.49"></a>
<span class="sourceLineNo">050</span> * @return String the name of the local host<a name="line.50"></a>
<span class="sourceLineNo">051</span> */<a name="line.51"></a>
<span class="sourceLineNo">052</span> public static String getLocalHostname() {<a name="line.52"></a>
<span class="sourceLineNo">053</span> try {<a name="line.53"></a>
<span class="sourceLineNo">054</span> final InetAddress addr = InetAddress.getLocalHost();<a name="line.54"></a>
<span class="sourceLineNo">055</span> return addr.getHostName();<a name="line.55"></a>
<span class="sourceLineNo">056</span> } catch (final UnknownHostException uhe) {<a name="line.56"></a>
<span class="sourceLineNo">057</span> try {<a name="line.57"></a>
<span class="sourceLineNo">058</span> final Enumeration&lt;NetworkInterface&gt; interfaces = NetworkInterface.getNetworkInterfaces();<a name="line.58"></a>
<span class="sourceLineNo">059</span> while (interfaces.hasMoreElements()) {<a name="line.59"></a>
<span class="sourceLineNo">060</span> final NetworkInterface nic = interfaces.nextElement();<a name="line.60"></a>
<span class="sourceLineNo">061</span> final Enumeration&lt;InetAddress&gt; addresses = nic.getInetAddresses();<a name="line.61"></a>
<span class="sourceLineNo">062</span> while (addresses.hasMoreElements()) {<a name="line.62"></a>
<span class="sourceLineNo">063</span> final InetAddress address = addresses.nextElement();<a name="line.63"></a>
<span class="sourceLineNo">064</span> if (!address.isLoopbackAddress()) {<a name="line.64"></a>
<span class="sourceLineNo">065</span> final String hostname = address.getHostName();<a name="line.65"></a>
<span class="sourceLineNo">066</span> if (hostname != null) {<a name="line.66"></a>
<span class="sourceLineNo">067</span> return hostname;<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span> }<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> } catch (final SocketException se) {<a name="line.72"></a>
<span class="sourceLineNo">073</span> LOGGER.error("Could not determine local host name", uhe);<a name="line.73"></a>
<span class="sourceLineNo">074</span> return UNKNOWN_LOCALHOST;<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span> LOGGER.error("Could not determine local host name", uhe);<a name="line.76"></a>
<span class="sourceLineNo">077</span> return UNKNOWN_LOCALHOST;<a name="line.77"></a>
<span class="sourceLineNo">078</span> }<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> /**<a name="line.81"></a>
<span class="sourceLineNo">082</span> * Returns the local network interface's MAC address if possible. The local network interface is defined here as<a name="line.82"></a>
<span class="sourceLineNo">083</span> * the {@link java.net.NetworkInterface} that is both up and not a loopback interface.<a name="line.83"></a>
<span class="sourceLineNo">084</span> *<a name="line.84"></a>
<span class="sourceLineNo">085</span> * @return the MAC address of the local network interface or {@code null} if no MAC address could be determined.<a name="line.85"></a>
<span class="sourceLineNo">086</span> */<a name="line.86"></a>
<span class="sourceLineNo">087</span> public static byte[] getMacAddress() {<a name="line.87"></a>
<span class="sourceLineNo">088</span> byte[] mac = null;<a name="line.88"></a>
<span class="sourceLineNo">089</span> try {<a name="line.89"></a>
<span class="sourceLineNo">090</span> final InetAddress localHost = InetAddress.getLocalHost();<a name="line.90"></a>
<span class="sourceLineNo">091</span> try {<a name="line.91"></a>
<span class="sourceLineNo">092</span> final NetworkInterface localInterface = NetworkInterface.getByInetAddress(localHost);<a name="line.92"></a>
<span class="sourceLineNo">093</span> if (isUpAndNotLoopback(localInterface)) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> mac = localInterface.getHardwareAddress();<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span> if (mac == null) {<a name="line.96"></a>
<span class="sourceLineNo">097</span> final Enumeration&lt;NetworkInterface&gt; networkInterfaces = NetworkInterface.getNetworkInterfaces();<a name="line.97"></a>
<span class="sourceLineNo">098</span> while (networkInterfaces.hasMoreElements() &amp;&amp; mac == null) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> final NetworkInterface nic = networkInterfaces.nextElement();<a name="line.99"></a>
<span class="sourceLineNo">100</span> if (isUpAndNotLoopback(nic)) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> mac = nic.getHardwareAddress();<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<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> } catch (final SocketException e) {<a name="line.105"></a>
<span class="sourceLineNo">106</span> LOGGER.catching(e);<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span> if (mac == null || mac.length == 0) {<a name="line.108"></a>
<span class="sourceLineNo">109</span> // Emulate a mac address with an IP v4 or v6<a name="line.109"></a>
<span class="sourceLineNo">110</span> final byte[] address = localHost.getAddress();<a name="line.110"></a>
<span class="sourceLineNo">111</span> // Take only 6 bytes if the address is an IPv6 otherwise will pad with two zero bytes<a name="line.111"></a>
<span class="sourceLineNo">112</span> mac = Arrays.copyOf(address, 6);<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span> } catch (final UnknownHostException ignored) {<a name="line.114"></a>
<span class="sourceLineNo">115</span> // ignored<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span> return mac;<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> /**<a name="line.120"></a>
<span class="sourceLineNo">121</span> * Returns the mac address, if it is available, as a string with each byte separated by a ":" character.<a name="line.121"></a>
<span class="sourceLineNo">122</span> * @return the mac address String or null.<a name="line.122"></a>
<span class="sourceLineNo">123</span> */<a name="line.123"></a>
<span class="sourceLineNo">124</span> public static String getMacAddressString() {<a name="line.124"></a>
<span class="sourceLineNo">125</span> final byte[] macAddr = getMacAddress();<a name="line.125"></a>
<span class="sourceLineNo">126</span> if (macAddr != null &amp;&amp; macAddr.length &gt; 0) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> StringBuilder sb = new StringBuilder(String.format("%02x", macAddr[0]));<a name="line.127"></a>
<span class="sourceLineNo">128</span> for (int i = 1; i &lt; macAddr.length; ++i) {<a name="line.128"></a>
<span class="sourceLineNo">129</span> sb.append(":").append(String.format("%02x", macAddr[i]));<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<a name="line.130"></a>
<span class="sourceLineNo">131</span> return sb.toString();<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span> }<a name="line.133"></a>
<span class="sourceLineNo">134</span> return null;<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span> private static boolean isUpAndNotLoopback(final NetworkInterface ni) throws SocketException {<a name="line.137"></a>
<span class="sourceLineNo">138</span> return ni != null &amp;&amp; !ni.isLoopback() &amp;&amp; ni.isUp();<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> /**<a name="line.141"></a>
<span class="sourceLineNo">142</span> * Converts a URI string or file path to a URI object.<a name="line.142"></a>
<span class="sourceLineNo">143</span> *<a name="line.143"></a>
<span class="sourceLineNo">144</span> * @param path the URI string or path<a name="line.144"></a>
<span class="sourceLineNo">145</span> * @return the URI object<a name="line.145"></a>
<span class="sourceLineNo">146</span> */<a name="line.146"></a>
<span class="sourceLineNo">147</span> public static URI toURI(final String path) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> try {<a name="line.148"></a>
<span class="sourceLineNo">149</span> // Resolves absolute URI<a name="line.149"></a>
<span class="sourceLineNo">150</span> return new URI(path);<a name="line.150"></a>
<span class="sourceLineNo">151</span> } catch (final URISyntaxException e) {<a name="line.151"></a>
<span class="sourceLineNo">152</span> // A file path or a Apache Commons VFS URL might contain blanks.<a name="line.152"></a>
<span class="sourceLineNo">153</span> // A file path may start with a driver letter<a name="line.153"></a>
<span class="sourceLineNo">154</span> try {<a name="line.154"></a>
<span class="sourceLineNo">155</span> final URL url = new URL(path);<a name="line.155"></a>
<span class="sourceLineNo">156</span> return new URI(url.getProtocol(), url.getHost(), url.getPath(), null);<a name="line.156"></a>
<span class="sourceLineNo">157</span> } catch (MalformedURLException | URISyntaxException nestedEx) {<a name="line.157"></a>
<span class="sourceLineNo">158</span> return new File(path).toURI();<a name="line.158"></a>
<span class="sourceLineNo">159</span> }<a name="line.159"></a>
<span class="sourceLineNo">160</span> }<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span>}<a name="line.163"></a>
</pre>
</div>
</body>
</html>