Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.0 / log4j-core / apidocs / src-html / org / apache / logging / log4j / core / jmx / AsyncAppenderAdmin.html
blob: 4518c2c5134f20c08d86f4da60dd079ba6437819 [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.jmx;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.util.Objects;<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.core.appender.AsyncAppender;<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> * Implementation of the {@code AsyncAppenderAdminMBean} interface.<a name="line.26"></a>
<span class="sourceLineNo">027</span> */<a name="line.27"></a>
<span class="sourceLineNo">028</span>public class AsyncAppenderAdmin implements AsyncAppenderAdminMBean {<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span> private final String contextName;<a name="line.30"></a>
<span class="sourceLineNo">031</span> private final AsyncAppender asyncAppender;<a name="line.31"></a>
<span class="sourceLineNo">032</span> private final ObjectName objectName;<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> * Constructs a new {@code AsyncAppenderAdmin} with the specified contextName<a name="line.35"></a>
<span class="sourceLineNo">036</span> * and async appender.<a name="line.36"></a>
<span class="sourceLineNo">037</span> *<a name="line.37"></a>
<span class="sourceLineNo">038</span> * @param contextName used in the {@code ObjectName} for this mbean<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @param appender the instrumented object<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span> public AsyncAppenderAdmin(final String contextName, final AsyncAppender appender) {<a name="line.41"></a>
<span class="sourceLineNo">042</span> // super(executor); // no notifications for now<a name="line.42"></a>
<span class="sourceLineNo">043</span> this.contextName = Objects.requireNonNull(contextName, "contextName");<a name="line.43"></a>
<span class="sourceLineNo">044</span> this.asyncAppender = Objects.requireNonNull(appender, "async appender");<a name="line.44"></a>
<span class="sourceLineNo">045</span> try {<a name="line.45"></a>
<span class="sourceLineNo">046</span> final String ctxName = Server.escape(this.contextName);<a name="line.46"></a>
<span class="sourceLineNo">047</span> final String configName = Server.escape(appender.getName());<a name="line.47"></a>
<span class="sourceLineNo">048</span> final String name = String.format(PATTERN, ctxName, configName);<a name="line.48"></a>
<span class="sourceLineNo">049</span> objectName = new ObjectName(name);<a name="line.49"></a>
<span class="sourceLineNo">050</span> } catch (final Exception e) {<a name="line.50"></a>
<span class="sourceLineNo">051</span> throw new IllegalStateException(e);<a name="line.51"></a>
<span class="sourceLineNo">052</span> }<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> /**<a name="line.55"></a>
<span class="sourceLineNo">056</span> * Returns the {@code ObjectName} of this mbean.<a name="line.56"></a>
<span class="sourceLineNo">057</span> *<a name="line.57"></a>
<span class="sourceLineNo">058</span> * @return the {@code ObjectName}<a name="line.58"></a>
<span class="sourceLineNo">059</span> * @see AppenderAdminMBean#PATTERN<a name="line.59"></a>
<span class="sourceLineNo">060</span> */<a name="line.60"></a>
<span class="sourceLineNo">061</span> public ObjectName getObjectName() {<a name="line.61"></a>
<span class="sourceLineNo">062</span> return objectName;<a name="line.62"></a>
<span class="sourceLineNo">063</span> }<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> @Override<a name="line.65"></a>
<span class="sourceLineNo">066</span> public String getName() {<a name="line.66"></a>
<span class="sourceLineNo">067</span> return asyncAppender.getName();<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> @Override<a name="line.70"></a>
<span class="sourceLineNo">071</span> public String getLayout() {<a name="line.71"></a>
<span class="sourceLineNo">072</span> return String.valueOf(asyncAppender.getLayout());<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> @Override<a name="line.75"></a>
<span class="sourceLineNo">076</span> public boolean isIgnoreExceptions() {<a name="line.76"></a>
<span class="sourceLineNo">077</span> return asyncAppender.ignoreExceptions();<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> @Override<a name="line.80"></a>
<span class="sourceLineNo">081</span> public String getErrorHandler() {<a name="line.81"></a>
<span class="sourceLineNo">082</span> return String.valueOf(asyncAppender.getHandler());<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> @Override<a name="line.85"></a>
<span class="sourceLineNo">086</span> public String getFilter() {<a name="line.86"></a>
<span class="sourceLineNo">087</span> return String.valueOf(asyncAppender.getFilter());<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> @Override<a name="line.90"></a>
<span class="sourceLineNo">091</span> public String[] getAppenderRefs() {<a name="line.91"></a>
<span class="sourceLineNo">092</span> return asyncAppender.getAppenderRefStrings();<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> /**<a name="line.95"></a>
<span class="sourceLineNo">096</span> * Returns {@code true} if this AsyncAppender will take a snapshot of the stack with<a name="line.96"></a>
<span class="sourceLineNo">097</span> * every log event to determine the class and method where the logging call<a name="line.97"></a>
<span class="sourceLineNo">098</span> * was made.<a name="line.98"></a>
<span class="sourceLineNo">099</span> * @return {@code true} if location is included with every event, {@code false} otherwise<a name="line.99"></a>
<span class="sourceLineNo">100</span> */<a name="line.100"></a>
<span class="sourceLineNo">101</span> @Override<a name="line.101"></a>
<span class="sourceLineNo">102</span> public boolean isIncludeLocation() {<a name="line.102"></a>
<span class="sourceLineNo">103</span> return asyncAppender.isIncludeLocation();<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<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> * Returns {@code true} if this AsyncAppender will block when the queue is full,<a name="line.107"></a>
<span class="sourceLineNo">108</span> * or {@code false} if events are dropped when the queue is full.<a name="line.108"></a>
<span class="sourceLineNo">109</span> * @return whether this AsyncAppender will block or drop events when the queue is full.<a name="line.109"></a>
<span class="sourceLineNo">110</span> */<a name="line.110"></a>
<span class="sourceLineNo">111</span> @Override<a name="line.111"></a>
<span class="sourceLineNo">112</span> public boolean isBlocking() {<a name="line.112"></a>
<span class="sourceLineNo">113</span> return asyncAppender.isBlocking();<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<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 appender that any errors are logged to or {@code null}.<a name="line.117"></a>
<span class="sourceLineNo">118</span> * @return the name of the appender that any errors are logged to or {@code null}<a name="line.118"></a>
<span class="sourceLineNo">119</span> */<a name="line.119"></a>
<span class="sourceLineNo">120</span> @Override<a name="line.120"></a>
<span class="sourceLineNo">121</span> public String getErrorRef() {<a name="line.121"></a>
<span class="sourceLineNo">122</span> return asyncAppender.getErrorRef();<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span> @Override<a name="line.125"></a>
<span class="sourceLineNo">126</span> public int getQueueCapacity() {<a name="line.126"></a>
<span class="sourceLineNo">127</span> return asyncAppender.getQueueCapacity();<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span> @Override<a name="line.130"></a>
<span class="sourceLineNo">131</span> public int getQueueRemainingCapacity() {<a name="line.131"></a>
<span class="sourceLineNo">132</span> return asyncAppender.getQueueRemainingCapacity();<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>
</pre>
</div>
</body>
</html>