| <!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.util.List;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import javax.management.ObjectName;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.logging.log4j.status.StatusData;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>/**<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * The MBean interface for monitoring and managing the {@code StatusLogger}.<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> */<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>public interface StatusLoggerAdminMBean {<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> /**<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * ObjectName pattern ({@value}) for StatusLoggerAdmin MBeans.<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * This pattern contains a variable, which is the name of the logger context.<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * <p><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * You can find all registered StatusLoggerAdmin MBeans like this:<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * </p><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * <pre><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * String pattern = String.format(StatusLoggerAdminMBean.PATTERN, &quot;*&quot;);<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * Set&lt;ObjectName&gt; statusLoggerNames = mbs.queryNames(new ObjectName(pattern), null);<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * </pre><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <p><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * Some characters are not allowed in ObjectNames. The logger context name<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * may be quoted. When StatusLoggerAdmin MBeans are<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * registered, their ObjectNames are created using this pattern as follows:<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * </p><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <pre><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * String ctxName = Server.escape(loggerContext.getName());<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * String name = String.format(PATTERN, ctxName);<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * ObjectName objectName = new ObjectName(name);<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * </pre><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * @see Server#escape(String)<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> String PATTERN = Server.DOMAIN + ":type=%s,component=StatusLogger";<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * Notifications with this type have a {@code StatusData} userData object<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * and a {@code null} message.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> */<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> String NOTIF_TYPE_DATA = "com.apache.logging.log4j.core.jmx.statuslogger.data";<a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> /**<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * Notifications with this type have a formatted status data message string<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * but no {@code StatusData} in their userData field.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> */<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> String NOTIF_TYPE_MESSAGE = "com.apache.logging.log4j.core.jmx.statuslogger.message";<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> * Returns the {@code ObjectName} that this status logger mbean is registered with.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * @return the ObjectName of this StatusLogger MBean<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> */<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> ObjectName getObjectName();<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> /**<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * Returns a list with the most recent {@code StatusData} objects in the<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * status history. The list has up to 200 entries by default but the length<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * can be configured with system property {@code "log4j2.status.entries"}.<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * <p><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * Note that the returned objects may contain {@code Throwable}s from<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * external libraries.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * </p><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * <p><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * JMX clients calling this method must be prepared to deal with the errors<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * that occur if they do not have the class definition for such<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * {@code Throwable}s in their classpath.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * </p><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> *<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * @return the most recent messages logged by the {@code StatusLogger}.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> */<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> List<StatusData> getStatusData();<a name="line.88"></a> |
| <span class="sourceLineNo">089</span><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> /**<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * Returns a string array with the most recent messages in the status<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * history. The list has up to 200 entries by default but the length can be<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * configured with system property {@code "log4j2.status.entries"}.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> *<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * @return the most recent messages logged by the {@code StatusLogger}.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> */<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> String[] getStatusDataHistory();<a name="line.97"></a> |
| <span class="sourceLineNo">098</span><a name="line.98"></a> |
| <span class="sourceLineNo">099</span> /**<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * Returns the {@code StatusLogger} level as a String.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> *<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * @return the {@code StatusLogger} level.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> */<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> String getLevel();<a name="line.104"></a> |
| <span class="sourceLineNo">105</span><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> /**<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * Sets the {@code StatusLogger} level to the specified value.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> *<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @param level the new {@code StatusLogger} level.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @throws IllegalArgumentException if the specified level is not one of<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * "OFF", "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE",<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * "ALL"<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> */<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> void setLevel(String level);<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> * Returns the name of the LoggerContext that the {@code StatusLogger} is associated with.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * @return logger context name<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> */<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> String getContextName();<a name="line.120"></a> |
| <span class="sourceLineNo">121</span>}<a name="line.121"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |