blob: 9ca68825e34cbbe8051c9ae84643a370fa85a7d8 [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.util.Arrays;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Objects;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.Core;<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.config.plugins.PluginElement;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.plugins.PluginFactory;<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> * Composite {@code PathCondition} that only accepts objects that are accepted by &lt;em&gt;all&lt;/em&gt; component conditions.<a name="line.30"></a>
<span class="sourceLineNo">031</span> * Corresponds to logical "AND".<a name="line.31"></a>
<span class="sourceLineNo">032</span> */<a name="line.32"></a>
<span class="sourceLineNo">033</span>@Plugin(name = "IfAll", category = Core.CATEGORY_NAME, printObject = true)<a name="line.33"></a>
<span class="sourceLineNo">034</span>public final class IfAll implements PathCondition {<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span> private final PathCondition[] components;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span> private IfAll(final PathCondition... filters) {<a name="line.38"></a>
<span class="sourceLineNo">039</span> this.components = Objects.requireNonNull(filters, "filters");<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> public PathCondition[] getDeleteFilters() {<a name="line.42"></a>
<span class="sourceLineNo">043</span> return components;<a name="line.43"></a>
<span class="sourceLineNo">044</span> }<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> * (non-Javadoc)<a name="line.47"></a>
<span class="sourceLineNo">048</span> *<a name="line.48"></a>
<span class="sourceLineNo">049</span> * @see org.apache.logging.log4j.core.appender.rolling.action.PathCondition#accept(java.nio.file.Path,<a name="line.49"></a>
<span class="sourceLineNo">050</span> * java.nio.file.Path, java.nio.file.attribute.BasicFileAttributes)<a name="line.50"></a>
<span class="sourceLineNo">051</span> */<a name="line.51"></a>
<span class="sourceLineNo">052</span> @Override<a name="line.52"></a>
<span class="sourceLineNo">053</span> public boolean accept(final Path baseDir, final Path relativePath, final BasicFileAttributes attrs) {<a name="line.53"></a>
<span class="sourceLineNo">054</span> if (components == null || components.length == 0) {<a name="line.54"></a>
<span class="sourceLineNo">055</span> return false; // unconditional delete not supported<a name="line.55"></a>
<span class="sourceLineNo">056</span> }<a name="line.56"></a>
<span class="sourceLineNo">057</span> return accept(components, baseDir, relativePath, attrs);<a name="line.57"></a>
<span class="sourceLineNo">058</span> }<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> * Returns {@code true} if all the specified conditions accept the specified path, {@code false} otherwise.<a name="line.61"></a>
<span class="sourceLineNo">062</span> *<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @param list the array of conditions to evaluate<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @param baseDir the directory from where to start scanning for deletion candidate files<a name="line.64"></a>
<span class="sourceLineNo">065</span> * @param relativePath the candidate for deletion. This path is relative to the baseDir.<a name="line.65"></a>
<span class="sourceLineNo">066</span> * @param attrs attributes of the candidate path<a name="line.66"></a>
<span class="sourceLineNo">067</span> * @return {@code true} if all the specified conditions accept the specified path, {@code false} otherwise<a name="line.67"></a>
<span class="sourceLineNo">068</span> * @throws NullPointerException if any of the parameters is {@code null}<a name="line.68"></a>
<span class="sourceLineNo">069</span> */<a name="line.69"></a>
<span class="sourceLineNo">070</span> public static boolean accept(final PathCondition[] list, final Path baseDir, final Path relativePath,<a name="line.70"></a>
<span class="sourceLineNo">071</span> final BasicFileAttributes attrs) {<a name="line.71"></a>
<span class="sourceLineNo">072</span> for (final PathCondition component : list) {<a name="line.72"></a>
<span class="sourceLineNo">073</span> if (!component.accept(baseDir, relativePath, attrs)) {<a name="line.73"></a>
<span class="sourceLineNo">074</span> return false;<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<a name="line.76"></a>
<span class="sourceLineNo">077</span> return true;<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> /*<a name="line.80"></a>
<span class="sourceLineNo">081</span> * (non-Javadoc)<a name="line.81"></a>
<span class="sourceLineNo">082</span> *<a name="line.82"></a>
<span class="sourceLineNo">083</span> * @see org.apache.logging.log4j.core.appender.rolling.action.PathCondition#beforeFileTreeWalk()<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 void beforeFileTreeWalk() {<a name="line.86"></a>
<span class="sourceLineNo">087</span> beforeFileTreeWalk(components);<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> /**<a name="line.90"></a>
<span class="sourceLineNo">091</span> * Calls {@link #beforeFileTreeWalk()} on all of the specified nested conditions.<a name="line.91"></a>
<span class="sourceLineNo">092</span> *<a name="line.92"></a>
<span class="sourceLineNo">093</span> * @param nestedConditions the conditions to call {@link #beforeFileTreeWalk()} on<a name="line.93"></a>
<span class="sourceLineNo">094</span> */<a name="line.94"></a>
<span class="sourceLineNo">095</span> public static void beforeFileTreeWalk(final PathCondition[] nestedConditions) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> for (final PathCondition condition : nestedConditions) {<a name="line.96"></a>
<span class="sourceLineNo">097</span> condition.beforeFileTreeWalk();<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><a name="line.100"></a>
<span class="sourceLineNo">101</span> /**<a name="line.101"></a>
<span class="sourceLineNo">102</span> * Create a Composite PathCondition whose components all need to accept before this condition accepts.<a name="line.102"></a>
<span class="sourceLineNo">103</span> *<a name="line.103"></a>
<span class="sourceLineNo">104</span> * @param components The component filters.<a name="line.104"></a>
<span class="sourceLineNo">105</span> * @return A Composite PathCondition.<a name="line.105"></a>
<span class="sourceLineNo">106</span> */<a name="line.106"></a>
<span class="sourceLineNo">107</span> @PluginFactory<a name="line.107"></a>
<span class="sourceLineNo">108</span> public static IfAll createAndCondition(<a name="line.108"></a>
<span class="sourceLineNo">109</span> @PluginElement("PathConditions") final PathCondition... components) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> return new IfAll(components);<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> @Override<a name="line.113"></a>
<span class="sourceLineNo">114</span> public String toString() {<a name="line.114"></a>
<span class="sourceLineNo">115</span> return "IfAll" + Arrays.toString(components);<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span>}<a name="line.117"></a>
</pre>
</div>
</body>
</html>