blob: 794a93ca179b3582667b7b37b3b281ac589a9a5c [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.appender.rolling.action;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.nio.file.Path;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.nio.file.attribute.BasicFileAttributes;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.nio.file.attribute.FileTime;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Arrays;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Collections;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.List;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Objects;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.Logger;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.Core;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.plugins.PluginAttribute;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.util.Clock;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.util.ClockFactory;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>/**<a name="line.37"></a>
<span class="sourceLineNo">038</span> * PathCondition that accepts paths that are older than the specified duration.<a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span>@Plugin(name = "IfLastModified", category = Core.CATEGORY_NAME, printObject = true)<a name="line.40"></a>
<span class="sourceLineNo">041</span>public final class IfLastModified implements PathCondition {<a name="line.41"></a>
<span class="sourceLineNo">042</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.42"></a>
<span class="sourceLineNo">043</span> private static final Clock CLOCK = ClockFactory.getClock();<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> private final Duration age;<a name="line.45"></a>
<span class="sourceLineNo">046</span> private final PathCondition[] nestedConditions;<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> private IfLastModified(final Duration age, final PathCondition[] nestedConditions) {<a name="line.48"></a>
<span class="sourceLineNo">049</span> this.age = Objects.requireNonNull(age, "age");<a name="line.49"></a>
<span class="sourceLineNo">050</span> this.nestedConditions = nestedConditions == null ? new PathCondition[0] : Arrays.copyOf(nestedConditions,<a name="line.50"></a>
<span class="sourceLineNo">051</span> nestedConditions.length);<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> public Duration getAge() {<a name="line.54"></a>
<span class="sourceLineNo">055</span> return age;<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> public List&lt;PathCondition&gt; getNestedConditions() {<a name="line.58"></a>
<span class="sourceLineNo">059</span> return Collections.unmodifiableList(Arrays.asList(nestedConditions));<a name="line.59"></a>
<span class="sourceLineNo">060</span> }<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> /*<a name="line.62"></a>
<span class="sourceLineNo">063</span> * (non-Javadoc)<a name="line.63"></a>
<span class="sourceLineNo">064</span> *<a name="line.64"></a>
<span class="sourceLineNo">065</span> * @see org.apache.logging.log4j.core.appender.rolling.action.PathCondition#accept(java.nio.file.Path,<a name="line.65"></a>
<span class="sourceLineNo">066</span> * java.nio.file.Path, java.nio.file.attribute.BasicFileAttributes)<a name="line.66"></a>
<span class="sourceLineNo">067</span> */<a name="line.67"></a>
<span class="sourceLineNo">068</span> @Override<a name="line.68"></a>
<span class="sourceLineNo">069</span> public boolean accept(final Path basePath, final Path relativePath, final BasicFileAttributes attrs) {<a name="line.69"></a>
<span class="sourceLineNo">070</span> final FileTime fileTime = attrs.lastModifiedTime();<a name="line.70"></a>
<span class="sourceLineNo">071</span> final long millis = fileTime.toMillis();<a name="line.71"></a>
<span class="sourceLineNo">072</span> final long ageMillis = CLOCK.currentTimeMillis() - millis;<a name="line.72"></a>
<span class="sourceLineNo">073</span> final boolean result = ageMillis &gt;= age.toMillis();<a name="line.73"></a>
<span class="sourceLineNo">074</span> final String match = result ? "&gt;=" : "&lt;";<a name="line.74"></a>
<span class="sourceLineNo">075</span> final String accept = result ? "ACCEPTED" : "REJECTED";<a name="line.75"></a>
<span class="sourceLineNo">076</span> LOGGER.trace("IfLastModified {}: {} ageMillis '{}' {} '{}'", accept, relativePath, ageMillis, match, age);<a name="line.76"></a>
<span class="sourceLineNo">077</span> if (result) {<a name="line.77"></a>
<span class="sourceLineNo">078</span> return IfAll.accept(nestedConditions, basePath, relativePath, attrs);<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span> return result;<a name="line.80"></a>
<span class="sourceLineNo">081</span> }<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> * (non-Javadoc)<a name="line.84"></a>
<span class="sourceLineNo">085</span> *<a name="line.85"></a>
<span class="sourceLineNo">086</span> * @see org.apache.logging.log4j.core.appender.rolling.action.PathCondition#beforeFileTreeWalk()<a name="line.86"></a>
<span class="sourceLineNo">087</span> */<a name="line.87"></a>
<span class="sourceLineNo">088</span> @Override<a name="line.88"></a>
<span class="sourceLineNo">089</span> public void beforeFileTreeWalk() {<a name="line.89"></a>
<span class="sourceLineNo">090</span> IfAll.beforeFileTreeWalk(nestedConditions);<a name="line.90"></a>
<span class="sourceLineNo">091</span> }<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span> /**<a name="line.93"></a>
<span class="sourceLineNo">094</span> * Create an IfLastModified condition.<a name="line.94"></a>
<span class="sourceLineNo">095</span> *<a name="line.95"></a>
<span class="sourceLineNo">096</span> * @param age The path age that is accepted by this condition. Must be a valid Duration.<a name="line.96"></a>
<span class="sourceLineNo">097</span> * @param nestedConditions nested conditions to evaluate if this condition accepts a path<a name="line.97"></a>
<span class="sourceLineNo">098</span> * @return An IfLastModified condition.<a name="line.98"></a>
<span class="sourceLineNo">099</span> */<a name="line.99"></a>
<span class="sourceLineNo">100</span> @PluginFactory<a name="line.100"></a>
<span class="sourceLineNo">101</span> public static IfLastModified createAgeCondition(<a name="line.101"></a>
<span class="sourceLineNo">102</span> // @formatter:off<a name="line.102"></a>
<span class="sourceLineNo">103</span> @PluginAttribute("age") final Duration age,<a name="line.103"></a>
<span class="sourceLineNo">104</span> @PluginElement("PathConditions") final PathCondition... nestedConditions) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> // @formatter:on<a name="line.105"></a>
<span class="sourceLineNo">106</span> return new IfLastModified(age, nestedConditions);<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> @Override<a name="line.109"></a>
<span class="sourceLineNo">110</span> public String toString() {<a name="line.110"></a>
<span class="sourceLineNo">111</span> final String nested = nestedConditions.length == 0 ? "" : " AND " + Arrays.toString(nestedConditions);<a name="line.111"></a>
<span class="sourceLineNo">112</span> return "IfLastModified(age=" + age + nested + ")";<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span>}<a name="line.114"></a>
</pre>
</div>
</body>
</html>