| <!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.util;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import org.apache.logging.log4j.util.PropertiesUtil;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>/**<a name="line.21"></a> |
| <span class="sourceLineNo">022</span> * Log4j Constants.<a name="line.22"></a> |
| <span class="sourceLineNo">023</span> */<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>public final class Constants {<a name="line.24"></a> |
| <span class="sourceLineNo">025</span><a name="line.25"></a> |
| <span class="sourceLineNo">026</span> /**<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * Name of the system property to use to identify the LogEvent factory.<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> */<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> public static final String LOG4J_LOG_EVENT_FACTORY = "Log4jLogEventFactory";<a name="line.29"></a> |
| <span class="sourceLineNo">030</span><a name="line.30"></a> |
| <span class="sourceLineNo">031</span> /**<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * Name of the system property to use to identify the ContextSelector Class.<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> */<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> public static final String LOG4J_CONTEXT_SELECTOR = "Log4jContextSelector";<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> /**<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * Property name for the default status (internal log4j logging) level to use if not specified in configuration.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> */<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> public static final String LOG4J_DEFAULT_STATUS_LEVEL = "Log4jDefaultStatusLevel";<a name="line.39"></a> |
| <span class="sourceLineNo">040</span><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> /**<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * JNDI context name string literal.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> */<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> public static final String JNDI_CONTEXT_NAME = "java:comp/env/log4j/context-name";<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> /**<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Number of milliseconds in a second.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> */<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> public static final int MILLIS_IN_SECONDS = 1000;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> /**<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * Supports user request LOG4J2-898 to have the option to format a message in the background thread.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> */<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> public static final boolean FORMAT_MESSAGES_IN_BACKGROUND = PropertiesUtil.getProperties().getBooleanProperty(<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> "log4j.format.msg.async", false);<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> * LOG4J2-2109 if {@code true}, MessagePatternConverter will always operate as though<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * <pre>%m{nolookups}</pre> is configured.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> *<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * @since 2.10<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> */<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> public static final boolean FORMAT_MESSAGES_PATTERN_DISABLE_LOOKUPS = PropertiesUtil.getProperties().getBooleanProperty(<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> "log4j2.formatMsgNoLookups", false);<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> * {@code true} if we think we are running in a web container, based on the boolean value of system property<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * "log4j2.is.webapp", or (if this system property is not set) whether the {@code javax.servlet.Servlet} class<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * is present in the classpath.<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> */<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> public static final boolean IS_WEB_APP = org.apache.logging.log4j.util.Constants.IS_WEB_APP;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> /**<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * Kill switch for object pooling in ThreadLocals that enables much of the LOG4J2-1270 no-GC behaviour.<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * <p><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * {@code True} for non-{@link #IS_WEB_APP web apps}, disable by setting system property<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * "log4j2.enable.threadlocals" to "false".<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> *<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @since 2.6<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> public static final boolean ENABLE_THREADLOCALS = org.apache.logging.log4j.util.Constants.ENABLE_THREADLOCALS;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> /**<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * Kill switch for garbage-free Layout behaviour that encodes LogEvents directly into<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * {@link org.apache.logging.log4j.core.layout.ByteBufferDestination}s without creating intermediate temporary<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * Objects.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * <p><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * {@code True} by default iff all loggers are asynchronous because system property<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * {@code Log4jContextSelector} is set to {@code org.apache.logging.log4j.core.async.AsyncLoggerContextSelector}.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * Disable by setting system property "log4j2.enable.direct.encoders" to "false".<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> *<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @since 2.6<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> */<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> public static final boolean ENABLE_DIRECT_ENCODERS = PropertiesUtil.getProperties().getBooleanProperty(<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> "log4j2.enable.direct.encoders", true); // enable GC-free text encoding by default<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> // the alternative is to enable GC-free encoding only by default only when using all-async loggers:<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> //AsyncLoggerContextSelector.class.getName().equals(PropertiesUtil.getProperties().getStringProperty(LOG4J_CONTEXT_SELECTOR)));<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> * Initial StringBuilder size used in RingBuffer LogEvents to store the contents of reusable Messages.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * <p><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * The default value is {@value}, users can override with system property "log4j.initialReusableMsgSize".<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * </p><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @since 2.6<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> */<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> public static final int INITIAL_REUSABLE_MESSAGE_SIZE = size("log4j.initialReusableMsgSize", 128);<a name="line.106"></a> |
| <span class="sourceLineNo">107</span><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> /**<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * Maximum size of the StringBuilders used in RingBuffer LogEvents to store the contents of reusable Messages.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * After a large message has been delivered to the appenders, the StringBuilder is trimmed to this size.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * <p><a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * The default value is {@value}, which allows the StringBuilder to resize three times from its initial size.<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * Users can override with system property "log4j.maxReusableMsgSize".<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * </p><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * @since 2.6<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> */<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> public static final int MAX_REUSABLE_MESSAGE_SIZE = size("log4j.maxReusableMsgSize", (128 * 2 + 2) * 2 + 2);<a name="line.117"></a> |
| <span class="sourceLineNo">118</span><a name="line.118"></a> |
| <span class="sourceLineNo">119</span> /**<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * Size of CharBuffers used by text encoders.<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * <p><a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * The default value is {@value}, users can override with system property "log4j.encoder.charBufferSize".<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * </p><a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * @since 2.6<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> */<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> public static final int ENCODER_CHAR_BUFFER_SIZE = size("log4j.encoder.charBufferSize", 2048);<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> * Default size of ByteBuffers used to encode LogEvents without allocating temporary objects.<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * <p><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * The default value is {@value}, users can override with system property "log4j.encoder.byteBufferSize".<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * </p><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * @see org.apache.logging.log4j.core.layout.ByteBufferDestination<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * @since 2.6<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> */<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> public static final int ENCODER_BYTE_BUFFER_SIZE = size("log4j.encoder.byteBufferSize", 8 * 1024);<a name="line.136"></a> |
| <span class="sourceLineNo">137</span><a name="line.137"></a> |
| <span class="sourceLineNo">138</span><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> private static int size(final String property, final int defaultValue) {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> return PropertiesUtil.getProperties().getIntegerProperty(property, defaultValue);<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> }<a name="line.141"></a> |
| <span class="sourceLineNo">142</span><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> /**<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * Prevent class instantiation.<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> */<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> private Constants() {<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> }<a name="line.147"></a> |
| <span class="sourceLineNo">148</span>}<a name="line.148"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
