| <!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.backup, class: HBackupFileSystem"> |
| <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.backup;</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 org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.fs.FileSystem;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.fs.Path;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.TableName;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.backup.impl.BackupManifest;</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"> * View to an on-disk Backup Image FileSytem Provides the set of methods necessary to interact with</span> |
| <span class="source-line-no">032</span><span id="line-32"> * the on-disk Backup Image data.</span> |
| <span class="source-line-no">033</span><span id="line-33"> */</span> |
| <span class="source-line-no">034</span><span id="line-34">@InterfaceAudience.Private</span> |
| <span class="source-line-no">035</span><span id="line-35">public final class HBackupFileSystem {</span> |
| <span class="source-line-no">036</span><span id="line-36"> public static final Logger LOG = LoggerFactory.getLogger(HBackupFileSystem.class);</span> |
| <span class="source-line-no">037</span><span id="line-37"></span> |
| <span class="source-line-no">038</span><span id="line-38"> /**</span> |
| <span class="source-line-no">039</span><span id="line-39"> * This is utility class.</span> |
| <span class="source-line-no">040</span><span id="line-40"> */</span> |
| <span class="source-line-no">041</span><span id="line-41"> private HBackupFileSystem() {</span> |
| <span class="source-line-no">042</span><span id="line-42"> }</span> |
| <span class="source-line-no">043</span><span id="line-43"></span> |
| <span class="source-line-no">044</span><span id="line-44"> /**</span> |
| <span class="source-line-no">045</span><span id="line-45"> * Given the backup root dir, backup id and the table name, return the backup image location.</span> |
| <span class="source-line-no">046</span><span id="line-46"> * Return value look like:</span> |
| <span class="source-line-no">047</span><span id="line-47"> * "hdfs://backup.hbase.org:9000/user/biadmin/backup/backup_1396650096738/default/t1_dn/", where</span> |
| <span class="source-line-no">048</span><span id="line-48"> * "hdfs://backup.hbase.org:9000/user/biadmin/backup" is a backup root directory</span> |
| <span class="source-line-no">049</span><span id="line-49"> * @param backupRootDir backup root directory</span> |
| <span class="source-line-no">050</span><span id="line-50"> * @param backupId backup id</span> |
| <span class="source-line-no">051</span><span id="line-51"> * @param tableName table name</span> |
| <span class="source-line-no">052</span><span id="line-52"> * @return backupPath String for the particular table</span> |
| <span class="source-line-no">053</span><span id="line-53"> */</span> |
| <span class="source-line-no">054</span><span id="line-54"> public static String getTableBackupDir(String backupRootDir, String backupId,</span> |
| <span class="source-line-no">055</span><span id="line-55"> TableName tableName) {</span> |
| <span class="source-line-no">056</span><span id="line-56"> return backupRootDir + Path.SEPARATOR + backupId + Path.SEPARATOR</span> |
| <span class="source-line-no">057</span><span id="line-57"> + tableName.getNamespaceAsString() + Path.SEPARATOR + tableName.getQualifierAsString()</span> |
| <span class="source-line-no">058</span><span id="line-58"> + Path.SEPARATOR;</span> |
| <span class="source-line-no">059</span><span id="line-59"> }</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61"> /**</span> |
| <span class="source-line-no">062</span><span id="line-62"> * Get backup temporary directory</span> |
| <span class="source-line-no">063</span><span id="line-63"> * @param backupRootDir backup root</span> |
| <span class="source-line-no">064</span><span id="line-64"> * @return backup tmp directory path</span> |
| <span class="source-line-no">065</span><span id="line-65"> */</span> |
| <span class="source-line-no">066</span><span id="line-66"> public static Path getBackupTmpDirPath(String backupRootDir) {</span> |
| <span class="source-line-no">067</span><span id="line-67"> return new Path(backupRootDir, ".tmp");</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"> /**</span> |
| <span class="source-line-no">071</span><span id="line-71"> * Get backup tmp directory for backupId</span> |
| <span class="source-line-no">072</span><span id="line-72"> * @param backupRoot backup root</span> |
| <span class="source-line-no">073</span><span id="line-73"> * @param backupId backup id</span> |
| <span class="source-line-no">074</span><span id="line-74"> * @return backup tmp directory path</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 Path getBackupTmpDirPathForBackupId(String backupRoot, String backupId) {</span> |
| <span class="source-line-no">077</span><span id="line-77"> return new Path(getBackupTmpDirPath(backupRoot), backupId);</span> |
| <span class="source-line-no">078</span><span id="line-78"> }</span> |
| <span class="source-line-no">079</span><span id="line-79"></span> |
| <span class="source-line-no">080</span><span id="line-80"> public static Path getBackupPath(String backupRootDir, String backupId) {</span> |
| <span class="source-line-no">081</span><span id="line-81"> return new Path(backupRootDir + Path.SEPARATOR + backupId);</span> |
| <span class="source-line-no">082</span><span id="line-82"> }</span> |
| <span class="source-line-no">083</span><span id="line-83"></span> |
| <span class="source-line-no">084</span><span id="line-84"> /**</span> |
| <span class="source-line-no">085</span><span id="line-85"> * Given the backup root dir, backup id and the table name, return the backup image location,</span> |
| <span class="source-line-no">086</span><span id="line-86"> * which is also where the backup manifest file is. return value look like:</span> |
| <span class="source-line-no">087</span><span id="line-87"> * "hdfs://backup.hbase.org:9000/user/biadmin/backup/backup_1396650096738/default/t1_dn/", where</span> |
| <span class="source-line-no">088</span><span id="line-88"> * "hdfs://backup.hbase.org:9000/user/biadmin/backup" is a backup root directory</span> |
| <span class="source-line-no">089</span><span id="line-89"> * @param backupRootPath backup root path</span> |
| <span class="source-line-no">090</span><span id="line-90"> * @param tableName table name</span> |
| <span class="source-line-no">091</span><span id="line-91"> * @param backupId backup Id</span> |
| <span class="source-line-no">092</span><span id="line-92"> * @return backupPath for the particular table</span> |
| <span class="source-line-no">093</span><span id="line-93"> */</span> |
| <span class="source-line-no">094</span><span id="line-94"> public static Path getTableBackupPath(TableName tableName, Path backupRootPath, String backupId) {</span> |
| <span class="source-line-no">095</span><span id="line-95"> return new Path(getTableBackupDir(backupRootPath.toString(), backupId, tableName));</span> |
| <span class="source-line-no">096</span><span id="line-96"> }</span> |
| <span class="source-line-no">097</span><span id="line-97"></span> |
| <span class="source-line-no">098</span><span id="line-98"> private static Path getManifestPath(Configuration conf, Path backupRootPath, String backupId)</span> |
| <span class="source-line-no">099</span><span id="line-99"> throws IOException {</span> |
| <span class="source-line-no">100</span><span id="line-100"> FileSystem fs = backupRootPath.getFileSystem(conf);</span> |
| <span class="source-line-no">101</span><span id="line-101"> Path manifestPath = new Path(getBackupPath(backupRootPath.toString(), backupId) + Path.SEPARATOR</span> |
| <span class="source-line-no">102</span><span id="line-102"> + BackupManifest.MANIFEST_FILE_NAME);</span> |
| <span class="source-line-no">103</span><span id="line-103"> if (!fs.exists(manifestPath)) {</span> |
| <span class="source-line-no">104</span><span id="line-104"> String errorMsg = "Could not find backup manifest " + BackupManifest.MANIFEST_FILE_NAME</span> |
| <span class="source-line-no">105</span><span id="line-105"> + " for " + backupId + ". File " + manifestPath + " does not exists. Did " + backupId</span> |
| <span class="source-line-no">106</span><span id="line-106"> + " correspond to previously taken backup ?";</span> |
| <span class="source-line-no">107</span><span id="line-107"> throw new IOException(errorMsg);</span> |
| <span class="source-line-no">108</span><span id="line-108"> }</span> |
| <span class="source-line-no">109</span><span id="line-109"> return manifestPath;</span> |
| <span class="source-line-no">110</span><span id="line-110"> }</span> |
| <span class="source-line-no">111</span><span id="line-111"></span> |
| <span class="source-line-no">112</span><span id="line-112"> public static BackupManifest getManifest(Configuration conf, Path backupRootPath, String backupId)</span> |
| <span class="source-line-no">113</span><span id="line-113"> throws IOException {</span> |
| <span class="source-line-no">114</span><span id="line-114"> BackupManifest manifest =</span> |
| <span class="source-line-no">115</span><span id="line-115"> new BackupManifest(conf, getManifestPath(conf, backupRootPath, backupId));</span> |
| <span class="source-line-no">116</span><span id="line-116"> return manifest;</span> |
| <span class="source-line-no">117</span><span id="line-117"> }</span> |
| <span class="source-line-no">118</span><span id="line-118">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
