Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.2 / log4j-core / apidocs / src-html / org / apache / logging / log4j / core / net / MulticastDnsAdvertiser.html
blob: c8add8b7c0fe7a8feff6c16ab78360fa67791eef [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.lang.reflect.InvocationTargetException;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.lang.reflect.Method;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.HashMap;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Hashtable;<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.Logger;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.Core;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.util.Integers;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.util.LoaderUtil;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>/**<a name="line.32"></a>
<span class="sourceLineNo">033</span> * Advertise an entity via ZeroConf/MulticastDNS and the JmDNS library.<a name="line.33"></a>
<span class="sourceLineNo">034</span> *<a name="line.34"></a>
<span class="sourceLineNo">035</span> * The length of property names and values must be 255 bytes or less. Entries with names or values larger than 255 bytes<a name="line.35"></a>
<span class="sourceLineNo">036</span> * will be removed prior to advertisement.<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>@Plugin(name = "multicastdns", category = Core.CATEGORY_NAME, elementType = "advertiser", printObject = false)<a name="line.39"></a>
<span class="sourceLineNo">040</span>public class MulticastDnsAdvertiser implements Advertiser {<a name="line.40"></a>
<span class="sourceLineNo">041</span> /**<a name="line.41"></a>
<span class="sourceLineNo">042</span> * Status logger.<a name="line.42"></a>
<span class="sourceLineNo">043</span> */<a name="line.43"></a>
<span class="sourceLineNo">044</span> protected static final Logger LOGGER = StatusLogger.getLogger();<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> private static final int MAX_LENGTH = 255;<a name="line.46"></a>
<span class="sourceLineNo">047</span> private static final int DEFAULT_PORT = 4555;<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> private static Object jmDNS = initializeJmDns();<a name="line.49"></a>
<span class="sourceLineNo">050</span> private static Class&lt;?&gt; jmDNSClass;<a name="line.50"></a>
<span class="sourceLineNo">051</span> private static Class&lt;?&gt; serviceInfoClass;<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> public MulticastDnsAdvertiser() {<a name="line.53"></a>
<span class="sourceLineNo">054</span> // no arg constructor for reflection<a name="line.54"></a>
<span class="sourceLineNo">055</span> }<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> /**<a name="line.57"></a>
<span class="sourceLineNo">058</span> * Advertise the provided entity.<a name="line.58"></a>
<span class="sourceLineNo">059</span> *<a name="line.59"></a>
<span class="sourceLineNo">060</span> * Properties map provided in advertise method must include a "name" entry but may also provide "protocol" (tcp/udp)<a name="line.60"></a>
<span class="sourceLineNo">061</span> * as well as a "port" entry<a name="line.61"></a>
<span class="sourceLineNo">062</span> *<a name="line.62"></a>
<span class="sourceLineNo">063</span> * The length of property names and values must be 255 bytes or less. Entries with names or values larger than 255<a name="line.63"></a>
<span class="sourceLineNo">064</span> * bytes will be removed prior to advertisement.<a name="line.64"></a>
<span class="sourceLineNo">065</span> *<a name="line.65"></a>
<span class="sourceLineNo">066</span> * @param properties the properties representing the entity to advertise<a name="line.66"></a>
<span class="sourceLineNo">067</span> * @return the object which can be used to unadvertise, or null if advertisement was unsuccessful<a name="line.67"></a>
<span class="sourceLineNo">068</span> */<a name="line.68"></a>
<span class="sourceLineNo">069</span> @Override<a name="line.69"></a>
<span class="sourceLineNo">070</span> public Object advertise(final Map&lt;String, String&gt; properties) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> // default to tcp if "protocol" was not set<a name="line.71"></a>
<span class="sourceLineNo">072</span> final Map&lt;String, String&gt; truncatedProperties = new HashMap&lt;&gt;();<a name="line.72"></a>
<span class="sourceLineNo">073</span> for (final Map.Entry&lt;String, String&gt; entry : properties.entrySet()) {<a name="line.73"></a>
<span class="sourceLineNo">074</span> if (entry.getKey().length() &lt;= MAX_LENGTH &amp;&amp; entry.getValue().length() &lt;= MAX_LENGTH) {<a name="line.74"></a>
<span class="sourceLineNo">075</span> truncatedProperties.put(entry.getKey(), entry.getValue());<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<a name="line.77"></a>
<span class="sourceLineNo">078</span> final String protocol = truncatedProperties.get("protocol");<a name="line.78"></a>
<span class="sourceLineNo">079</span> final String zone = "._log4j._" + (protocol != null ? protocol : "tcp") + ".local.";<a name="line.79"></a>
<span class="sourceLineNo">080</span> // default to 4555 if "port" was not set<a name="line.80"></a>
<span class="sourceLineNo">081</span> final String portString = truncatedProperties.get("port");<a name="line.81"></a>
<span class="sourceLineNo">082</span> final int port = Integers.parseInt(portString, DEFAULT_PORT);<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> final String name = truncatedProperties.get("name");<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> // if version 3 is available, use it to construct a serviceInfo instance, otherwise support the version1 API<a name="line.86"></a>
<span class="sourceLineNo">087</span> if (jmDNS != null) {<a name="line.87"></a>
<span class="sourceLineNo">088</span> boolean isVersion3 = false;<a name="line.88"></a>
<span class="sourceLineNo">089</span> try {<a name="line.89"></a>
<span class="sourceLineNo">090</span> // create method is in version 3, not version 1<a name="line.90"></a>
<span class="sourceLineNo">091</span> jmDNSClass.getMethod("create");<a name="line.91"></a>
<span class="sourceLineNo">092</span> isVersion3 = true;<a name="line.92"></a>
<span class="sourceLineNo">093</span> } catch (final NoSuchMethodException e) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> // no-op<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span> Object serviceInfo;<a name="line.96"></a>
<span class="sourceLineNo">097</span> if (isVersion3) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> serviceInfo = buildServiceInfoVersion3(zone, port, name, truncatedProperties);<a name="line.98"></a>
<span class="sourceLineNo">099</span> } else {<a name="line.99"></a>
<span class="sourceLineNo">100</span> serviceInfo = buildServiceInfoVersion1(zone, port, name, truncatedProperties);<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> try {<a name="line.103"></a>
<span class="sourceLineNo">104</span> final Method method = jmDNSClass.getMethod("registerService", serviceInfoClass);<a name="line.104"></a>
<span class="sourceLineNo">105</span> method.invoke(jmDNS, serviceInfo);<a name="line.105"></a>
<span class="sourceLineNo">106</span> } catch (final IllegalAccessException | InvocationTargetException e) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> LOGGER.warn("Unable to invoke registerService method", e);<a name="line.107"></a>
<span class="sourceLineNo">108</span> } catch (final NoSuchMethodException e) {<a name="line.108"></a>
<span class="sourceLineNo">109</span> LOGGER.warn("No registerService method", e);<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span> return serviceInfo;<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span> LOGGER.warn("JMDNS not available - will not advertise ZeroConf support");<a name="line.113"></a>
<span class="sourceLineNo">114</span> return null;<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
<span class="sourceLineNo">117</span> /**<a name="line.117"></a>
<span class="sourceLineNo">118</span> * Unadvertise the previously advertised entity.<a name="line.118"></a>
<span class="sourceLineNo">119</span> *<a name="line.119"></a>
<span class="sourceLineNo">120</span> * @param serviceInfo<a name="line.120"></a>
<span class="sourceLineNo">121</span> */<a name="line.121"></a>
<span class="sourceLineNo">122</span> @Override<a name="line.122"></a>
<span class="sourceLineNo">123</span> public void unadvertise(final Object serviceInfo) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> if (jmDNS != null) {<a name="line.124"></a>
<span class="sourceLineNo">125</span> try {<a name="line.125"></a>
<span class="sourceLineNo">126</span> final Method method = jmDNSClass.getMethod("unregisterService", serviceInfoClass);<a name="line.126"></a>
<span class="sourceLineNo">127</span> method.invoke(jmDNS, serviceInfo);<a name="line.127"></a>
<span class="sourceLineNo">128</span> } catch (final IllegalAccessException | InvocationTargetException e) {<a name="line.128"></a>
<span class="sourceLineNo">129</span> LOGGER.warn("Unable to invoke unregisterService method", e);<a name="line.129"></a>
<span class="sourceLineNo">130</span> } catch (final NoSuchMethodException e) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> LOGGER.warn("No unregisterService method", e);<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> }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span> private static Object createJmDnsVersion1() {<a name="line.136"></a>
<span class="sourceLineNo">137</span> try {<a name="line.137"></a>
<span class="sourceLineNo">138</span> return jmDNSClass.getConstructor().newInstance();<a name="line.138"></a>
<span class="sourceLineNo">139</span> } catch (final InstantiationException | IllegalAccessException | NoSuchMethodException | InvocationTargetException e) {<a name="line.139"></a>
<span class="sourceLineNo">140</span> LOGGER.warn("Unable to instantiate JMDNS", e);<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span> return null;<a name="line.142"></a>
<span class="sourceLineNo">143</span> }<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span> private static Object createJmDnsVersion3() {<a name="line.145"></a>
<span class="sourceLineNo">146</span> try {<a name="line.146"></a>
<span class="sourceLineNo">147</span> final Method jmDNSCreateMethod = jmDNSClass.getMethod("create");<a name="line.147"></a>
<span class="sourceLineNo">148</span> return jmDNSCreateMethod.invoke(null, (Object[]) null);<a name="line.148"></a>
<span class="sourceLineNo">149</span> } catch (final IllegalAccessException | InvocationTargetException e) {<a name="line.149"></a>
<span class="sourceLineNo">150</span> LOGGER.warn("Unable to invoke create method", e);<a name="line.150"></a>
<span class="sourceLineNo">151</span> } catch (final NoSuchMethodException e) {<a name="line.151"></a>
<span class="sourceLineNo">152</span> LOGGER.warn("Unable to get create method", e);<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span> return null;<a name="line.154"></a>
<span class="sourceLineNo">155</span> }<a name="line.155"></a>
<span class="sourceLineNo">156</span><a name="line.156"></a>
<span class="sourceLineNo">157</span> private static Object buildServiceInfoVersion1(final String zone, final int port, final String name,<a name="line.157"></a>
<span class="sourceLineNo">158</span> final Map&lt;String, String&gt; properties) {<a name="line.158"></a>
<span class="sourceLineNo">159</span> // version 1 uses a hashtable<a name="line.159"></a>
<span class="sourceLineNo">160</span> @SuppressWarnings("UseOfObsoleteCollectionType")<a name="line.160"></a>
<span class="sourceLineNo">161</span> final Hashtable&lt;String, String&gt; hashtableProperties = new Hashtable&lt;&gt;(properties);<a name="line.161"></a>
<span class="sourceLineNo">162</span> try {<a name="line.162"></a>
<span class="sourceLineNo">163</span> return serviceInfoClass.getConstructor(String.class, String.class, int.class, int.class, int.class,<a name="line.163"></a>
<span class="sourceLineNo">164</span> Hashtable.class).newInstance(zone, name, port, 0, 0, hashtableProperties);<a name="line.164"></a>
<span class="sourceLineNo">165</span> } catch (final IllegalAccessException | InstantiationException | InvocationTargetException e) {<a name="line.165"></a>
<span class="sourceLineNo">166</span> LOGGER.warn("Unable to construct ServiceInfo instance", e);<a name="line.166"></a>
<span class="sourceLineNo">167</span> } catch (final NoSuchMethodException e) {<a name="line.167"></a>
<span class="sourceLineNo">168</span> LOGGER.warn("Unable to get ServiceInfo constructor", e);<a name="line.168"></a>
<span class="sourceLineNo">169</span> }<a name="line.169"></a>
<span class="sourceLineNo">170</span> return null;<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> private static Object buildServiceInfoVersion3(final String zone, final int port, final String name,<a name="line.173"></a>
<span class="sourceLineNo">174</span> final Map&lt;String, String&gt; properties) {<a name="line.174"></a>
<span class="sourceLineNo">175</span> try {<a name="line.175"></a>
<span class="sourceLineNo">176</span> return serviceInfoClass<a name="line.176"></a>
<span class="sourceLineNo">177</span> // zone/type display name port weight priority properties<a name="line.177"></a>
<span class="sourceLineNo">178</span> .getMethod("create", String.class, String.class, int.class, int.class, int.class, Map.class)<a name="line.178"></a>
<span class="sourceLineNo">179</span> .invoke(null, zone, name, port, 0, 0, properties);<a name="line.179"></a>
<span class="sourceLineNo">180</span> } catch (final IllegalAccessException | InvocationTargetException e) {<a name="line.180"></a>
<span class="sourceLineNo">181</span> LOGGER.warn("Unable to invoke create method", e);<a name="line.181"></a>
<span class="sourceLineNo">182</span> } catch (final NoSuchMethodException e) {<a name="line.182"></a>
<span class="sourceLineNo">183</span> LOGGER.warn("Unable to find create method", e);<a name="line.183"></a>
<span class="sourceLineNo">184</span> }<a name="line.184"></a>
<span class="sourceLineNo">185</span> return null;<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span> private static Object initializeJmDns() {<a name="line.188"></a>
<span class="sourceLineNo">189</span> try {<a name="line.189"></a>
<span class="sourceLineNo">190</span> jmDNSClass = LoaderUtil.loadClass("javax.jmdns.JmDNS");<a name="line.190"></a>
<span class="sourceLineNo">191</span> serviceInfoClass = LoaderUtil.loadClass("javax.jmdns.ServiceInfo");<a name="line.191"></a>
<span class="sourceLineNo">192</span> // if version 3 is available, use it to construct a serviceInfo instance, otherwise support the version1 API<a name="line.192"></a>
<span class="sourceLineNo">193</span> boolean isVersion3 = false;<a name="line.193"></a>
<span class="sourceLineNo">194</span> try {<a name="line.194"></a>
<span class="sourceLineNo">195</span> // create method is in version 3, not version 1<a name="line.195"></a>
<span class="sourceLineNo">196</span> jmDNSClass.getMethod("create");<a name="line.196"></a>
<span class="sourceLineNo">197</span> isVersion3 = true;<a name="line.197"></a>
<span class="sourceLineNo">198</span> } catch (final NoSuchMethodException e) {<a name="line.198"></a>
<span class="sourceLineNo">199</span> // no-op<a name="line.199"></a>
<span class="sourceLineNo">200</span> }<a name="line.200"></a>
<span class="sourceLineNo">201</span><a name="line.201"></a>
<span class="sourceLineNo">202</span> if (isVersion3) {<a name="line.202"></a>
<span class="sourceLineNo">203</span> return createJmDnsVersion3();<a name="line.203"></a>
<span class="sourceLineNo">204</span> }<a name="line.204"></a>
<span class="sourceLineNo">205</span> return createJmDnsVersion1();<a name="line.205"></a>
<span class="sourceLineNo">206</span> } catch (final ClassNotFoundException | ExceptionInInitializerError e) {<a name="line.206"></a>
<span class="sourceLineNo">207</span> LOGGER.warn("JmDNS or serviceInfo class not found", e);<a name="line.207"></a>
<span class="sourceLineNo">208</span> }<a name="line.208"></a>
<span class="sourceLineNo">209</span> return null;<a name="line.209"></a>
<span class="sourceLineNo">210</span> }<a name="line.210"></a>
<span class="sourceLineNo">211</span>}<a name="line.211"></a>
</pre>
</div>
</body>
</html>