| <!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><a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.logging.log4j.core.pattern;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.List;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.logging.log4j.core.appender.AbstractAppender;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.layout.PatternLayout;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.util.PerformanceSensitive;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>/**<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * Max length pattern converter. Limit contained text to a maximum length.<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * On invalid length the default value 100 is used (and an error message is logged).<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * If max length is greater than 20, an abbreviated text will get ellipsis ("...") appended.<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * Example usage (for email subject):<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * {@code "%maxLen{[AppName, ${hostName}, ${web:contextPath}] %p: %c{1} - %m%notEmpty{ =>%ex{short}}}{160}"}<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> *<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * @author Thies Wellpott<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> */<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>@Plugin(name = "maxLength", category = PatternConverter.CATEGORY)<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>@ConverterKeys({"maxLength", "maxLen"})<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>@PerformanceSensitive("allocation")<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>public final class MaxLengthConverter extends LogEventPatternConverter {<a name="line.41"></a> |
| <span class="sourceLineNo">042</span><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> /**<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * Gets an instance of the class.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> *<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * @param config The current Configuration.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * @param options pattern options, an array of two elements: pattern, max length (defaults to 100 on invalid value).<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * @return instance of class.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> public static MaxLengthConverter newInstance(final Configuration config, final String[] options) {<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> if (options.length != 2) {<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> LOGGER.error("Incorrect number of options on maxLength: expected 2 received {}: {}", options.length,<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> options);<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> return null;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> }<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> if (options[0] == null) {<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> LOGGER.error("No pattern supplied on maxLength");<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> return null;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> }<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> if (options[1] == null) {<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> LOGGER.error("No length supplied on maxLength");<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> return null;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> }<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> final PatternParser parser = PatternLayout.createPatternParser(config);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> final List<PatternFormatter> formatters = parser.parse(options[0]);<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> return new MaxLengthConverter(formatters, AbstractAppender.parseInt(options[1], 100));<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> }<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> private final List<PatternFormatter> formatters;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> private final int maxLength;<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> * Construct the converter.<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> *<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * @param formatters The PatternFormatters to generate the text to manipulate.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @param maxLength The max. length of the resulting string. Ellipsis ("...") is appended on shorted string, if greater than 20.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> */<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> private MaxLengthConverter(final List<PatternFormatter> formatters, final int maxLength) {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> super("MaxLength", "maxLength");<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> this.maxLength = maxLength;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> this.formatters = formatters;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> LOGGER.trace("new MaxLengthConverter with {}", maxLength);<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> @Override<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> public void format(final LogEvent event, final StringBuilder toAppendTo) {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> final int initialLength = toAppendTo.length();<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> for (int i = 0; i < formatters.size(); i++) {<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> final PatternFormatter formatter = formatters.get(i);<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> formatter.format(event, toAppendTo);<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> if (toAppendTo.length() > initialLength + maxLength) { // stop early<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> break;<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> }<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> }<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> if (toAppendTo.length() > initialLength + maxLength) {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> toAppendTo.setLength(initialLength + maxLength);<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> if (maxLength > 20) { // only append ellipses if length is not very short<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> toAppendTo.append("...");<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> }<a name="line.103"></a> |
| <span class="sourceLineNo">104</span>}<a name="line.104"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
