http://git-wip-us.apache.org/repos/asf/hbase-site/blob/45a663dd/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/BaseFileCleanerDelegate.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/BaseFileCleanerDelegate.html b/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/BaseFileCleanerDelegate.html index bf30889..bf4df84 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/BaseFileCleanerDelegate.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/BaseFileCleanerDelegate.html @@ -31,30 +31,37 @@ <span class="sourceLineNo">023</span>import com.google.common.base.Predicate;<a name="line.23"></a> <span class="sourceLineNo">024</span>import com.google.common.collect.Iterables;<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> * Base class for file cleaners which allows subclasses to implement a simple<a name="line.27"></a> -<span class="sourceLineNo">028</span> * isFileDeletable method (which used to be the FileCleanerDelegate contract).<a name="line.28"></a> -<span class="sourceLineNo">029</span> */<a name="line.29"></a> -<span class="sourceLineNo">030</span>public abstract class BaseFileCleanerDelegate extends BaseConfigurable<a name="line.30"></a> -<span class="sourceLineNo">031</span>implements FileCleanerDelegate {<a name="line.31"></a> -<span class="sourceLineNo">032</span><a name="line.32"></a> -<span class="sourceLineNo">033</span> @Override<a name="line.33"></a> -<span class="sourceLineNo">034</span> public Iterable<FileStatus> getDeletableFiles(Iterable<FileStatus> files) {<a name="line.34"></a> -<span class="sourceLineNo">035</span> return Iterables.filter(files, new Predicate<FileStatus>() {<a name="line.35"></a> -<span class="sourceLineNo">036</span> @Override<a name="line.36"></a> -<span class="sourceLineNo">037</span> public boolean apply(FileStatus file) {<a name="line.37"></a> -<span class="sourceLineNo">038</span> return isFileDeletable(file);<a name="line.38"></a> -<span class="sourceLineNo">039</span> }});<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> /**<a name="line.42"></a> -<span class="sourceLineNo">043</span> * Should the master delete the file or keep it?<a name="line.43"></a> -<span class="sourceLineNo">044</span> * @param fStat file status of the file to check<a name="line.44"></a> -<span class="sourceLineNo">045</span> * @return <tt>true</tt> if the file is deletable, <tt>false</tt> if not<a name="line.45"></a> -<span class="sourceLineNo">046</span> */<a name="line.46"></a> -<span class="sourceLineNo">047</span> protected abstract boolean isFileDeletable(FileStatus fStat);<a name="line.47"></a> +<span class="sourceLineNo">026</span>import java.util.Map;<a name="line.26"></a> +<span class="sourceLineNo">027</span><a name="line.27"></a> +<span class="sourceLineNo">028</span>/**<a name="line.28"></a> +<span class="sourceLineNo">029</span> * Base class for file cleaners which allows subclasses to implement a simple<a name="line.29"></a> +<span class="sourceLineNo">030</span> * isFileDeletable method (which used to be the FileCleanerDelegate contract).<a name="line.30"></a> +<span class="sourceLineNo">031</span> */<a name="line.31"></a> +<span class="sourceLineNo">032</span>public abstract class BaseFileCleanerDelegate extends BaseConfigurable<a name="line.32"></a> +<span class="sourceLineNo">033</span>implements FileCleanerDelegate {<a name="line.33"></a> +<span class="sourceLineNo">034</span><a name="line.34"></a> +<span class="sourceLineNo">035</span> @Override<a name="line.35"></a> +<span class="sourceLineNo">036</span> public Iterable<FileStatus> getDeletableFiles(Iterable<FileStatus> files) {<a name="line.36"></a> +<span class="sourceLineNo">037</span> return Iterables.filter(files, new Predicate<FileStatus>() {<a name="line.37"></a> +<span class="sourceLineNo">038</span> @Override<a name="line.38"></a> +<span class="sourceLineNo">039</span> public boolean apply(FileStatus file) {<a name="line.39"></a> +<span class="sourceLineNo">040</span> return isFileDeletable(file);<a name="line.40"></a> +<span class="sourceLineNo">041</span> }});<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> @Override<a name="line.44"></a> +<span class="sourceLineNo">045</span> public void init(Map<String, Object> params) {<a name="line.45"></a> +<span class="sourceLineNo">046</span> // subclass could override it if needed.<a name="line.46"></a> +<span class="sourceLineNo">047</span> }<a name="line.47"></a> <span class="sourceLineNo">048</span><a name="line.48"></a> -<span class="sourceLineNo">049</span>}<a name="line.49"></a> +<span class="sourceLineNo">049</span> /**<a name="line.49"></a> +<span class="sourceLineNo">050</span> * Should the master delete the file or keep it?<a name="line.50"></a> +<span class="sourceLineNo">051</span> * @param fStat file status of the file to check<a name="line.51"></a> +<span class="sourceLineNo">052</span> * @return <tt>true</tt> if the file is deletable, <tt>false</tt> if not<a name="line.52"></a> +<span class="sourceLineNo">053</span> */<a name="line.53"></a> +<span class="sourceLineNo">054</span> protected abstract boolean isFileDeletable(FileStatus fStat);<a name="line.54"></a> +<span class="sourceLineNo">055</span><a name="line.55"></a> +<span class="sourceLineNo">056</span>}<a name="line.56"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/45a663dd/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/CleanerChore.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/CleanerChore.html b/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/CleanerChore.html index 18846d0..8b149ba 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/CleanerChore.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/CleanerChore.html @@ -25,10 +25,10 @@ <span class="sourceLineNo">017</span> */<a name="line.17"></a> <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.master.cleaner;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import java.util.LinkedList;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a> -<span class="sourceLineNo">023</span><a name="line.23"></a> +<span class="sourceLineNo">020</span>import com.google.common.annotations.VisibleForTesting;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import com.google.common.collect.ImmutableSet;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import com.google.common.collect.Iterables;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import com.google.common.collect.Lists;<a name="line.23"></a> <span class="sourceLineNo">024</span>import org.apache.commons.logging.Log;<a name="line.24"></a> <span class="sourceLineNo">025</span>import org.apache.commons.logging.LogFactory;<a name="line.25"></a> <span class="sourceLineNo">026</span>import org.apache.hadoop.conf.Configuration;<a name="line.26"></a> @@ -40,10 +40,10 @@ <span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.util.FSUtils;<a name="line.32"></a> <span class="sourceLineNo">033</span>import org.apache.hadoop.ipc.RemoteException;<a name="line.33"></a> <span class="sourceLineNo">034</span><a name="line.34"></a> -<span class="sourceLineNo">035</span>import com.google.common.annotations.VisibleForTesting;<a name="line.35"></a> -<span class="sourceLineNo">036</span>import com.google.common.collect.ImmutableSet;<a name="line.36"></a> -<span class="sourceLineNo">037</span>import com.google.common.collect.Iterables;<a name="line.37"></a> -<span class="sourceLineNo">038</span>import com.google.common.collect.Lists;<a name="line.38"></a> +<span class="sourceLineNo">035</span>import java.io.IOException;<a name="line.35"></a> +<span class="sourceLineNo">036</span>import java.util.LinkedList;<a name="line.36"></a> +<span class="sourceLineNo">037</span>import java.util.List;<a name="line.37"></a> +<span class="sourceLineNo">038</span>import java.util.Map;<a name="line.38"></a> <span class="sourceLineNo">039</span><a name="line.39"></a> <span class="sourceLineNo">040</span>/**<a name="line.40"></a> <span class="sourceLineNo">041</span> * Abstract Cleaner that uses a chain of delegates to clean a directory of files<a name="line.41"></a> @@ -57,240 +57,249 @@ <span class="sourceLineNo">049</span> private final Path oldFileDir;<a name="line.49"></a> <span class="sourceLineNo">050</span> private final Configuration conf;<a name="line.50"></a> <span class="sourceLineNo">051</span> protected List<T> cleanersChain;<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> * @param name name of the chore being run<a name="line.54"></a> -<span class="sourceLineNo">055</span> * @param sleepPeriod the period of time to sleep between each run<a name="line.55"></a> -<span class="sourceLineNo">056</span> * @param s the stopper<a name="line.56"></a> -<span class="sourceLineNo">057</span> * @param conf configuration to use<a name="line.57"></a> -<span class="sourceLineNo">058</span> * @param fs handle to the FS<a name="line.58"></a> -<span class="sourceLineNo">059</span> * @param oldFileDir the path to the archived files<a name="line.59"></a> -<span class="sourceLineNo">060</span> * @param confKey configuration key for the classes to instantiate<a name="line.60"></a> -<span class="sourceLineNo">061</span> */<a name="line.61"></a> -<span class="sourceLineNo">062</span> public CleanerChore(String name, final int sleepPeriod, final Stoppable s, Configuration conf,<a name="line.62"></a> -<span class="sourceLineNo">063</span> FileSystem fs, Path oldFileDir, String confKey) {<a name="line.63"></a> -<span class="sourceLineNo">064</span> super(name, s, sleepPeriod);<a name="line.64"></a> -<span class="sourceLineNo">065</span> this.fs = fs;<a name="line.65"></a> -<span class="sourceLineNo">066</span> this.oldFileDir = oldFileDir;<a name="line.66"></a> -<span class="sourceLineNo">067</span> this.conf = conf;<a name="line.67"></a> -<span class="sourceLineNo">068</span><a name="line.68"></a> -<span class="sourceLineNo">069</span> initCleanerChain(confKey);<a name="line.69"></a> -<span class="sourceLineNo">070</span> }<a name="line.70"></a> -<span class="sourceLineNo">071</span><a name="line.71"></a> -<span class="sourceLineNo">072</span> /**<a name="line.72"></a> -<span class="sourceLineNo">073</span> * Validate the file to see if it even belongs in the directory. If it is valid, then the file<a name="line.73"></a> -<span class="sourceLineNo">074</span> * will go through the cleaner delegates, but otherwise the file is just deleted.<a name="line.74"></a> -<span class="sourceLineNo">075</span> * @param file full {@link Path} of the file to be checked<a name="line.75"></a> -<span class="sourceLineNo">076</span> * @return <tt>true</tt> if the file is valid, <tt>false</tt> otherwise<a name="line.76"></a> -<span class="sourceLineNo">077</span> */<a name="line.77"></a> -<span class="sourceLineNo">078</span> protected abstract boolean validate(Path file);<a name="line.78"></a> +<span class="sourceLineNo">052</span> protected Map<String, Object> params;<a name="line.52"></a> +<span class="sourceLineNo">053</span><a name="line.53"></a> +<span class="sourceLineNo">054</span> public CleanerChore(String name, final int sleepPeriod, final Stoppable s, Configuration conf,<a name="line.54"></a> +<span class="sourceLineNo">055</span> FileSystem fs, Path oldFileDir, String confKey) {<a name="line.55"></a> +<span class="sourceLineNo">056</span> this(name, sleepPeriod, s, conf, fs, oldFileDir, confKey, null);<a name="line.56"></a> +<span class="sourceLineNo">057</span> }<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> * @param name name of the chore being run<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @param sleepPeriod the period of time to sleep between each run<a name="line.61"></a> +<span class="sourceLineNo">062</span> * @param s the stopper<a name="line.62"></a> +<span class="sourceLineNo">063</span> * @param conf configuration to use<a name="line.63"></a> +<span class="sourceLineNo">064</span> * @param fs handle to the FS<a name="line.64"></a> +<span class="sourceLineNo">065</span> * @param oldFileDir the path to the archived files<a name="line.65"></a> +<span class="sourceLineNo">066</span> * @param confKey configuration key for the classes to instantiate<a name="line.66"></a> +<span class="sourceLineNo">067</span> * @param params members could be used in cleaner<a name="line.67"></a> +<span class="sourceLineNo">068</span> */<a name="line.68"></a> +<span class="sourceLineNo">069</span> public CleanerChore(String name, final int sleepPeriod, final Stoppable s, Configuration conf,<a name="line.69"></a> +<span class="sourceLineNo">070</span> FileSystem fs, Path oldFileDir, String confKey, Map<String, Object> params) {<a name="line.70"></a> +<span class="sourceLineNo">071</span> super(name, s, sleepPeriod);<a name="line.71"></a> +<span class="sourceLineNo">072</span> this.fs = fs;<a name="line.72"></a> +<span class="sourceLineNo">073</span> this.oldFileDir = oldFileDir;<a name="line.73"></a> +<span class="sourceLineNo">074</span> this.conf = conf;<a name="line.74"></a> +<span class="sourceLineNo">075</span> this.params = params;<a name="line.75"></a> +<span class="sourceLineNo">076</span> initCleanerChain(confKey);<a name="line.76"></a> +<span class="sourceLineNo">077</span> }<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> * Instantiate and initialize all the file cleaners set in the configuration<a name="line.81"></a> -<span class="sourceLineNo">082</span> * @param confKey key to get the file cleaner classes from the configuration<a name="line.82"></a> -<span class="sourceLineNo">083</span> */<a name="line.83"></a> -<span class="sourceLineNo">084</span> private void initCleanerChain(String confKey) {<a name="line.84"></a> -<span class="sourceLineNo">085</span> this.cleanersChain = new LinkedList<T>();<a name="line.85"></a> -<span class="sourceLineNo">086</span> String[] logCleaners = conf.getStrings(confKey);<a name="line.86"></a> -<span class="sourceLineNo">087</span> if (logCleaners != null) {<a name="line.87"></a> -<span class="sourceLineNo">088</span> for (String className : logCleaners) {<a name="line.88"></a> -<span class="sourceLineNo">089</span> T logCleaner = newFileCleaner(className, conf);<a name="line.89"></a> -<span class="sourceLineNo">090</span> if (logCleaner != null) {<a name="line.90"></a> -<span class="sourceLineNo">091</span> LOG.debug("initialize cleaner=" + className);<a name="line.91"></a> -<span class="sourceLineNo">092</span> this.cleanersChain.add(logCleaner);<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> }<a name="line.96"></a> -<span class="sourceLineNo">097</span><a name="line.97"></a> -<span class="sourceLineNo">098</span> /**<a name="line.98"></a> -<span class="sourceLineNo">099</span> * A utility method to create new instances of LogCleanerDelegate based on the class name of the<a name="line.99"></a> -<span class="sourceLineNo">100</span> * LogCleanerDelegate.<a name="line.100"></a> -<span class="sourceLineNo">101</span> * @param className fully qualified class name of the LogCleanerDelegate<a name="line.101"></a> -<span class="sourceLineNo">102</span> * @param conf<a name="line.102"></a> -<span class="sourceLineNo">103</span> * @return the new instance<a name="line.103"></a> -<span class="sourceLineNo">104</span> */<a name="line.104"></a> -<span class="sourceLineNo">105</span> private T newFileCleaner(String className, Configuration conf) {<a name="line.105"></a> -<span class="sourceLineNo">106</span> try {<a name="line.106"></a> -<span class="sourceLineNo">107</span> Class<? extends FileCleanerDelegate> c = Class.forName(className).asSubclass(<a name="line.107"></a> -<span class="sourceLineNo">108</span> FileCleanerDelegate.class);<a name="line.108"></a> -<span class="sourceLineNo">109</span> @SuppressWarnings("unchecked")<a name="line.109"></a> -<span class="sourceLineNo">110</span> T cleaner = (T) c.newInstance();<a name="line.110"></a> -<span class="sourceLineNo">111</span> cleaner.setConf(conf);<a name="line.111"></a> -<span class="sourceLineNo">112</span> return cleaner;<a name="line.112"></a> -<span class="sourceLineNo">113</span> } catch (Exception e) {<a name="line.113"></a> -<span class="sourceLineNo">114</span> LOG.warn("Can NOT create CleanerDelegate: " + className, e);<a name="line.114"></a> -<span class="sourceLineNo">115</span> // skipping if can't instantiate<a name="line.115"></a> -<span class="sourceLineNo">116</span> return null;<a name="line.116"></a> -<span class="sourceLineNo">117</span> }<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> @Override<a name="line.120"></a> -<span class="sourceLineNo">121</span> protected void chore() {<a name="line.121"></a> -<span class="sourceLineNo">122</span> try {<a name="line.122"></a> -<span class="sourceLineNo">123</span> FileStatus[] files = FSUtils.listStatus(this.fs, this.oldFileDir);<a name="line.123"></a> -<span class="sourceLineNo">124</span> checkAndDeleteEntries(files);<a name="line.124"></a> -<span class="sourceLineNo">125</span> } catch (IOException e) {<a name="line.125"></a> -<span class="sourceLineNo">126</span> e = e instanceof RemoteException ?<a name="line.126"></a> -<span class="sourceLineNo">127</span> ((RemoteException)e).unwrapRemoteException() : e;<a name="line.127"></a> -<span class="sourceLineNo">128</span> LOG.warn("Error while cleaning the logs", e);<a name="line.128"></a> -<span class="sourceLineNo">129</span> }<a name="line.129"></a> -<span class="sourceLineNo">130</span> }<a name="line.130"></a> -<span class="sourceLineNo">131</span><a name="line.131"></a> -<span class="sourceLineNo">132</span> /**<a name="line.132"></a> -<span class="sourceLineNo">133</span> * Loop over the given directory entries, and check whether they can be deleted.<a name="line.133"></a> -<span class="sourceLineNo">134</span> * If an entry is itself a directory it will be recursively checked and deleted itself iff<a name="line.134"></a> -<span class="sourceLineNo">135</span> * all subentries are deleted (and no new subentries are added in the mean time)<a name="line.135"></a> -<span class="sourceLineNo">136</span> *<a name="line.136"></a> -<span class="sourceLineNo">137</span> * @param entries directory entries to check<a name="line.137"></a> -<span class="sourceLineNo">138</span> * @return true if all entries were successfully deleted<a name="line.138"></a> -<span class="sourceLineNo">139</span> */<a name="line.139"></a> -<span class="sourceLineNo">140</span> private boolean checkAndDeleteEntries(FileStatus[] entries) {<a name="line.140"></a> -<span class="sourceLineNo">141</span> if (entries == null) {<a name="line.141"></a> -<span class="sourceLineNo">142</span> return true;<a name="line.142"></a> -<span class="sourceLineNo">143</span> }<a name="line.143"></a> -<span class="sourceLineNo">144</span> boolean allEntriesDeleted = true;<a name="line.144"></a> -<span class="sourceLineNo">145</span> List<FileStatus> files = Lists.newArrayListWithCapacity(entries.length);<a name="line.145"></a> -<span class="sourceLineNo">146</span> for (FileStatus child : entries) {<a name="line.146"></a> -<span class="sourceLineNo">147</span> Path path = child.getPath();<a name="line.147"></a> -<span class="sourceLineNo">148</span> if (child.isDirectory()) {<a name="line.148"></a> -<span class="sourceLineNo">149</span> // for each subdirectory delete it and all entries if possible<a name="line.149"></a> -<span class="sourceLineNo">150</span> if (!checkAndDeleteDirectory(path)) {<a name="line.150"></a> -<span class="sourceLineNo">151</span> allEntriesDeleted = false;<a name="line.151"></a> -<span class="sourceLineNo">152</span> }<a name="line.152"></a> -<span class="sourceLineNo">153</span> } else {<a name="line.153"></a> -<span class="sourceLineNo">154</span> // collect all files to attempt to delete in one batch<a name="line.154"></a> -<span class="sourceLineNo">155</span> files.add(child);<a name="line.155"></a> -<span class="sourceLineNo">156</span> }<a name="line.156"></a> -<span class="sourceLineNo">157</span> }<a name="line.157"></a> -<span class="sourceLineNo">158</span> if (!checkAndDeleteFiles(files)) {<a name="line.158"></a> -<span class="sourceLineNo">159</span> allEntriesDeleted = false;<a name="line.159"></a> -<span class="sourceLineNo">160</span> }<a name="line.160"></a> -<span class="sourceLineNo">161</span> return allEntriesDeleted;<a name="line.161"></a> -<span class="sourceLineNo">162</span> }<a name="line.162"></a> -<span class="sourceLineNo">163</span> <a name="line.163"></a> -<span class="sourceLineNo">164</span> /**<a name="line.164"></a> -<span class="sourceLineNo">165</span> * Attempt to delete a directory and all files under that directory. Each child file is passed<a name="line.165"></a> -<span class="sourceLineNo">166</span> * through the delegates to see if it can be deleted. If the directory has no children when the<a name="line.166"></a> -<span class="sourceLineNo">167</span> * cleaners have finished it is deleted.<a name="line.167"></a> -<span class="sourceLineNo">168</span> * <p><a name="line.168"></a> -<span class="sourceLineNo">169</span> * If new children files are added between checks of the directory, the directory will <b>not</b><a name="line.169"></a> -<span class="sourceLineNo">170</span> * be deleted.<a name="line.170"></a> -<span class="sourceLineNo">171</span> * @param dir directory to check<a name="line.171"></a> -<span class="sourceLineNo">172</span> * @return <tt>true</tt> if the directory was deleted, <tt>false</tt> otherwise.<a name="line.172"></a> -<span class="sourceLineNo">173</span> */<a name="line.173"></a> -<span class="sourceLineNo">174</span> @VisibleForTesting boolean checkAndDeleteDirectory(Path dir) {<a name="line.174"></a> -<span class="sourceLineNo">175</span> if (LOG.isTraceEnabled()) {<a name="line.175"></a> -<span class="sourceLineNo">176</span> LOG.trace("Checking directory: " + dir);<a name="line.176"></a> -<span class="sourceLineNo">177</span> }<a name="line.177"></a> -<span class="sourceLineNo">178</span><a name="line.178"></a> -<span class="sourceLineNo">179</span> try {<a name="line.179"></a> -<span class="sourceLineNo">180</span> FileStatus[] children = FSUtils.listStatus(fs, dir);<a name="line.180"></a> -<span class="sourceLineNo">181</span> boolean allChildrenDeleted = checkAndDeleteEntries(children);<a name="line.181"></a> -<span class="sourceLineNo">182</span> <a name="line.182"></a> -<span class="sourceLineNo">183</span> // if the directory still has children, we can't delete it, so we are done<a name="line.183"></a> -<span class="sourceLineNo">184</span> if (!allChildrenDeleted) return false;<a name="line.184"></a> -<span class="sourceLineNo">185</span> } catch (IOException e) {<a name="line.185"></a> -<span class="sourceLineNo">186</span> e = e instanceof RemoteException ?<a name="line.186"></a> -<span class="sourceLineNo">187</span> ((RemoteException)e).unwrapRemoteException() : e;<a name="line.187"></a> -<span class="sourceLineNo">188</span> LOG.warn("Error while listing directory: " + dir, e);<a name="line.188"></a> -<span class="sourceLineNo">189</span> // couldn't list directory, so don't try to delete, and don't return success<a name="line.189"></a> -<span class="sourceLineNo">190</span> return false;<a name="line.190"></a> -<span class="sourceLineNo">191</span> }<a name="line.191"></a> -<span class="sourceLineNo">192</span><a name="line.192"></a> -<span class="sourceLineNo">193</span> // otherwise, all the children (that we know about) have been deleted, so we should try to<a name="line.193"></a> -<span class="sourceLineNo">194</span> // delete this directory. However, don't do so recursively so we don't delete files that have<a name="line.194"></a> -<span class="sourceLineNo">195</span> // been added since we last checked.<a name="line.195"></a> -<span class="sourceLineNo">196</span> try {<a name="line.196"></a> -<span class="sourceLineNo">197</span> return fs.delete(dir, false);<a name="line.197"></a> -<span class="sourceLineNo">198</span> } catch (IOException e) {<a name="line.198"></a> -<span class="sourceLineNo">199</span> if (LOG.isTraceEnabled()) {<a name="line.199"></a> -<span class="sourceLineNo">200</span> LOG.trace("Couldn't delete directory: " + dir, e);<a name="line.200"></a> -<span class="sourceLineNo">201</span> }<a name="line.201"></a> -<span class="sourceLineNo">202</span> // couldn't delete w/o exception, so we can't return success.<a name="line.202"></a> -<span class="sourceLineNo">203</span> return false;<a name="line.203"></a> -<span class="sourceLineNo">204</span> }<a name="line.204"></a> -<span class="sourceLineNo">205</span> }<a name="line.205"></a> -<span class="sourceLineNo">206</span><a name="line.206"></a> -<span class="sourceLineNo">207</span> /**<a name="line.207"></a> -<span class="sourceLineNo">208</span> * Run the given files through each of the cleaners to see if it should be deleted, deleting it if<a name="line.208"></a> -<span class="sourceLineNo">209</span> * necessary.<a name="line.209"></a> -<span class="sourceLineNo">210</span> * @param files List of FileStatus for the files to check (and possibly delete)<a name="line.210"></a> -<span class="sourceLineNo">211</span> * @return true iff successfully deleted all files<a name="line.211"></a> -<span class="sourceLineNo">212</span> */<a name="line.212"></a> -<span class="sourceLineNo">213</span> private boolean checkAndDeleteFiles(List<FileStatus> files) {<a name="line.213"></a> -<span class="sourceLineNo">214</span> // first check to see if the path is valid<a name="line.214"></a> -<span class="sourceLineNo">215</span> List<FileStatus> validFiles = Lists.newArrayListWithCapacity(files.size());<a name="line.215"></a> -<span class="sourceLineNo">216</span> List<FileStatus> invalidFiles = Lists.newArrayList();<a name="line.216"></a> -<span class="sourceLineNo">217</span> for (FileStatus file : files) {<a name="line.217"></a> -<span class="sourceLineNo">218</span> if (validate(file.getPath())) {<a name="line.218"></a> -<span class="sourceLineNo">219</span> validFiles.add(file);<a name="line.219"></a> -<span class="sourceLineNo">220</span> } else {<a name="line.220"></a> -<span class="sourceLineNo">221</span> LOG.warn("Found a wrongly formatted file: " + file.getPath() + " - will delete it.");<a name="line.221"></a> -<span class="sourceLineNo">222</span> invalidFiles.add(file);<a name="line.222"></a> -<span class="sourceLineNo">223</span> }<a name="line.223"></a> -<span class="sourceLineNo">224</span> }<a name="line.224"></a> -<span class="sourceLineNo">225</span><a name="line.225"></a> -<span class="sourceLineNo">226</span> Iterable<FileStatus> deletableValidFiles = validFiles;<a name="line.226"></a> -<span class="sourceLineNo">227</span> // check each of the cleaners for the valid files<a name="line.227"></a> -<span class="sourceLineNo">228</span> for (T cleaner : cleanersChain) {<a name="line.228"></a> -<span class="sourceLineNo">229</span> if (cleaner.isStopped() || this.getStopper().isStopped()) {<a name="line.229"></a> -<span class="sourceLineNo">230</span> LOG.warn("A file cleaner" + this.getName() + " is stopped, won't delete any more files in:"<a name="line.230"></a> -<span class="sourceLineNo">231</span> + this.oldFileDir);<a name="line.231"></a> -<span class="sourceLineNo">232</span> return false;<a name="line.232"></a> -<span class="sourceLineNo">233</span> }<a name="line.233"></a> +<span class="sourceLineNo">081</span> * Validate the file to see if it even belongs in the directory. If it is valid, then the file<a name="line.81"></a> +<span class="sourceLineNo">082</span> * will go through the cleaner delegates, but otherwise the file is just deleted.<a name="line.82"></a> +<span class="sourceLineNo">083</span> * @param file full {@link Path} of the file to be checked<a name="line.83"></a> +<span class="sourceLineNo">084</span> * @return <tt>true</tt> if the file is valid, <tt>false</tt> otherwise<a name="line.84"></a> +<span class="sourceLineNo">085</span> */<a name="line.85"></a> +<span class="sourceLineNo">086</span> protected abstract boolean validate(Path file);<a name="line.86"></a> +<span class="sourceLineNo">087</span><a name="line.87"></a> +<span class="sourceLineNo">088</span> /**<a name="line.88"></a> +<span class="sourceLineNo">089</span> * Instantiate and initialize all the file cleaners set in the configuration<a name="line.89"></a> +<span class="sourceLineNo">090</span> * @param confKey key to get the file cleaner classes from the configuration<a name="line.90"></a> +<span class="sourceLineNo">091</span> */<a name="line.91"></a> +<span class="sourceLineNo">092</span> private void initCleanerChain(String confKey) {<a name="line.92"></a> +<span class="sourceLineNo">093</span> this.cleanersChain = new LinkedList<T>();<a name="line.93"></a> +<span class="sourceLineNo">094</span> String[] logCleaners = conf.getStrings(confKey);<a name="line.94"></a> +<span class="sourceLineNo">095</span> if (logCleaners != null) {<a name="line.95"></a> +<span class="sourceLineNo">096</span> for (String className : logCleaners) {<a name="line.96"></a> +<span class="sourceLineNo">097</span> T logCleaner = newFileCleaner(className, conf);<a name="line.97"></a> +<span class="sourceLineNo">098</span> if (logCleaner != null) {<a name="line.98"></a> +<span class="sourceLineNo">099</span> LOG.debug("initialize cleaner=" + className);<a name="line.99"></a> +<span class="sourceLineNo">100</span> this.cleanersChain.add(logCleaner);<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> +<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> * A utility method to create new instances of LogCleanerDelegate based on the class name of the<a name="line.107"></a> +<span class="sourceLineNo">108</span> * LogCleanerDelegate.<a name="line.108"></a> +<span class="sourceLineNo">109</span> * @param className fully qualified class name of the LogCleanerDelegate<a name="line.109"></a> +<span class="sourceLineNo">110</span> * @param conf<a name="line.110"></a> +<span class="sourceLineNo">111</span> * @return the new instance<a name="line.111"></a> +<span class="sourceLineNo">112</span> */<a name="line.112"></a> +<span class="sourceLineNo">113</span> private T newFileCleaner(String className, Configuration conf) {<a name="line.113"></a> +<span class="sourceLineNo">114</span> try {<a name="line.114"></a> +<span class="sourceLineNo">115</span> Class<? extends FileCleanerDelegate> c = Class.forName(className).asSubclass(<a name="line.115"></a> +<span class="sourceLineNo">116</span> FileCleanerDelegate.class);<a name="line.116"></a> +<span class="sourceLineNo">117</span> @SuppressWarnings("unchecked")<a name="line.117"></a> +<span class="sourceLineNo">118</span> T cleaner = (T) c.newInstance();<a name="line.118"></a> +<span class="sourceLineNo">119</span> cleaner.setConf(conf);<a name="line.119"></a> +<span class="sourceLineNo">120</span> cleaner.init(this.params);<a name="line.120"></a> +<span class="sourceLineNo">121</span> return cleaner;<a name="line.121"></a> +<span class="sourceLineNo">122</span> } catch (Exception e) {<a name="line.122"></a> +<span class="sourceLineNo">123</span> LOG.warn("Can NOT create CleanerDelegate: " + className, e);<a name="line.123"></a> +<span class="sourceLineNo">124</span> // skipping if can't instantiate<a name="line.124"></a> +<span class="sourceLineNo">125</span> return null;<a name="line.125"></a> +<span class="sourceLineNo">126</span> }<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> @Override<a name="line.129"></a> +<span class="sourceLineNo">130</span> protected void chore() {<a name="line.130"></a> +<span class="sourceLineNo">131</span> try {<a name="line.131"></a> +<span class="sourceLineNo">132</span> FileStatus[] files = FSUtils.listStatus(this.fs, this.oldFileDir);<a name="line.132"></a> +<span class="sourceLineNo">133</span> checkAndDeleteEntries(files);<a name="line.133"></a> +<span class="sourceLineNo">134</span> } catch (IOException e) {<a name="line.134"></a> +<span class="sourceLineNo">135</span> e = e instanceof RemoteException ?<a name="line.135"></a> +<span class="sourceLineNo">136</span> ((RemoteException)e).unwrapRemoteException() : e;<a name="line.136"></a> +<span class="sourceLineNo">137</span> LOG.warn("Error while cleaning the logs", e);<a name="line.137"></a> +<span class="sourceLineNo">138</span> }<a name="line.138"></a> +<span class="sourceLineNo">139</span> }<a name="line.139"></a> +<span class="sourceLineNo">140</span><a name="line.140"></a> +<span class="sourceLineNo">141</span> /**<a name="line.141"></a> +<span class="sourceLineNo">142</span> * Loop over the given directory entries, and check whether they can be deleted.<a name="line.142"></a> +<span class="sourceLineNo">143</span> * If an entry is itself a directory it will be recursively checked and deleted itself iff<a name="line.143"></a> +<span class="sourceLineNo">144</span> * all subentries are deleted (and no new subentries are added in the mean time)<a name="line.144"></a> +<span class="sourceLineNo">145</span> *<a name="line.145"></a> +<span class="sourceLineNo">146</span> * @param entries directory entries to check<a name="line.146"></a> +<span class="sourceLineNo">147</span> * @return true if all entries were successfully deleted<a name="line.147"></a> +<span class="sourceLineNo">148</span> */<a name="line.148"></a> +<span class="sourceLineNo">149</span> private boolean checkAndDeleteEntries(FileStatus[] entries) {<a name="line.149"></a> +<span class="sourceLineNo">150</span> if (entries == null) {<a name="line.150"></a> +<span class="sourceLineNo">151</span> return true;<a name="line.151"></a> +<span class="sourceLineNo">152</span> }<a name="line.152"></a> +<span class="sourceLineNo">153</span> boolean allEntriesDeleted = true;<a name="line.153"></a> +<span class="sourceLineNo">154</span> List<FileStatus> files = Lists.newArrayListWithCapacity(entries.length);<a name="line.154"></a> +<span class="sourceLineNo">155</span> for (FileStatus child : entries) {<a name="line.155"></a> +<span class="sourceLineNo">156</span> Path path = child.getPath();<a name="line.156"></a> +<span class="sourceLineNo">157</span> if (child.isDirectory()) {<a name="line.157"></a> +<span class="sourceLineNo">158</span> // for each subdirectory delete it and all entries if possible<a name="line.158"></a> +<span class="sourceLineNo">159</span> if (!checkAndDeleteDirectory(path)) {<a name="line.159"></a> +<span class="sourceLineNo">160</span> allEntriesDeleted = false;<a name="line.160"></a> +<span class="sourceLineNo">161</span> }<a name="line.161"></a> +<span class="sourceLineNo">162</span> } else {<a name="line.162"></a> +<span class="sourceLineNo">163</span> // collect all files to attempt to delete in one batch<a name="line.163"></a> +<span class="sourceLineNo">164</span> files.add(child);<a name="line.164"></a> +<span class="sourceLineNo">165</span> }<a name="line.165"></a> +<span class="sourceLineNo">166</span> }<a name="line.166"></a> +<span class="sourceLineNo">167</span> if (!checkAndDeleteFiles(files)) {<a name="line.167"></a> +<span class="sourceLineNo">168</span> allEntriesDeleted = false;<a name="line.168"></a> +<span class="sourceLineNo">169</span> }<a name="line.169"></a> +<span class="sourceLineNo">170</span> return allEntriesDeleted;<a name="line.170"></a> +<span class="sourceLineNo">171</span> }<a name="line.171"></a> +<span class="sourceLineNo">172</span> <a name="line.172"></a> +<span class="sourceLineNo">173</span> /**<a name="line.173"></a> +<span class="sourceLineNo">174</span> * Attempt to delete a directory and all files under that directory. Each child file is passed<a name="line.174"></a> +<span class="sourceLineNo">175</span> * through the delegates to see if it can be deleted. If the directory has no children when the<a name="line.175"></a> +<span class="sourceLineNo">176</span> * cleaners have finished it is deleted.<a name="line.176"></a> +<span class="sourceLineNo">177</span> * <p><a name="line.177"></a> +<span class="sourceLineNo">178</span> * If new children files are added between checks of the directory, the directory will <b>not</b><a name="line.178"></a> +<span class="sourceLineNo">179</span> * be deleted.<a name="line.179"></a> +<span class="sourceLineNo">180</span> * @param dir directory to check<a name="line.180"></a> +<span class="sourceLineNo">181</span> * @return <tt>true</tt> if the directory was deleted, <tt>false</tt> otherwise.<a name="line.181"></a> +<span class="sourceLineNo">182</span> */<a name="line.182"></a> +<span class="sourceLineNo">183</span> @VisibleForTesting boolean checkAndDeleteDirectory(Path dir) {<a name="line.183"></a> +<span class="sourceLineNo">184</span> if (LOG.isTraceEnabled()) {<a name="line.184"></a> +<span class="sourceLineNo">185</span> LOG.trace("Checking directory: " + dir);<a name="line.185"></a> +<span class="sourceLineNo">186</span> }<a name="line.186"></a> +<span class="sourceLineNo">187</span><a name="line.187"></a> +<span class="sourceLineNo">188</span> try {<a name="line.188"></a> +<span class="sourceLineNo">189</span> FileStatus[] children = FSUtils.listStatus(fs, dir);<a name="line.189"></a> +<span class="sourceLineNo">190</span> boolean allChildrenDeleted = checkAndDeleteEntries(children);<a name="line.190"></a> +<span class="sourceLineNo">191</span> <a name="line.191"></a> +<span class="sourceLineNo">192</span> // if the directory still has children, we can't delete it, so we are done<a name="line.192"></a> +<span class="sourceLineNo">193</span> if (!allChildrenDeleted) return false;<a name="line.193"></a> +<span class="sourceLineNo">194</span> } catch (IOException e) {<a name="line.194"></a> +<span class="sourceLineNo">195</span> e = e instanceof RemoteException ?<a name="line.195"></a> +<span class="sourceLineNo">196</span> ((RemoteException)e).unwrapRemoteException() : e;<a name="line.196"></a> +<span class="sourceLineNo">197</span> LOG.warn("Error while listing directory: " + dir, e);<a name="line.197"></a> +<span class="sourceLineNo">198</span> // couldn't list directory, so don't try to delete, and don't return success<a name="line.198"></a> +<span class="sourceLineNo">199</span> return false;<a name="line.199"></a> +<span class="sourceLineNo">200</span> }<a name="line.200"></a> +<span class="sourceLineNo">201</span><a name="line.201"></a> +<span class="sourceLineNo">202</span> // otherwise, all the children (that we know about) have been deleted, so we should try to<a name="line.202"></a> +<span class="sourceLineNo">203</span> // delete this directory. However, don't do so recursively so we don't delete files that have<a name="line.203"></a> +<span class="sourceLineNo">204</span> // been added since we last checked.<a name="line.204"></a> +<span class="sourceLineNo">205</span> try {<a name="line.205"></a> +<span class="sourceLineNo">206</span> return fs.delete(dir, false);<a name="line.206"></a> +<span class="sourceLineNo">207</span> } catch (IOException e) {<a name="line.207"></a> +<span class="sourceLineNo">208</span> if (LOG.isTraceEnabled()) {<a name="line.208"></a> +<span class="sourceLineNo">209</span> LOG.trace("Couldn't delete directory: " + dir, e);<a name="line.209"></a> +<span class="sourceLineNo">210</span> }<a name="line.210"></a> +<span class="sourceLineNo">211</span> // couldn't delete w/o exception, so we can't return success.<a name="line.211"></a> +<span class="sourceLineNo">212</span> return false;<a name="line.212"></a> +<span class="sourceLineNo">213</span> }<a name="line.213"></a> +<span class="sourceLineNo">214</span> }<a name="line.214"></a> +<span class="sourceLineNo">215</span><a name="line.215"></a> +<span class="sourceLineNo">216</span> /**<a name="line.216"></a> +<span class="sourceLineNo">217</span> * Run the given files through each of the cleaners to see if it should be deleted, deleting it if<a name="line.217"></a> +<span class="sourceLineNo">218</span> * necessary.<a name="line.218"></a> +<span class="sourceLineNo">219</span> * @param files List of FileStatus for the files to check (and possibly delete)<a name="line.219"></a> +<span class="sourceLineNo">220</span> * @return true iff successfully deleted all files<a name="line.220"></a> +<span class="sourceLineNo">221</span> */<a name="line.221"></a> +<span class="sourceLineNo">222</span> private boolean checkAndDeleteFiles(List<FileStatus> files) {<a name="line.222"></a> +<span class="sourceLineNo">223</span> // first check to see if the path is valid<a name="line.223"></a> +<span class="sourceLineNo">224</span> List<FileStatus> validFiles = Lists.newArrayListWithCapacity(files.size());<a name="line.224"></a> +<span class="sourceLineNo">225</span> List<FileStatus> invalidFiles = Lists.newArrayList();<a name="line.225"></a> +<span class="sourceLineNo">226</span> for (FileStatus file : files) {<a name="line.226"></a> +<span class="sourceLineNo">227</span> if (validate(file.getPath())) {<a name="line.227"></a> +<span class="sourceLineNo">228</span> validFiles.add(file);<a name="line.228"></a> +<span class="sourceLineNo">229</span> } else {<a name="line.229"></a> +<span class="sourceLineNo">230</span> LOG.warn("Found a wrongly formatted file: " + file.getPath() + " - will delete it.");<a name="line.230"></a> +<span class="sourceLineNo">231</span> invalidFiles.add(file);<a name="line.231"></a> +<span class="sourceLineNo">232</span> }<a name="line.232"></a> +<span class="sourceLineNo">233</span> }<a name="line.233"></a> <span class="sourceLineNo">234</span><a name="line.234"></a> -<span class="sourceLineNo">235</span> Iterable<FileStatus> filteredFiles = cleaner.getDeletableFiles(deletableValidFiles);<a name="line.235"></a> -<span class="sourceLineNo">236</span> <a name="line.236"></a> -<span class="sourceLineNo">237</span> // trace which cleaner is holding on to each file<a name="line.237"></a> -<span class="sourceLineNo">238</span> if (LOG.isTraceEnabled()) {<a name="line.238"></a> -<span class="sourceLineNo">239</span> ImmutableSet<FileStatus> filteredFileSet = ImmutableSet.copyOf(filteredFiles);<a name="line.239"></a> -<span class="sourceLineNo">240</span> for (FileStatus file : deletableValidFiles) {<a name="line.240"></a> -<span class="sourceLineNo">241</span> if (!filteredFileSet.contains(file)) {<a name="line.241"></a> -<span class="sourceLineNo">242</span> LOG.trace(file.getPath() + " is not deletable according to:" + cleaner);<a name="line.242"></a> -<span class="sourceLineNo">243</span> }<a name="line.243"></a> -<span class="sourceLineNo">244</span> }<a name="line.244"></a> -<span class="sourceLineNo">245</span> }<a name="line.245"></a> -<span class="sourceLineNo">246</span> <a name="line.246"></a> -<span class="sourceLineNo">247</span> deletableValidFiles = filteredFiles;<a name="line.247"></a> -<span class="sourceLineNo">248</span> }<a name="line.248"></a> -<span class="sourceLineNo">249</span> <a name="line.249"></a> -<span class="sourceLineNo">250</span> Iterable<FileStatus> filesToDelete = Iterables.concat(invalidFiles, deletableValidFiles);<a name="line.250"></a> -<span class="sourceLineNo">251</span> int deletedFileCount = 0;<a name="line.251"></a> -<span class="sourceLineNo">252</span> for (FileStatus file : filesToDelete) {<a name="line.252"></a> -<span class="sourceLineNo">253</span> Path filePath = file.getPath();<a name="line.253"></a> -<span class="sourceLineNo">254</span> if (LOG.isDebugEnabled()) {<a name="line.254"></a> -<span class="sourceLineNo">255</span> LOG.debug("Removing: " + filePath + " from archive");<a name="line.255"></a> -<span class="sourceLineNo">256</span> }<a name="line.256"></a> -<span class="sourceLineNo">257</span> try {<a name="line.257"></a> -<span class="sourceLineNo">258</span> boolean success = this.fs.delete(filePath, false);<a name="line.258"></a> -<span class="sourceLineNo">259</span> if (success) {<a name="line.259"></a> -<span class="sourceLineNo">260</span> deletedFileCount++;<a name="line.260"></a> -<span class="sourceLineNo">261</span> } else {<a name="line.261"></a> -<span class="sourceLineNo">262</span> LOG.warn("Attempted to delete:" + filePath<a name="line.262"></a> -<span class="sourceLineNo">263</span> + ", but couldn't. Run cleaner chain and attempt to delete on next pass.");<a name="line.263"></a> -<span class="sourceLineNo">264</span> }<a name="line.264"></a> -<span class="sourceLineNo">265</span> } catch (IOException e) {<a name="line.265"></a> -<span class="sourceLineNo">266</span> e = e instanceof RemoteException ?<a name="line.266"></a> -<span class="sourceLineNo">267</span> ((RemoteException)e).unwrapRemoteException() : e;<a name="line.267"></a> -<span class="sourceLineNo">268</span> LOG.warn("Error while deleting: " + filePath, e);<a name="line.268"></a> -<span class="sourceLineNo">269</span> }<a name="line.269"></a> -<span class="sourceLineNo">270</span> }<a name="line.270"></a> -<span class="sourceLineNo">271</span><a name="line.271"></a> -<span class="sourceLineNo">272</span> return deletedFileCount == files.size();<a name="line.272"></a> -<span class="sourceLineNo">273</span> }<a name="line.273"></a> -<span class="sourceLineNo">274</span><a name="line.274"></a> -<span class="sourceLineNo">275</span> @Override<a name="line.275"></a> -<span class="sourceLineNo">276</span> public void cleanup() {<a name="line.276"></a> -<span class="sourceLineNo">277</span> for (T lc : this.cleanersChain) {<a name="line.277"></a> -<span class="sourceLineNo">278</span> try {<a name="line.278"></a> -<span class="sourceLineNo">279</span> lc.stop("Exiting");<a name="line.279"></a> -<span class="sourceLineNo">280</span> } catch (Throwable t) {<a name="line.280"></a> -<span class="sourceLineNo">281</span> LOG.warn("Stopping", t);<a name="line.281"></a> -<span class="sourceLineNo">282</span> }<a name="line.282"></a> -<span class="sourceLineNo">283</span> }<a name="line.283"></a> -<span class="sourceLineNo">284</span> }<a name="line.284"></a> -<span class="sourceLineNo">285</span>}<a name="line.285"></a> +<span class="sourceLineNo">235</span> Iterable<FileStatus> deletableValidFiles = validFiles;<a name="line.235"></a> +<span class="sourceLineNo">236</span> // check each of the cleaners for the valid files<a name="line.236"></a> +<span class="sourceLineNo">237</span> for (T cleaner : cleanersChain) {<a name="line.237"></a> +<span class="sourceLineNo">238</span> if (cleaner.isStopped() || this.getStopper().isStopped()) {<a name="line.238"></a> +<span class="sourceLineNo">239</span> LOG.warn("A file cleaner" + this.getName() + " is stopped, won't delete any more files in:"<a name="line.239"></a> +<span class="sourceLineNo">240</span> + this.oldFileDir);<a name="line.240"></a> +<span class="sourceLineNo">241</span> return false;<a name="line.241"></a> +<span class="sourceLineNo">242</span> }<a name="line.242"></a> +<span class="sourceLineNo">243</span><a name="line.243"></a> +<span class="sourceLineNo">244</span> Iterable<FileStatus> filteredFiles = cleaner.getDeletableFiles(deletableValidFiles);<a name="line.244"></a> +<span class="sourceLineNo">245</span> <a name="line.245"></a> +<span class="sourceLineNo">246</span> // trace which cleaner is holding on to each file<a name="line.246"></a> +<span class="sourceLineNo">247</span> if (LOG.isTraceEnabled()) {<a name="line.247"></a> +<span class="sourceLineNo">248</span> ImmutableSet<FileStatus> filteredFileSet = ImmutableSet.copyOf(filteredFiles);<a name="line.248"></a> +<span class="sourceLineNo">249</span> for (FileStatus file : deletableValidFiles) {<a name="line.249"></a> +<span class="sourceLineNo">250</span> if (!filteredFileSet.contains(file)) {<a name="line.250"></a> +<span class="sourceLineNo">251</span> LOG.trace(file.getPath() + " is not deletable according to:" + cleaner);<a name="line.251"></a> +<span class="sourceLineNo">252</span> }<a name="line.252"></a> +<span class="sourceLineNo">253</span> }<a name="line.253"></a> +<span class="sourceLineNo">254</span> }<a name="line.254"></a> +<span class="sourceLineNo">255</span> <a name="line.255"></a> +<span class="sourceLineNo">256</span> deletableValidFiles = filteredFiles;<a name="line.256"></a> +<span class="sourceLineNo">257</span> }<a name="line.257"></a> +<span class="sourceLineNo">258</span> <a name="line.258"></a> +<span class="sourceLineNo">259</span> Iterable<FileStatus> filesToDelete = Iterables.concat(invalidFiles, deletableValidFiles);<a name="line.259"></a> +<span class="sourceLineNo">260</span> int deletedFileCount = 0;<a name="line.260"></a> +<span class="sourceLineNo">261</span> for (FileStatus file : filesToDelete) {<a name="line.261"></a> +<span class="sourceLineNo">262</span> Path filePath = file.getPath();<a name="line.262"></a> +<span class="sourceLineNo">263</span> if (LOG.isDebugEnabled()) {<a name="line.263"></a> +<span class="sourceLineNo">264</span> LOG.debug("Removing: " + filePath + " from archive");<a name="line.264"></a> +<span class="sourceLineNo">265</span> }<a name="line.265"></a> +<span class="sourceLineNo">266</span> try {<a name="line.266"></a> +<span class="sourceLineNo">267</span> boolean success = this.fs.delete(filePath, false);<a name="line.267"></a> +<span class="sourceLineNo">268</span> if (success) {<a name="line.268"></a> +<span class="sourceLineNo">269</span> deletedFileCount++;<a name="line.269"></a> +<span class="sourceLineNo">270</span> } else {<a name="line.270"></a> +<span class="sourceLineNo">271</span> LOG.warn("Attempted to delete:" + filePath<a name="line.271"></a> +<span class="sourceLineNo">272</span> + ", but couldn't. Run cleaner chain and attempt to delete on next pass.");<a name="line.272"></a> +<span class="sourceLineNo">273</span> }<a name="line.273"></a> +<span class="sourceLineNo">274</span> } catch (IOException e) {<a name="line.274"></a> +<span class="sourceLineNo">275</span> e = e instanceof RemoteException ?<a name="line.275"></a> +<span class="sourceLineNo">276</span> ((RemoteException)e).unwrapRemoteException() : e;<a name="line.276"></a> +<span class="sourceLineNo">277</span> LOG.warn("Error while deleting: " + filePath, e);<a name="line.277"></a> +<span class="sourceLineNo">278</span> }<a name="line.278"></a> +<span class="sourceLineNo">279</span> }<a name="line.279"></a> +<span class="sourceLineNo">280</span><a name="line.280"></a> +<span class="sourceLineNo">281</span> return deletedFileCount == files.size();<a name="line.281"></a> +<span class="sourceLineNo">282</span> }<a name="line.282"></a> +<span class="sourceLineNo">283</span><a name="line.283"></a> +<span class="sourceLineNo">284</span> @Override<a name="line.284"></a> +<span class="sourceLineNo">285</span> public void cleanup() {<a name="line.285"></a> +<span class="sourceLineNo">286</span> for (T lc : this.cleanersChain) {<a name="line.286"></a> +<span class="sourceLineNo">287</span> try {<a name="line.287"></a> +<span class="sourceLineNo">288</span> lc.stop("Exiting");<a name="line.288"></a> +<span class="sourceLineNo">289</span> } catch (Throwable t) {<a name="line.289"></a> +<span class="sourceLineNo">290</span> LOG.warn("Stopping", t);<a name="line.290"></a> +<span class="sourceLineNo">291</span> }<a name="line.291"></a> +<span class="sourceLineNo">292</span> }<a name="line.292"></a> +<span class="sourceLineNo">293</span> }<a name="line.293"></a> +<span class="sourceLineNo">294</span>}<a name="line.294"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/45a663dd/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/FileCleanerDelegate.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/FileCleanerDelegate.html b/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/FileCleanerDelegate.html index bb59696..e16a05b 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/FileCleanerDelegate.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/FileCleanerDelegate.html @@ -30,21 +30,29 @@ <span class="sourceLineNo">022</span>import org.apache.hadoop.fs.FileStatus;<a name="line.22"></a> <span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.Stoppable;<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> * General interface for cleaning files from a folder (generally an archive or<a name="line.26"></a> -<span class="sourceLineNo">027</span> * backup folder). These are chained via the {@link CleanerChore} to determine<a name="line.27"></a> -<span class="sourceLineNo">028</span> * if a given file should be deleted.<a name="line.28"></a> -<span class="sourceLineNo">029</span> */<a name="line.29"></a> -<span class="sourceLineNo">030</span>@InterfaceAudience.Private<a name="line.30"></a> -<span class="sourceLineNo">031</span>public interface FileCleanerDelegate extends Configurable, Stoppable {<a name="line.31"></a> -<span class="sourceLineNo">032</span><a name="line.32"></a> -<span class="sourceLineNo">033</span> /**<a name="line.33"></a> -<span class="sourceLineNo">034</span> * Determines which of the given files are safe to delete<a name="line.34"></a> -<span class="sourceLineNo">035</span> * @param files files to check for deletion<a name="line.35"></a> -<span class="sourceLineNo">036</span> * @return files that are ok to delete according to this cleaner<a name="line.36"></a> -<span class="sourceLineNo">037</span> */<a name="line.37"></a> -<span class="sourceLineNo">038</span> Iterable<FileStatus> getDeletableFiles(Iterable<FileStatus> files);<a name="line.38"></a> -<span class="sourceLineNo">039</span>}<a name="line.39"></a> +<span class="sourceLineNo">025</span>import java.util.Map;<a name="line.25"></a> +<span class="sourceLineNo">026</span><a name="line.26"></a> +<span class="sourceLineNo">027</span>/**<a name="line.27"></a> +<span class="sourceLineNo">028</span> * General interface for cleaning files from a folder (generally an archive or<a name="line.28"></a> +<span class="sourceLineNo">029</span> * backup folder). These are chained via the {@link CleanerChore} to determine<a name="line.29"></a> +<span class="sourceLineNo">030</span> * if a given file should be deleted.<a name="line.30"></a> +<span class="sourceLineNo">031</span> */<a name="line.31"></a> +<span class="sourceLineNo">032</span>@InterfaceAudience.Private<a name="line.32"></a> +<span class="sourceLineNo">033</span>public interface FileCleanerDelegate extends Configurable, Stoppable {<a name="line.33"></a> +<span class="sourceLineNo">034</span><a name="line.34"></a> +<span class="sourceLineNo">035</span> /**<a name="line.35"></a> +<span class="sourceLineNo">036</span> * Determines which of the given files are safe to delete<a name="line.36"></a> +<span class="sourceLineNo">037</span> * @param files files to check for deletion<a name="line.37"></a> +<span class="sourceLineNo">038</span> * @return files that are ok to delete according to this cleaner<a name="line.38"></a> +<span class="sourceLineNo">039</span> */<a name="line.39"></a> +<span class="sourceLineNo">040</span> Iterable<FileStatus> getDeletableFiles(Iterable<FileStatus> files);<a name="line.40"></a> +<span class="sourceLineNo">041</span><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> * this method is used to pass some instance into subclass<a name="line.44"></a> +<span class="sourceLineNo">045</span> * */<a name="line.45"></a> +<span class="sourceLineNo">046</span> void init(Map<String, Object> params);<a name="line.46"></a> +<span class="sourceLineNo">047</span>}<a name="line.47"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/45a663dd/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/HFileCleaner.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/HFileCleaner.html b/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/HFileCleaner.html index 55690d1..bba66a8 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/HFileCleaner.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/master/cleaner/HFileCleaner.html @@ -26,50 +26,58 @@ <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.master.cleaner;<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.hadoop.hbase.classification.InterfaceAudience;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import org.apache.hadoop.conf.Configuration;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import org.apache.hadoop.fs.FileSystem;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import org.apache.hadoop.fs.Path;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.Stoppable;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.io.HFileLink;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.regionserver.StoreFileInfo;<a name="line.28"></a> -<span class="sourceLineNo">029</span>/**<a name="line.29"></a> -<span class="sourceLineNo">030</span> * This Chore, every time it runs, will clear the HFiles in the hfile archive<a name="line.30"></a> -<span class="sourceLineNo">031</span> * folder that are deletable for each HFile cleaner in the chain.<a name="line.31"></a> -<span class="sourceLineNo">032</span> */<a name="line.32"></a> -<span class="sourceLineNo">033</span>@InterfaceAudience.Private<a name="line.33"></a> -<span class="sourceLineNo">034</span>public class HFileCleaner extends CleanerChore<BaseHFileCleanerDelegate> {<a name="line.34"></a> -<span class="sourceLineNo">035</span><a name="line.35"></a> -<span class="sourceLineNo">036</span> public static final String MASTER_HFILE_CLEANER_PLUGINS = "hbase.master.hfilecleaner.plugins";<a name="line.36"></a> -<span class="sourceLineNo">037</span><a name="line.37"></a> -<span class="sourceLineNo">038</span> /**<a name="line.38"></a> -<span class="sourceLineNo">039</span> * @param period the period of time to sleep between each run<a name="line.39"></a> -<span class="sourceLineNo">040</span> * @param stopper the stopper<a name="line.40"></a> -<span class="sourceLineNo">041</span> * @param conf configuration to use<a name="line.41"></a> -<span class="sourceLineNo">042</span> * @param fs handle to the FS<a name="line.42"></a> -<span class="sourceLineNo">043</span> * @param directory directory to be cleaned<a name="line.43"></a> -<span class="sourceLineNo">044</span> */<a name="line.44"></a> -<span class="sourceLineNo">045</span> public HFileCleaner(final int period, final Stoppable stopper, Configuration conf, FileSystem fs,<a name="line.45"></a> -<span class="sourceLineNo">046</span> Path directory) {<a name="line.46"></a> -<span class="sourceLineNo">047</span> super("HFileCleaner", period, stopper, conf, fs, directory, MASTER_HFILE_CLEANER_PLUGINS);<a name="line.47"></a> -<span class="sourceLineNo">048</span> }<a name="line.48"></a> -<span class="sourceLineNo">049</span><a name="line.49"></a> -<span class="sourceLineNo">050</span> @Override<a name="line.50"></a> -<span class="sourceLineNo">051</span> protected boolean validate(Path file) {<a name="line.51"></a> -<span class="sourceLineNo">052</span> if (HFileLink.isBackReferencesDir(file) || HFileLink.isBackReferencesDir(file.getParent())) {<a name="line.52"></a> -<span class="sourceLineNo">053</span> return true;<a name="line.53"></a> -<span class="sourceLineNo">054</span> }<a name="line.54"></a> -<span class="sourceLineNo">055</span> return StoreFileInfo.validateStoreFileName(file.getName());<a name="line.55"></a> +<span class="sourceLineNo">021</span>import java.util.Map;<a name="line.21"></a> +<span class="sourceLineNo">022</span><a name="line.22"></a> +<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.hadoop.conf.Configuration;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import org.apache.hadoop.fs.FileSystem;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.hadoop.fs.Path;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.Stoppable;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.io.HFileLink;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.regionserver.StoreFileInfo;<a name="line.29"></a> +<span class="sourceLineNo">030</span>/**<a name="line.30"></a> +<span class="sourceLineNo">031</span> * This Chore, every time it runs, will clear the HFiles in the hfile archive<a name="line.31"></a> +<span class="sourceLineNo">032</span> * folder that are deletable for each HFile cleaner in the chain.<a name="line.32"></a> +<span class="sourceLineNo">033</span> */<a name="line.33"></a> +<span class="sourceLineNo">034</span>@InterfaceAudience.Private<a name="line.34"></a> +<span class="sourceLineNo">035</span>public class HFileCleaner extends CleanerChore<BaseHFileCleanerDelegate> {<a name="line.35"></a> +<span class="sourceLineNo">036</span><a name="line.36"></a> +<span class="sourceLineNo">037</span> public static final String MASTER_HFILE_CLEANER_PLUGINS = "hbase.master.hfilecleaner.plugins";<a name="line.37"></a> +<span class="sourceLineNo">038</span><a name="line.38"></a> +<span class="sourceLineNo">039</span> public HFileCleaner(final int period, final Stoppable stopper, Configuration conf, FileSystem fs,<a name="line.39"></a> +<span class="sourceLineNo">040</span> Path directory) {<a name="line.40"></a> +<span class="sourceLineNo">041</span> this(period, stopper, conf, fs, directory, null);<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> /**<a name="line.44"></a> +<span class="sourceLineNo">045</span> * @param period the period of time to sleep between each run<a name="line.45"></a> +<span class="sourceLineNo">046</span> * @param stopper the stopper<a name="line.46"></a> +<span class="sourceLineNo">047</span> * @param conf configuration to use<a name="line.47"></a> +<span class="sourceLineNo">048</span> * @param fs handle to the FS<a name="line.48"></a> +<span class="sourceLineNo">049</span> * @param directory directory to be cleaned<a name="line.49"></a> +<span class="sourceLineNo">050</span> * @param params params could be used in subclass of BaseHFileCleanerDelegate<a name="line.50"></a> +<span class="sourceLineNo">051</span> */<a name="line.51"></a> +<span class="sourceLineNo">052</span> public HFileCleaner(final int period, final Stoppable stopper, Configuration conf, FileSystem fs,<a name="line.52"></a> +<span class="sourceLineNo">053</span> Path directory, Map<String, Object> params) {<a name="line.53"></a> +<span class="sourceLineNo">054</span> super("HFileCleaner", period, stopper, conf, fs,<a name="line.54"></a> +<span class="sourceLineNo">055</span> directory, MASTER_HFILE_CLEANER_PLUGINS, params);<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> /**<a name="line.58"></a> -<span class="sourceLineNo">059</span> * Exposed for TESTING!<a name="line.59"></a> -<span class="sourceLineNo">060</span> */<a name="line.60"></a> -<span class="sourceLineNo">061</span> public List<BaseHFileCleanerDelegate> getDelegatesForTesting() {<a name="line.61"></a> -<span class="sourceLineNo">062</span> return this.cleanersChain;<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">058</span> @Override<a name="line.58"></a> +<span class="sourceLineNo">059</span> protected boolean validate(Path file) {<a name="line.59"></a> +<span class="sourceLineNo">060</span> if (HFileLink.isBackReferencesDir(file) || HFileLink.isBackReferencesDir(file.getParent())) {<a name="line.60"></a> +<span class="sourceLineNo">061</span> return true;<a name="line.61"></a> +<span class="sourceLineNo">062</span> }<a name="line.62"></a> +<span class="sourceLineNo">063</span> return StoreFileInfo.validateStoreFileName(file.getName());<a name="line.63"></a> +<span class="sourceLineNo">064</span> }<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> * Exposed for TESTING!<a name="line.67"></a> +<span class="sourceLineNo">068</span> */<a name="line.68"></a> +<span class="sourceLineNo">069</span> public List<BaseHFileCleanerDelegate> getDelegatesForTesting() {<a name="line.69"></a> +<span class="sourceLineNo">070</span> return this.cleanersChain;<a name="line.70"></a> +<span class="sourceLineNo">071</span> }<a name="line.71"></a> +<span class="sourceLineNo">072</span>}<a name="line.72"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/45a663dd/devapidocs/src-html/org/apache/hadoop/hbase/master/snapshot/DisabledTableSnapshotHandler.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/master/snapshot/DisabledTableSnapshotHandler.html b/devapidocs/src-html/org/apache/hadoop/hbase/master/snapshot/DisabledTableSnapshotHandler.html index a619c32..a4bff9e 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/master/snapshot/DisabledTableSnapshotHandler.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/master/snapshot/DisabledTableSnapshotHandler.html @@ -66,8 +66,8 @@ <span class="sourceLineNo">058</span> * @param masterServices master services provider<a name="line.58"></a> <span class="sourceLineNo">059</span> */<a name="line.59"></a> <span class="sourceLineNo">060</span> public DisabledTableSnapshotHandler(SnapshotDescription snapshot,<a name="line.60"></a> -<span class="sourceLineNo">061</span> final MasterServices masterServices) {<a name="line.61"></a> -<span class="sourceLineNo">062</span> super(snapshot, masterServices);<a name="line.62"></a> +<span class="sourceLineNo">061</span> final MasterServices masterServices, final SnapshotManager snapshotManager) {<a name="line.61"></a> +<span class="sourceLineNo">062</span> super(snapshot, masterServices, snapshotManager);<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> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/45a663dd/devapidocs/src-html/org/apache/hadoop/hbase/master/snapshot/EnabledTableSnapshotHandler.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/master/snapshot/EnabledTableSnapshotHandler.html b/devapidocs/src-html/org/apache/hadoop/hbase/master/snapshot/EnabledTableSnapshotHandler.html index 4f446b4..180d078 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/master/snapshot/EnabledTableSnapshotHandler.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/master/snapshot/EnabledTableSnapshotHandler.html @@ -58,7 +58,7 @@ <span class="sourceLineNo">050</span><a name="line.50"></a> <span class="sourceLineNo">051</span> public EnabledTableSnapshotHandler(SnapshotDescription snapshot, MasterServices master,<a name="line.51"></a> <span class="sourceLineNo">052</span> final SnapshotManager manager) {<a name="line.52"></a> -<span class="sourceLineNo">053</span> super(snapshot, master);<a name="line.53"></a> +<span class="sourceLineNo">053</span> super(snapshot, master, manager);<a name="line.53"></a> <span class="sourceLineNo">054</span> this.coordinator = manager.getCoordinator();<a name="line.54"></a> <span class="sourceLineNo">055</span> }<a name="line.55"></a> <span class="sourceLineNo">056</span><a name="line.56"></a>