| <!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.jmx;<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.List;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.concurrent.Executor;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.concurrent.atomic.AtomicLong;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import javax.management.MBeanNotificationInfo;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import javax.management.Notification;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import javax.management.NotificationBroadcasterSupport;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import javax.management.ObjectName;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.Level;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.status.StatusData;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.status.StatusListener;<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> * Implementation of the {@code StatusLoggerAdminMBean} interface.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> */<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>public class StatusLoggerAdmin extends NotificationBroadcasterSupport implements StatusListener, StatusLoggerAdminMBean {<a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> private final AtomicLong sequenceNo = new AtomicLong();<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> private final ObjectName objectName;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> private final String contextName;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> private Level level = Level.WARN;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> /**<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * Constructs a new {@code StatusLoggerAdmin} with the {@code Executor} to<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * be used for sending {@code Notification}s asynchronously to listeners.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> *<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * @param contextName name of the LoggerContext under which to register this<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * StatusLoggerAdmin. Note that the StatusLogger may be<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * registered multiple times, once for each LoggerContext. In web<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * containers, each web application has its own LoggerContext and<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * by associating the StatusLogger with the LoggerContext, all<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * associated MBeans can be unloaded when the web application is<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * undeployed.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * @param executor used to send notifications asynchronously<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> */<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> public StatusLoggerAdmin(final String contextName, final Executor executor) {<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> super(executor, createNotificationInfo());<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> this.contextName = contextName;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> try {<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> final String mbeanName = String.format(PATTERN, Server.escape(contextName));<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> objectName = new ObjectName(mbeanName);<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> } catch (final Exception e) {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> throw new IllegalStateException(e);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> }<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> removeListeners(contextName);<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> StatusLogger.getLogger().registerListener(this);<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> * Add listener to StatusLogger for this context, or replace it if it already exists.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> *<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @param ctxName<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> */<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> private void removeListeners(final String ctxName) {<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> final StatusLogger logger = StatusLogger.getLogger();<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> final Iterable<StatusListener> listeners = logger.getListeners();<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> // Remove any StatusLoggerAdmin listeners already registered for this context<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> for (final StatusListener statusListener : listeners) {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> if (statusListener instanceof StatusLoggerAdmin) {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> final StatusLoggerAdmin adminListener = (StatusLoggerAdmin) statusListener;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> if (ctxName != null && ctxName.equals(adminListener.contextName)) {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> logger.removeListener(adminListener);<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> }<a name="line.87"></a> |
| <span class="sourceLineNo">088</span><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> private static MBeanNotificationInfo createNotificationInfo() {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> final String[] notifTypes = new String[] {<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> NOTIF_TYPE_DATA,<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> NOTIF_TYPE_MESSAGE };<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> final String name = Notification.class.getName();<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> final String description = "StatusLogger has logged an event";<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> return new MBeanNotificationInfo(notifTypes, name, description);<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> }<a name="line.96"></a> |
| <span class="sourceLineNo">097</span><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> @Override<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> public String[] getStatusDataHistory() {<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> final List<StatusData> data = getStatusData();<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> final String[] result = new String[data.size()];<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> for (int i = 0; i < result.length; i++) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> result[i] = data.get(i).getFormattedStatus();<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> }<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> return result;<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> }<a name="line.106"></a> |
| <span class="sourceLineNo">107</span><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> @Override<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> public List<StatusData> getStatusData() {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> return StatusLogger.getLogger().getStatusData();<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> }<a name="line.111"></a> |
| <span class="sourceLineNo">112</span><a name="line.112"></a> |
| <span class="sourceLineNo">113</span> @Override<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> public String getLevel() {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> return this.level.name();<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> @Override<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> public Level getStatusLevel() {<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> return this.level;<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> }<a name="line.121"></a> |
| <span class="sourceLineNo">122</span><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> @Override<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> public void setLevel(final String level) {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> this.level = Level.toLevel(level, Level.ERROR);<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> @Override<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> public String getContextName() {<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> return contextName;<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> }<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> * (non-Javadoc)<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> *<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * @see<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * org.apache.logging.log4j.status.StatusListener#log(org.apache.logging<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * .log4j.status.StatusData)<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> */<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> @Override<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> public void log(final StatusData data) {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> final Notification notifMsg = new Notification(NOTIF_TYPE_MESSAGE, getObjectName(), nextSeqNo(), nowMillis(),<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> data.getFormattedStatus());<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> sendNotification(notifMsg);<a name="line.144"></a> |
| <span class="sourceLineNo">145</span><a name="line.145"></a> |
| <span class="sourceLineNo">146</span> final Notification notifData = new Notification(NOTIF_TYPE_DATA, getObjectName(), nextSeqNo(), nowMillis());<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> notifData.setUserData(data);<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> sendNotification(notifData);<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> }<a name="line.149"></a> |
| <span class="sourceLineNo">150</span><a name="line.150"></a> |
| <span class="sourceLineNo">151</span> /**<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * Returns the {@code ObjectName} of this mbean.<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> *<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * @return the {@code ObjectName}<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * @see StatusLoggerAdminMBean#PATTERN<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> */<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> @Override<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> public ObjectName getObjectName() {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> return objectName;<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> private long nextSeqNo() {<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> return sequenceNo.getAndIncrement();<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> }<a name="line.164"></a> |
| <span class="sourceLineNo">165</span><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> private long nowMillis() {<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> return System.currentTimeMillis();<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> @Override<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> public void close() throws IOException {<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> // nothing to close here<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> }<a name="line.173"></a> |
| <span class="sourceLineNo">174</span>}<a name="line.174"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
