blob: 973d9a71b33cd3a411f999b6d83f223f461671f8 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.util, class: FSVisitor">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.util;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span>
<span class="source-line-no">021</span><span id="line-21">import java.util.List;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.fs.FileStatus;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.fs.FileSystem;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.fs.Path;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.fs.PathFilter;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">027</span><span id="line-27">import org.slf4j.Logger;</span>
<span class="source-line-no">028</span><span id="line-28">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">029</span><span id="line-29"></span>
<span class="source-line-no">030</span><span id="line-30">/**</span>
<span class="source-line-no">031</span><span id="line-31"> * Utility methods for interacting with the hbase.root file system.</span>
<span class="source-line-no">032</span><span id="line-32"> */</span>
<span class="source-line-no">033</span><span id="line-33">@InterfaceAudience.Private</span>
<span class="source-line-no">034</span><span id="line-34">public final class FSVisitor {</span>
<span class="source-line-no">035</span><span id="line-35"> private static final Logger LOG = LoggerFactory.getLogger(FSVisitor.class);</span>
<span class="source-line-no">036</span><span id="line-36"></span>
<span class="source-line-no">037</span><span id="line-37"> public interface StoreFileVisitor {</span>
<span class="source-line-no">038</span><span id="line-38"> void storeFile(final String region, final String family, final String hfileName)</span>
<span class="source-line-no">039</span><span id="line-39"> throws IOException;</span>
<span class="source-line-no">040</span><span id="line-40"> }</span>
<span class="source-line-no">041</span><span id="line-41"></span>
<span class="source-line-no">042</span><span id="line-42"> private FSVisitor() {</span>
<span class="source-line-no">043</span><span id="line-43"> // private constructor for utility class</span>
<span class="source-line-no">044</span><span id="line-44"> }</span>
<span class="source-line-no">045</span><span id="line-45"></span>
<span class="source-line-no">046</span><span id="line-46"> /**</span>
<span class="source-line-no">047</span><span id="line-47"> * Iterate over the table store files</span>
<span class="source-line-no">048</span><span id="line-48"> * @param fs {@link FileSystem}</span>
<span class="source-line-no">049</span><span id="line-49"> * @param tableDir {@link Path} to the table directory</span>
<span class="source-line-no">050</span><span id="line-50"> * @param visitor callback object to get the store files</span>
<span class="source-line-no">051</span><span id="line-51"> * @throws IOException if an error occurred while scanning the directory</span>
<span class="source-line-no">052</span><span id="line-52"> */</span>
<span class="source-line-no">053</span><span id="line-53"> public static void visitTableStoreFiles(final FileSystem fs, final Path tableDir,</span>
<span class="source-line-no">054</span><span id="line-54"> final StoreFileVisitor visitor) throws IOException {</span>
<span class="source-line-no">055</span><span id="line-55"> List&lt;FileStatus&gt; regions =</span>
<span class="source-line-no">056</span><span id="line-56"> FSUtils.listStatusWithStatusFilter(fs, tableDir, new FSUtils.RegionDirFilter(fs));</span>
<span class="source-line-no">057</span><span id="line-57"> if (regions == null) {</span>
<span class="source-line-no">058</span><span id="line-58"> if (LOG.isTraceEnabled()) {</span>
<span class="source-line-no">059</span><span id="line-59"> LOG.trace("No regions under directory:" + tableDir);</span>
<span class="source-line-no">060</span><span id="line-60"> }</span>
<span class="source-line-no">061</span><span id="line-61"> return;</span>
<span class="source-line-no">062</span><span id="line-62"> }</span>
<span class="source-line-no">063</span><span id="line-63"></span>
<span class="source-line-no">064</span><span id="line-64"> for (FileStatus region : regions) {</span>
<span class="source-line-no">065</span><span id="line-65"> visitRegionStoreFiles(fs, region.getPath(), visitor);</span>
<span class="source-line-no">066</span><span id="line-66"> }</span>
<span class="source-line-no">067</span><span id="line-67"> }</span>
<span class="source-line-no">068</span><span id="line-68"></span>
<span class="source-line-no">069</span><span id="line-69"> /**</span>
<span class="source-line-no">070</span><span id="line-70"> * Iterate over the region store files</span>
<span class="source-line-no">071</span><span id="line-71"> * @param fs {@link FileSystem}</span>
<span class="source-line-no">072</span><span id="line-72"> * @param regionDir {@link Path} to the region directory</span>
<span class="source-line-no">073</span><span id="line-73"> * @param visitor callback object to get the store files</span>
<span class="source-line-no">074</span><span id="line-74"> * @throws IOException if an error occurred while scanning the directory</span>
<span class="source-line-no">075</span><span id="line-75"> */</span>
<span class="source-line-no">076</span><span id="line-76"> public static void visitRegionStoreFiles(final FileSystem fs, final Path regionDir,</span>
<span class="source-line-no">077</span><span id="line-77"> final StoreFileVisitor visitor) throws IOException {</span>
<span class="source-line-no">078</span><span id="line-78"> List&lt;FileStatus&gt; families =</span>
<span class="source-line-no">079</span><span id="line-79"> FSUtils.listStatusWithStatusFilter(fs, regionDir, new FSUtils.FamilyDirFilter(fs));</span>
<span class="source-line-no">080</span><span id="line-80"> if (families == null) {</span>
<span class="source-line-no">081</span><span id="line-81"> if (LOG.isTraceEnabled()) {</span>
<span class="source-line-no">082</span><span id="line-82"> LOG.trace("No families under region directory:" + regionDir);</span>
<span class="source-line-no">083</span><span id="line-83"> }</span>
<span class="source-line-no">084</span><span id="line-84"> return;</span>
<span class="source-line-no">085</span><span id="line-85"> }</span>
<span class="source-line-no">086</span><span id="line-86"></span>
<span class="source-line-no">087</span><span id="line-87"> PathFilter fileFilter = new FSUtils.FileFilter(fs);</span>
<span class="source-line-no">088</span><span id="line-88"> for (FileStatus family : families) {</span>
<span class="source-line-no">089</span><span id="line-89"> Path familyDir = family.getPath();</span>
<span class="source-line-no">090</span><span id="line-90"> String familyName = familyDir.getName();</span>
<span class="source-line-no">091</span><span id="line-91"></span>
<span class="source-line-no">092</span><span id="line-92"> // get all the storeFiles in the family</span>
<span class="source-line-no">093</span><span id="line-93"> FileStatus[] storeFiles = CommonFSUtils.listStatus(fs, familyDir, fileFilter);</span>
<span class="source-line-no">094</span><span id="line-94"> if (storeFiles == null) {</span>
<span class="source-line-no">095</span><span id="line-95"> if (LOG.isTraceEnabled()) {</span>
<span class="source-line-no">096</span><span id="line-96"> LOG.trace("No hfiles found for family: " + familyDir + ", skipping.");</span>
<span class="source-line-no">097</span><span id="line-97"> }</span>
<span class="source-line-no">098</span><span id="line-98"> continue;</span>
<span class="source-line-no">099</span><span id="line-99"> }</span>
<span class="source-line-no">100</span><span id="line-100"></span>
<span class="source-line-no">101</span><span id="line-101"> for (FileStatus hfile : storeFiles) {</span>
<span class="source-line-no">102</span><span id="line-102"> Path hfilePath = hfile.getPath();</span>
<span class="source-line-no">103</span><span id="line-103"> visitor.storeFile(regionDir.getName(), familyName, hfilePath.getName());</span>
<span class="source-line-no">104</span><span id="line-104"> }</span>
<span class="source-line-no">105</span><span id="line-105"> }</span>
<span class="source-line-no">106</span><span id="line-106"> }</span>
<span class="source-line-no">107</span><span id="line-107">}</span>
</pre>
</div>
</main>
</body>
</html>