Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.2 / log4j-jmx-gui / apidocs / src-html / org / apache / logging / log4j / jmx / gui / Client.html
blob: 65cf8427258ef4069aa8c62375950caa127af135 [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.jmx.gui;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.IOException;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.ArrayList;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.List;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Objects;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Set;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import javax.management.JMException;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import javax.management.JMX;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import javax.management.MBeanServerConnection;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import javax.management.MalformedObjectNameException;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import javax.management.ObjectName;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import javax.management.remote.JMXConnector;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.jmx.LoggerContextAdminMBean;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.jmx.Server;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.jmx.StatusLoggerAdminMBean;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.util.Closer;<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> * This class allows client-side code to perform operations on remote<a name="line.38"></a>
<span class="sourceLineNo">039</span> * (server-side) MBeans via proxies.<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span>public class Client {<a name="line.41"></a>
<span class="sourceLineNo">042</span> private JMXConnector connector;<a name="line.42"></a>
<span class="sourceLineNo">043</span> private final MBeanServerConnection connection;<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> * Constructs a new {@code Client} object and creates proxies for all known<a name="line.46"></a>
<span class="sourceLineNo">047</span> * remote MBeans.<a name="line.47"></a>
<span class="sourceLineNo">048</span> *<a name="line.48"></a>
<span class="sourceLineNo">049</span> * @param connector used to create the MBean server connection through which<a name="line.49"></a>
<span class="sourceLineNo">050</span> * to communicate with the remote mbeans<a name="line.50"></a>
<span class="sourceLineNo">051</span> * @throws MalformedObjectNameException if a problem occurred identifying<a name="line.51"></a>
<span class="sourceLineNo">052</span> * one of the remote mbeans<a name="line.52"></a>
<span class="sourceLineNo">053</span> * @throws IOException if the connection failed<a name="line.53"></a>
<span class="sourceLineNo">054</span> */<a name="line.54"></a>
<span class="sourceLineNo">055</span> public Client(final JMXConnector connector) throws MalformedObjectNameException, IOException {<a name="line.55"></a>
<span class="sourceLineNo">056</span> this.connector = Objects.requireNonNull(connector, "JMXConnector");<a name="line.56"></a>
<span class="sourceLineNo">057</span> this.connector.connect();<a name="line.57"></a>
<span class="sourceLineNo">058</span> this.connection = connector.getMBeanServerConnection();<a name="line.58"></a>
<span class="sourceLineNo">059</span> init();<a name="line.59"></a>
<span class="sourceLineNo">060</span> }<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> /**<a name="line.62"></a>
<span class="sourceLineNo">063</span> * Constructs a new {@code Client} object and creates proxies for all known<a name="line.63"></a>
<span class="sourceLineNo">064</span> * remote MBeans.<a name="line.64"></a>
<span class="sourceLineNo">065</span> *<a name="line.65"></a>
<span class="sourceLineNo">066</span> * @param mBeanServerConnection the MBean server connection through which to<a name="line.66"></a>
<span class="sourceLineNo">067</span> * communicate with the remote mbeans<a name="line.67"></a>
<span class="sourceLineNo">068</span> * @throws MalformedObjectNameException if a problem occurred identifying<a name="line.68"></a>
<span class="sourceLineNo">069</span> * one of the remote mbeans<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @throws IOException if the connection failed<a name="line.70"></a>
<span class="sourceLineNo">071</span> */<a name="line.71"></a>
<span class="sourceLineNo">072</span> public Client(final MBeanServerConnection mBeanServerConnection) throws MalformedObjectNameException, IOException {<a name="line.72"></a>
<span class="sourceLineNo">073</span> this.connection = mBeanServerConnection;<a name="line.73"></a>
<span class="sourceLineNo">074</span> init();<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> private void init() throws MalformedObjectNameException, IOException {<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> private Set&lt;ObjectName&gt; find(final String pattern) throws JMException, IOException {<a name="line.80"></a>
<span class="sourceLineNo">081</span> final ObjectName search = new ObjectName(String.format(pattern, "*"));<a name="line.81"></a>
<span class="sourceLineNo">082</span> final Set&lt;ObjectName&gt; result = connection.queryNames(search, null);<a name="line.82"></a>
<span class="sourceLineNo">083</span> return result;<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> /**<a name="line.86"></a>
<span class="sourceLineNo">087</span> * Returns a list of proxies that allow operations to be performed on the<a name="line.87"></a>
<span class="sourceLineNo">088</span> * remote {@code LoggerContextAdminMBean}s.<a name="line.88"></a>
<span class="sourceLineNo">089</span> *<a name="line.89"></a>
<span class="sourceLineNo">090</span> * @return a list of proxies to the remote {@code LoggerContextAdminMBean}s<a name="line.90"></a>
<span class="sourceLineNo">091</span> * @throws IOException If an I/O error occurred<a name="line.91"></a>
<span class="sourceLineNo">092</span> * @throws JMException If a management error occurred<a name="line.92"></a>
<span class="sourceLineNo">093</span> */<a name="line.93"></a>
<span class="sourceLineNo">094</span> public List&lt;LoggerContextAdminMBean&gt; getLoggerContextAdmins() throws JMException, IOException {<a name="line.94"></a>
<span class="sourceLineNo">095</span> final List&lt;LoggerContextAdminMBean&gt; result = new ArrayList&lt;&gt;();<a name="line.95"></a>
<span class="sourceLineNo">096</span> final Set&lt;ObjectName&gt; contextNames = find(LoggerContextAdminMBean.PATTERN);<a name="line.96"></a>
<span class="sourceLineNo">097</span> for (final ObjectName contextName : contextNames) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> result.add(getLoggerContextAdmin(contextName));<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span> return result;<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> public LoggerContextAdminMBean getLoggerContextAdmin(final ObjectName name) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> final LoggerContextAdminMBean ctx = JMX.newMBeanProxy(connection, //<a name="line.104"></a>
<span class="sourceLineNo">105</span> name, //<a name="line.105"></a>
<span class="sourceLineNo">106</span> LoggerContextAdminMBean.class, false);<a name="line.106"></a>
<span class="sourceLineNo">107</span> return ctx;<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> /**<a name="line.110"></a>
<span class="sourceLineNo">111</span> * Closes the client connection to its server. Any ongoing or new requests<a name="line.111"></a>
<span class="sourceLineNo">112</span> * to the MBeanServerConnection will fail.<a name="line.112"></a>
<span class="sourceLineNo">113</span> */<a name="line.113"></a>
<span class="sourceLineNo">114</span> public void close() {<a name="line.114"></a>
<span class="sourceLineNo">115</span> Closer.closeSilently(connector);<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> /**<a name="line.118"></a>
<span class="sourceLineNo">119</span> * Returns the MBean server connection through which to communicate with the<a name="line.119"></a>
<span class="sourceLineNo">120</span> * remote mbeans.<a name="line.120"></a>
<span class="sourceLineNo">121</span> *<a name="line.121"></a>
<span class="sourceLineNo">122</span> * @return the MBean server connection<a name="line.122"></a>
<span class="sourceLineNo">123</span> */<a name="line.123"></a>
<span class="sourceLineNo">124</span> public MBeanServerConnection getConnection() {<a name="line.124"></a>
<span class="sourceLineNo">125</span> return connection;<a name="line.125"></a>
<span class="sourceLineNo">126</span> }<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span> /**<a name="line.128"></a>
<span class="sourceLineNo">129</span> * Returns the {@code StatusLoggerAdminMBean} associated with the specified<a name="line.129"></a>
<span class="sourceLineNo">130</span> * context name, or {@code null}.<a name="line.130"></a>
<span class="sourceLineNo">131</span> *<a name="line.131"></a>
<span class="sourceLineNo">132</span> * @param contextName search key<a name="line.132"></a>
<span class="sourceLineNo">133</span> * @return StatusLoggerAdminMBean or null<a name="line.133"></a>
<span class="sourceLineNo">134</span> * @throws MalformedObjectNameException If an object name is malformed<a name="line.134"></a>
<span class="sourceLineNo">135</span> * @throws IOException If an I/O error occurred<a name="line.135"></a>
<span class="sourceLineNo">136</span> */<a name="line.136"></a>
<span class="sourceLineNo">137</span> public StatusLoggerAdminMBean getStatusLoggerAdmin(final String contextName)<a name="line.137"></a>
<span class="sourceLineNo">138</span> throws MalformedObjectNameException, IOException {<a name="line.138"></a>
<span class="sourceLineNo">139</span> final String pattern = StatusLoggerAdminMBean.PATTERN;<a name="line.139"></a>
<span class="sourceLineNo">140</span> final String mbean = String.format(pattern, Server.escape(contextName));<a name="line.140"></a>
<span class="sourceLineNo">141</span> final ObjectName search = new ObjectName(mbean);<a name="line.141"></a>
<span class="sourceLineNo">142</span> final Set&lt;ObjectName&gt; result = connection.queryNames(search, null);<a name="line.142"></a>
<span class="sourceLineNo">143</span> if (result.size() == 0) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> return null;<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span> if (result.size() &gt; 1) {<a name="line.146"></a>
<span class="sourceLineNo">147</span> System.err.println("WARN: multiple status loggers found for " + contextName + ": " + result);<a name="line.147"></a>
<span class="sourceLineNo">148</span> }<a name="line.148"></a>
<span class="sourceLineNo">149</span> final StatusLoggerAdminMBean proxy = JMX.newMBeanProxy(connection, //<a name="line.149"></a>
<span class="sourceLineNo">150</span> result.iterator().next(), //<a name="line.150"></a>
<span class="sourceLineNo">151</span> StatusLoggerAdminMBean.class, true); // notificationBroadcaster<a name="line.151"></a>
<span class="sourceLineNo">152</span> return proxy;<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span> /**<a name="line.155"></a>
<span class="sourceLineNo">156</span> * Returns {@code true} if the specified {@code ObjectName} is for a<a name="line.156"></a>
<span class="sourceLineNo">157</span> * {@code LoggerContextAdminMBean}, {@code false} otherwise.<a name="line.157"></a>
<span class="sourceLineNo">158</span> *<a name="line.158"></a>
<span class="sourceLineNo">159</span> * @param mbeanName the {@code ObjectName} to check.<a name="line.159"></a>
<span class="sourceLineNo">160</span> * @return {@code true} if the specified {@code ObjectName} is for a<a name="line.160"></a>
<span class="sourceLineNo">161</span> * {@code LoggerContextAdminMBean}, {@code false} otherwise<a name="line.161"></a>
<span class="sourceLineNo">162</span> */<a name="line.162"></a>
<span class="sourceLineNo">163</span> public boolean isLoggerContext(final ObjectName mbeanName) {<a name="line.163"></a>
<span class="sourceLineNo">164</span> return Server.DOMAIN.equals(mbeanName.getDomain()) //<a name="line.164"></a>
<span class="sourceLineNo">165</span> &amp;&amp; mbeanName.getKeyPropertyList().containsKey("type") //<a name="line.165"></a>
<span class="sourceLineNo">166</span> &amp;&amp; mbeanName.getKeyPropertyList().size() == 1;<a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> /**<a name="line.169"></a>
<span class="sourceLineNo">170</span> * Returns the {@code ObjectName} of the {@code StatusLoggerAdminMBean}<a name="line.170"></a>
<span class="sourceLineNo">171</span> * associated with the specified {@code LoggerContextAdminMBean}.<a name="line.171"></a>
<span class="sourceLineNo">172</span> *<a name="line.172"></a>
<span class="sourceLineNo">173</span> * @param loggerContextObjName the {@code ObjectName} of a<a name="line.173"></a>
<span class="sourceLineNo">174</span> * {@code LoggerContextAdminMBean}<a name="line.174"></a>
<span class="sourceLineNo">175</span> * @return {@code ObjectName} of the {@code StatusLoggerAdminMBean}<a name="line.175"></a>
<span class="sourceLineNo">176</span> */<a name="line.176"></a>
<span class="sourceLineNo">177</span> public ObjectName getStatusLoggerObjectName(final ObjectName loggerContextObjName) {<a name="line.177"></a>
<span class="sourceLineNo">178</span> if (!isLoggerContext(loggerContextObjName)) {<a name="line.178"></a>
<span class="sourceLineNo">179</span> throw new IllegalArgumentException("Not a LoggerContext: " + loggerContextObjName);<a name="line.179"></a>
<span class="sourceLineNo">180</span> }<a name="line.180"></a>
<span class="sourceLineNo">181</span> final String cxtName = loggerContextObjName.getKeyProperty("type");<a name="line.181"></a>
<span class="sourceLineNo">182</span> final String name = String.format(StatusLoggerAdminMBean.PATTERN, cxtName);<a name="line.182"></a>
<span class="sourceLineNo">183</span> try {<a name="line.183"></a>
<span class="sourceLineNo">184</span> return new ObjectName(name);<a name="line.184"></a>
<span class="sourceLineNo">185</span> } catch (final MalformedObjectNameException ex) {<a name="line.185"></a>
<span class="sourceLineNo">186</span> throw new IllegalStateException(name, ex);<a name="line.186"></a>
<span class="sourceLineNo">187</span> }<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span>}<a name="line.189"></a>
</pre>
</div>
</body>
</html>