You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by gi...@apache.org on 2018/09/12 14:54:27 UTC
[26/49] hbase-site git commit: Published site at
3810ba2c6edfc531181ffc9e6c68396a0c2d2027.
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/705d69c4/devapidocs/src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html
----------------------------------------------------------------------
diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html b/devapidocs/src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html
index 7462d5b..63a00a7 100644
--- a/devapidocs/src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html
+++ b/devapidocs/src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html
@@ -122,294 +122,339 @@
<span class="sourceLineNo">114</span> /** Temporary directory under the snapshot directory to store in-progress snapshots */<a name="line.114"></a>
<span class="sourceLineNo">115</span> public static final String SNAPSHOT_TMP_DIR_NAME = ".tmp";<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
-<span class="sourceLineNo">117</span> /** This tag will be created in in-progess snapshots */<a name="line.117"></a>
-<span class="sourceLineNo">118</span> public static final String SNAPSHOT_IN_PROGRESS = ".inprogress";<a name="line.118"></a>
-<span class="sourceLineNo">119</span> // snapshot operation values<a name="line.119"></a>
-<span class="sourceLineNo">120</span> /** Default value if no start time is specified */<a name="line.120"></a>
-<span class="sourceLineNo">121</span> public static final long NO_SNAPSHOT_START_TIME_SPECIFIED = 0;<a name="line.121"></a>
+<span class="sourceLineNo">117</span> /**<a name="line.117"></a>
+<span class="sourceLineNo">118</span> * The configuration property that determines the filepath of the snapshot<a name="line.118"></a>
+<span class="sourceLineNo">119</span> * base working directory<a name="line.119"></a>
+<span class="sourceLineNo">120</span> */<a name="line.120"></a>
+<span class="sourceLineNo">121</span> public static final String SNAPSHOT_WORKING_DIR = "hbase.snapshot.working.dir";<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
-<span class="sourceLineNo">123</span><a name="line.123"></a>
-<span class="sourceLineNo">124</span> public static final String MASTER_SNAPSHOT_TIMEOUT_MILLIS = "hbase.snapshot.master.timeout.millis";<a name="line.124"></a>
-<span class="sourceLineNo">125</span><a name="line.125"></a>
-<span class="sourceLineNo">126</span> /** By default, wait 300 seconds for a snapshot to complete */<a name="line.126"></a>
-<span class="sourceLineNo">127</span> public static final long DEFAULT_MAX_WAIT_TIME = 60000 * 5 ;<a name="line.127"></a>
+<span class="sourceLineNo">123</span> /** This tag will be created in in-progess snapshots */<a name="line.123"></a>
+<span class="sourceLineNo">124</span> public static final String SNAPSHOT_IN_PROGRESS = ".inprogress";<a name="line.124"></a>
+<span class="sourceLineNo">125</span> // snapshot operation values<a name="line.125"></a>
+<span class="sourceLineNo">126</span> /** Default value if no start time is specified */<a name="line.126"></a>
+<span class="sourceLineNo">127</span> public static final long NO_SNAPSHOT_START_TIME_SPECIFIED = 0;<a name="line.127"></a>
<span class="sourceLineNo">128</span><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> * By default, check to see if the snapshot is complete (ms)<a name="line.131"></a>
-<span class="sourceLineNo">132</span> * @deprecated Use {@link #DEFAULT_MAX_WAIT_TIME} instead.<a name="line.132"></a>
-<span class="sourceLineNo">133</span> * */<a name="line.133"></a>
-<span class="sourceLineNo">134</span> @Deprecated<a name="line.134"></a>
-<span class="sourceLineNo">135</span> public static final int SNAPSHOT_TIMEOUT_MILLIS_DEFAULT = 60000 * 5;<a name="line.135"></a>
-<span class="sourceLineNo">136</span><a name="line.136"></a>
-<span class="sourceLineNo">137</span> /**<a name="line.137"></a>
-<span class="sourceLineNo">138</span> * Conf key for # of ms elapsed before injecting a snapshot timeout error when waiting for<a name="line.138"></a>
-<span class="sourceLineNo">139</span> * completion.<a name="line.139"></a>
-<span class="sourceLineNo">140</span> * @deprecated Use {@link #MASTER_SNAPSHOT_TIMEOUT_MILLIS} instead.<a name="line.140"></a>
-<span class="sourceLineNo">141</span> */<a name="line.141"></a>
-<span class="sourceLineNo">142</span> @Deprecated<a name="line.142"></a>
-<span class="sourceLineNo">143</span> public static final String SNAPSHOT_TIMEOUT_MILLIS_KEY = "hbase.snapshot.master.timeoutMillis";<a name="line.143"></a>
-<span class="sourceLineNo">144</span><a name="line.144"></a>
-<span class="sourceLineNo">145</span> private SnapshotDescriptionUtils() {<a name="line.145"></a>
-<span class="sourceLineNo">146</span> // private constructor for utility class<a name="line.146"></a>
-<span class="sourceLineNo">147</span> }<a name="line.147"></a>
-<span class="sourceLineNo">148</span><a name="line.148"></a>
-<span class="sourceLineNo">149</span> /**<a name="line.149"></a>
-<span class="sourceLineNo">150</span> * @param conf {@link Configuration} from which to check for the timeout<a name="line.150"></a>
-<span class="sourceLineNo">151</span> * @param type type of snapshot being taken<a name="line.151"></a>
-<span class="sourceLineNo">152</span> * @param defaultMaxWaitTime Default amount of time to wait, if none is in the configuration<a name="line.152"></a>
-<span class="sourceLineNo">153</span> * @return the max amount of time the master should wait for a snapshot to complete<a name="line.153"></a>
-<span class="sourceLineNo">154</span> */<a name="line.154"></a>
-<span class="sourceLineNo">155</span> public static long getMaxMasterTimeout(Configuration conf, SnapshotDescription.Type type,<a name="line.155"></a>
-<span class="sourceLineNo">156</span> long defaultMaxWaitTime) {<a name="line.156"></a>
-<span class="sourceLineNo">157</span> String confKey;<a name="line.157"></a>
-<span class="sourceLineNo">158</span> switch (type) {<a name="line.158"></a>
-<span class="sourceLineNo">159</span> case DISABLED:<a name="line.159"></a>
-<span class="sourceLineNo">160</span> default:<a name="line.160"></a>
-<span class="sourceLineNo">161</span> confKey = MASTER_SNAPSHOT_TIMEOUT_MILLIS;<a name="line.161"></a>
-<span class="sourceLineNo">162</span> }<a name="line.162"></a>
-<span class="sourceLineNo">163</span> return Math.max(conf.getLong(confKey, defaultMaxWaitTime),<a name="line.163"></a>
-<span class="sourceLineNo">164</span> conf.getLong(SNAPSHOT_TIMEOUT_MILLIS_KEY, defaultMaxWaitTime));<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> /**<a name="line.167"></a>
-<span class="sourceLineNo">168</span> * Get the snapshot root directory. All the snapshots are kept under this directory, i.e.<a name="line.168"></a>
-<span class="sourceLineNo">169</span> * ${hbase.rootdir}/.snapshot<a name="line.169"></a>
-<span class="sourceLineNo">170</span> * @param rootDir hbase root directory<a name="line.170"></a>
-<span class="sourceLineNo">171</span> * @return the base directory in which all snapshots are kept<a name="line.171"></a>
-<span class="sourceLineNo">172</span> */<a name="line.172"></a>
-<span class="sourceLineNo">173</span> public static Path getSnapshotRootDir(final Path rootDir) {<a name="line.173"></a>
-<span class="sourceLineNo">174</span> return new Path(rootDir, HConstants.SNAPSHOT_DIR_NAME);<a name="line.174"></a>
-<span class="sourceLineNo">175</span> }<a name="line.175"></a>
-<span class="sourceLineNo">176</span><a name="line.176"></a>
-<span class="sourceLineNo">177</span> /**<a name="line.177"></a>
-<span class="sourceLineNo">178</span> * Get the directory for a specified snapshot. This directory is a sub-directory of snapshot root<a name="line.178"></a>
-<span class="sourceLineNo">179</span> * directory and all the data files for a snapshot are kept under this directory.<a name="line.179"></a>
-<span class="sourceLineNo">180</span> * @param snapshot snapshot being taken<a name="line.180"></a>
-<span class="sourceLineNo">181</span> * @param rootDir hbase root directory<a name="line.181"></a>
-<span class="sourceLineNo">182</span> * @return the final directory for the completed snapshot<a name="line.182"></a>
-<span class="sourceLineNo">183</span> */<a name="line.183"></a>
-<span class="sourceLineNo">184</span> public static Path getCompletedSnapshotDir(final SnapshotDescription snapshot, final Path rootDir) {<a name="line.184"></a>
-<span class="sourceLineNo">185</span> return getCompletedSnapshotDir(snapshot.getName(), rootDir);<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> /**<a name="line.188"></a>
-<span class="sourceLineNo">189</span> * Get the directory for a completed snapshot. This directory is a sub-directory of snapshot root<a name="line.189"></a>
-<span class="sourceLineNo">190</span> * directory and all the data files for a snapshot are kept under this directory.<a name="line.190"></a>
-<span class="sourceLineNo">191</span> * @param snapshotName name of the snapshot being taken<a name="line.191"></a>
-<span class="sourceLineNo">192</span> * @param rootDir hbase root directory<a name="line.192"></a>
-<span class="sourceLineNo">193</span> * @return the final directory for the completed snapshot<a name="line.193"></a>
-<span class="sourceLineNo">194</span> */<a name="line.194"></a>
-<span class="sourceLineNo">195</span> public static Path getCompletedSnapshotDir(final String snapshotName, final Path rootDir) {<a name="line.195"></a>
-<span class="sourceLineNo">196</span> return getCompletedSnapshotDir(getSnapshotsDir(rootDir), snapshotName);<a name="line.196"></a>
-<span class="sourceLineNo">197</span> }<a name="line.197"></a>
-<span class="sourceLineNo">198</span><a name="line.198"></a>
-<span class="sourceLineNo">199</span> /**<a name="line.199"></a>
-<span class="sourceLineNo">200</span> * Get the general working directory for snapshots - where they are built, where they are<a name="line.200"></a>
-<span class="sourceLineNo">201</span> * temporarily copied on export, etc.<a name="line.201"></a>
-<span class="sourceLineNo">202</span> * @param rootDir root directory of the HBase installation<a name="line.202"></a>
-<span class="sourceLineNo">203</span> * @return Path to the snapshot tmp directory, relative to the passed root directory<a name="line.203"></a>
-<span class="sourceLineNo">204</span> */<a name="line.204"></a>
-<span class="sourceLineNo">205</span> public static Path getWorkingSnapshotDir(final Path rootDir) {<a name="line.205"></a>
-<span class="sourceLineNo">206</span> return new Path(getSnapshotsDir(rootDir), SNAPSHOT_TMP_DIR_NAME);<a name="line.206"></a>
-<span class="sourceLineNo">207</span> }<a name="line.207"></a>
-<span class="sourceLineNo">208</span><a name="line.208"></a>
-<span class="sourceLineNo">209</span> /**<a name="line.209"></a>
-<span class="sourceLineNo">210</span> * Get the directory to build a snapshot, before it is finalized<a name="line.210"></a>
-<span class="sourceLineNo">211</span> * @param snapshot snapshot that will be built<a name="line.211"></a>
-<span class="sourceLineNo">212</span> * @param rootDir root directory of the hbase installation<a name="line.212"></a>
-<span class="sourceLineNo">213</span> * @return {@link Path} where one can build a snapshot<a name="line.213"></a>
-<span class="sourceLineNo">214</span> */<a name="line.214"></a>
-<span class="sourceLineNo">215</span> public static Path getWorkingSnapshotDir(SnapshotDescription snapshot, final Path rootDir) {<a name="line.215"></a>
-<span class="sourceLineNo">216</span> return getCompletedSnapshotDir(getWorkingSnapshotDir(rootDir), snapshot.getName());<a name="line.216"></a>
-<span class="sourceLineNo">217</span> }<a name="line.217"></a>
-<span class="sourceLineNo">218</span><a name="line.218"></a>
-<span class="sourceLineNo">219</span> /**<a name="line.219"></a>
-<span class="sourceLineNo">220</span> * Get the directory to build a snapshot, before it is finalized<a name="line.220"></a>
-<span class="sourceLineNo">221</span> * @param snapshotName name of the snapshot<a name="line.221"></a>
-<span class="sourceLineNo">222</span> * @param rootDir root directory of the hbase installation<a name="line.222"></a>
-<span class="sourceLineNo">223</span> * @return {@link Path} where one can build a snapshot<a name="line.223"></a>
-<span class="sourceLineNo">224</span> */<a name="line.224"></a>
-<span class="sourceLineNo">225</span> public static Path getWorkingSnapshotDir(String snapshotName, final Path rootDir) {<a name="line.225"></a>
-<span class="sourceLineNo">226</span> return getCompletedSnapshotDir(getWorkingSnapshotDir(rootDir), snapshotName);<a name="line.226"></a>
+<span class="sourceLineNo">130</span> public static final String MASTER_SNAPSHOT_TIMEOUT_MILLIS = "hbase.snapshot.master.timeout.millis";<a name="line.130"></a>
+<span class="sourceLineNo">131</span><a name="line.131"></a>
+<span class="sourceLineNo">132</span> /** By default, wait 300 seconds for a snapshot to complete */<a name="line.132"></a>
+<span class="sourceLineNo">133</span> public static final long DEFAULT_MAX_WAIT_TIME = 60000 * 5 ;<a name="line.133"></a>
+<span class="sourceLineNo">134</span><a name="line.134"></a>
+<span class="sourceLineNo">135</span><a name="line.135"></a>
+<span class="sourceLineNo">136</span> /**<a name="line.136"></a>
+<span class="sourceLineNo">137</span> * By default, check to see if the snapshot is complete (ms)<a name="line.137"></a>
+<span class="sourceLineNo">138</span> * @deprecated Use {@link #DEFAULT_MAX_WAIT_TIME} instead.<a name="line.138"></a>
+<span class="sourceLineNo">139</span> * */<a name="line.139"></a>
+<span class="sourceLineNo">140</span> @Deprecated<a name="line.140"></a>
+<span class="sourceLineNo">141</span> public static final int SNAPSHOT_TIMEOUT_MILLIS_DEFAULT = 60000 * 5;<a name="line.141"></a>
+<span class="sourceLineNo">142</span><a name="line.142"></a>
+<span class="sourceLineNo">143</span> /**<a name="line.143"></a>
+<span class="sourceLineNo">144</span> * Conf key for # of ms elapsed before injecting a snapshot timeout error when waiting for<a name="line.144"></a>
+<span class="sourceLineNo">145</span> * completion.<a name="line.145"></a>
+<span class="sourceLineNo">146</span> * @deprecated Use {@link #MASTER_SNAPSHOT_TIMEOUT_MILLIS} instead.<a name="line.146"></a>
+<span class="sourceLineNo">147</span> */<a name="line.147"></a>
+<span class="sourceLineNo">148</span> @Deprecated<a name="line.148"></a>
+<span class="sourceLineNo">149</span> public static final String SNAPSHOT_TIMEOUT_MILLIS_KEY = "hbase.snapshot.master.timeoutMillis";<a name="line.149"></a>
+<span class="sourceLineNo">150</span><a name="line.150"></a>
+<span class="sourceLineNo">151</span> private SnapshotDescriptionUtils() {<a name="line.151"></a>
+<span class="sourceLineNo">152</span> // private constructor for utility class<a name="line.152"></a>
+<span class="sourceLineNo">153</span> }<a name="line.153"></a>
+<span class="sourceLineNo">154</span><a name="line.154"></a>
+<span class="sourceLineNo">155</span> /**<a name="line.155"></a>
+<span class="sourceLineNo">156</span> * @param conf {@link Configuration} from which to check for the timeout<a name="line.156"></a>
+<span class="sourceLineNo">157</span> * @param type type of snapshot being taken<a name="line.157"></a>
+<span class="sourceLineNo">158</span> * @param defaultMaxWaitTime Default amount of time to wait, if none is in the configuration<a name="line.158"></a>
+<span class="sourceLineNo">159</span> * @return the max amount of time the master should wait for a snapshot to complete<a name="line.159"></a>
+<span class="sourceLineNo">160</span> */<a name="line.160"></a>
+<span class="sourceLineNo">161</span> public static long getMaxMasterTimeout(Configuration conf, SnapshotDescription.Type type,<a name="line.161"></a>
+<span class="sourceLineNo">162</span> long defaultMaxWaitTime) {<a name="line.162"></a>
+<span class="sourceLineNo">163</span> String confKey;<a name="line.163"></a>
+<span class="sourceLineNo">164</span> switch (type) {<a name="line.164"></a>
+<span class="sourceLineNo">165</span> case DISABLED:<a name="line.165"></a>
+<span class="sourceLineNo">166</span> default:<a name="line.166"></a>
+<span class="sourceLineNo">167</span> confKey = MASTER_SNAPSHOT_TIMEOUT_MILLIS;<a name="line.167"></a>
+<span class="sourceLineNo">168</span> }<a name="line.168"></a>
+<span class="sourceLineNo">169</span> return Math.max(conf.getLong(confKey, defaultMaxWaitTime),<a name="line.169"></a>
+<span class="sourceLineNo">170</span> conf.getLong(SNAPSHOT_TIMEOUT_MILLIS_KEY, defaultMaxWaitTime));<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> * Get the snapshot root directory. All the snapshots are kept under this directory, i.e.<a name="line.174"></a>
+<span class="sourceLineNo">175</span> * ${hbase.rootdir}/.snapshot<a name="line.175"></a>
+<span class="sourceLineNo">176</span> * @param rootDir hbase root directory<a name="line.176"></a>
+<span class="sourceLineNo">177</span> * @return the base directory in which all snapshots are kept<a name="line.177"></a>
+<span class="sourceLineNo">178</span> */<a name="line.178"></a>
+<span class="sourceLineNo">179</span> public static Path getSnapshotRootDir(final Path rootDir) {<a name="line.179"></a>
+<span class="sourceLineNo">180</span> return new Path(rootDir, HConstants.SNAPSHOT_DIR_NAME);<a name="line.180"></a>
+<span class="sourceLineNo">181</span> }<a name="line.181"></a>
+<span class="sourceLineNo">182</span><a name="line.182"></a>
+<span class="sourceLineNo">183</span> /**<a name="line.183"></a>
+<span class="sourceLineNo">184</span> * Get the directory for a specified snapshot. This directory is a sub-directory of snapshot root<a name="line.184"></a>
+<span class="sourceLineNo">185</span> * directory and all the data files for a snapshot are kept under this directory.<a name="line.185"></a>
+<span class="sourceLineNo">186</span> * @param snapshot snapshot being taken<a name="line.186"></a>
+<span class="sourceLineNo">187</span> * @param rootDir hbase root directory<a name="line.187"></a>
+<span class="sourceLineNo">188</span> * @return the final directory for the completed snapshot<a name="line.188"></a>
+<span class="sourceLineNo">189</span> */<a name="line.189"></a>
+<span class="sourceLineNo">190</span> public static Path getCompletedSnapshotDir(final SnapshotDescription snapshot, final Path rootDir) {<a name="line.190"></a>
+<span class="sourceLineNo">191</span> return getCompletedSnapshotDir(snapshot.getName(), rootDir);<a name="line.191"></a>
+<span class="sourceLineNo">192</span> }<a name="line.192"></a>
+<span class="sourceLineNo">193</span><a name="line.193"></a>
+<span class="sourceLineNo">194</span> /**<a name="line.194"></a>
+<span class="sourceLineNo">195</span> * Get the directory for a completed snapshot. This directory is a sub-directory of snapshot root<a name="line.195"></a>
+<span class="sourceLineNo">196</span> * directory and all the data files for a snapshot are kept under this directory.<a name="line.196"></a>
+<span class="sourceLineNo">197</span> * @param snapshotName name of the snapshot being taken<a name="line.197"></a>
+<span class="sourceLineNo">198</span> * @param rootDir hbase root directory<a name="line.198"></a>
+<span class="sourceLineNo">199</span> * @return the final directory for the completed snapshot<a name="line.199"></a>
+<span class="sourceLineNo">200</span> */<a name="line.200"></a>
+<span class="sourceLineNo">201</span> public static Path getCompletedSnapshotDir(final String snapshotName, final Path rootDir) {<a name="line.201"></a>
+<span class="sourceLineNo">202</span> return getSpecifiedSnapshotDir(getSnapshotsDir(rootDir), snapshotName);<a name="line.202"></a>
+<span class="sourceLineNo">203</span> }<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> * Get the general working directory for snapshots - where they are built, where they are<a name="line.206"></a>
+<span class="sourceLineNo">207</span> * temporarily copied on export, etc.<a name="line.207"></a>
+<span class="sourceLineNo">208</span> * @param rootDir root directory of the HBase installation<a name="line.208"></a>
+<span class="sourceLineNo">209</span> * @param conf Configuration of the HBase instance<a name="line.209"></a>
+<span class="sourceLineNo">210</span> * @return Path to the snapshot tmp directory, relative to the passed root directory<a name="line.210"></a>
+<span class="sourceLineNo">211</span> */<a name="line.211"></a>
+<span class="sourceLineNo">212</span> public static Path getWorkingSnapshotDir(final Path rootDir, final Configuration conf) {<a name="line.212"></a>
+<span class="sourceLineNo">213</span> return new Path(conf.get(SNAPSHOT_WORKING_DIR,<a name="line.213"></a>
+<span class="sourceLineNo">214</span> getDefaultWorkingSnapshotDir(rootDir).toString()));<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> /**<a name="line.217"></a>
+<span class="sourceLineNo">218</span> * Get the directory to build a snapshot, before it is finalized<a name="line.218"></a>
+<span class="sourceLineNo">219</span> * @param snapshot snapshot that will be built<a name="line.219"></a>
+<span class="sourceLineNo">220</span> * @param rootDir root directory of the hbase installation<a name="line.220"></a>
+<span class="sourceLineNo">221</span> * @param conf Configuration of the HBase instance<a name="line.221"></a>
+<span class="sourceLineNo">222</span> * @return {@link Path} where one can build a snapshot<a name="line.222"></a>
+<span class="sourceLineNo">223</span> */<a name="line.223"></a>
+<span class="sourceLineNo">224</span> public static Path getWorkingSnapshotDir(SnapshotDescription snapshot, final Path rootDir,<a name="line.224"></a>
+<span class="sourceLineNo">225</span> Configuration conf) {<a name="line.225"></a>
+<span class="sourceLineNo">226</span> return getWorkingSnapshotDir(snapshot.getName(), rootDir, conf);<a name="line.226"></a>
<span class="sourceLineNo">227</span> }<a name="line.227"></a>
<span class="sourceLineNo">228</span><a name="line.228"></a>
<span class="sourceLineNo">229</span> /**<a name="line.229"></a>
-<span class="sourceLineNo">230</span> * Get the directory to store the snapshot instance<a name="line.230"></a>
-<span class="sourceLineNo">231</span> * @param snapshotsDir hbase-global directory for storing all snapshots<a name="line.231"></a>
-<span class="sourceLineNo">232</span> * @param snapshotName name of the snapshot to take<a name="line.232"></a>
-<span class="sourceLineNo">233</span> * @return the final directory for the completed snapshot<a name="line.233"></a>
-<span class="sourceLineNo">234</span> */<a name="line.234"></a>
-<span class="sourceLineNo">235</span> private static final Path getCompletedSnapshotDir(final Path snapshotsDir, String snapshotName) {<a name="line.235"></a>
-<span class="sourceLineNo">236</span> return new Path(snapshotsDir, snapshotName);<a name="line.236"></a>
-<span class="sourceLineNo">237</span> }<a name="line.237"></a>
-<span class="sourceLineNo">238</span><a name="line.238"></a>
-<span class="sourceLineNo">239</span> /**<a name="line.239"></a>
-<span class="sourceLineNo">240</span> * @param rootDir hbase root directory<a name="line.240"></a>
-<span class="sourceLineNo">241</span> * @return the directory for all completed snapshots;<a name="line.241"></a>
-<span class="sourceLineNo">242</span> */<a name="line.242"></a>
-<span class="sourceLineNo">243</span> public static final Path getSnapshotsDir(Path rootDir) {<a name="line.243"></a>
-<span class="sourceLineNo">244</span> return new Path(rootDir, HConstants.SNAPSHOT_DIR_NAME);<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> /**<a name="line.247"></a>
-<span class="sourceLineNo">248</span> * Convert the passed snapshot description into a 'full' snapshot description based on default<a name="line.248"></a>
-<span class="sourceLineNo">249</span> * parameters, if none have been supplied. This resolves any 'optional' parameters that aren't<a name="line.249"></a>
-<span class="sourceLineNo">250</span> * supplied to their default values.<a name="line.250"></a>
-<span class="sourceLineNo">251</span> * @param snapshot general snapshot descriptor<a name="line.251"></a>
-<span class="sourceLineNo">252</span> * @param conf Configuration to read configured snapshot defaults if snapshot is not complete<a name="line.252"></a>
-<span class="sourceLineNo">253</span> * @return a valid snapshot description<a name="line.253"></a>
-<span class="sourceLineNo">254</span> * @throws IllegalArgumentException if the {@link SnapshotDescription} is not a complete<a name="line.254"></a>
-<span class="sourceLineNo">255</span> * {@link SnapshotDescription}.<a name="line.255"></a>
-<span class="sourceLineNo">256</span> */<a name="line.256"></a>
-<span class="sourceLineNo">257</span> public static SnapshotDescription validate(SnapshotDescription snapshot, Configuration conf)<a name="line.257"></a>
-<span class="sourceLineNo">258</span> throws IllegalArgumentException, IOException {<a name="line.258"></a>
-<span class="sourceLineNo">259</span> if (!snapshot.hasTable()) {<a name="line.259"></a>
-<span class="sourceLineNo">260</span> throw new IllegalArgumentException(<a name="line.260"></a>
-<span class="sourceLineNo">261</span> "Descriptor doesn't apply to a table, so we can't build it.");<a name="line.261"></a>
-<span class="sourceLineNo">262</span> }<a name="line.262"></a>
-<span class="sourceLineNo">263</span><a name="line.263"></a>
-<span class="sourceLineNo">264</span> // set the creation time, if one hasn't been set<a name="line.264"></a>
-<span class="sourceLineNo">265</span> long time = snapshot.getCreationTime();<a name="line.265"></a>
-<span class="sourceLineNo">266</span> if (time == SnapshotDescriptionUtils.NO_SNAPSHOT_START_TIME_SPECIFIED) {<a name="line.266"></a>
-<span class="sourceLineNo">267</span> time = EnvironmentEdgeManager.currentTime();<a name="line.267"></a>
-<span class="sourceLineNo">268</span> LOG.debug("Creation time not specified, setting to:" + time + " (current time:"<a name="line.268"></a>
-<span class="sourceLineNo">269</span> + EnvironmentEdgeManager.currentTime() + ").");<a name="line.269"></a>
-<span class="sourceLineNo">270</span> SnapshotDescription.Builder builder = snapshot.toBuilder();<a name="line.270"></a>
-<span class="sourceLineNo">271</span> builder.setCreationTime(time);<a name="line.271"></a>
-<span class="sourceLineNo">272</span> snapshot = builder.build();<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> // set the acl to snapshot if security feature is enabled.<a name="line.275"></a>
-<span class="sourceLineNo">276</span> if (isSecurityAvailable(conf)) {<a name="line.276"></a>
-<span class="sourceLineNo">277</span> snapshot = writeAclToSnapshotDescription(snapshot, conf);<a name="line.277"></a>
-<span class="sourceLineNo">278</span> }<a name="line.278"></a>
-<span class="sourceLineNo">279</span> return snapshot;<a name="line.279"></a>
+<span class="sourceLineNo">230</span> * Get the directory to build a snapshot, before it is finalized<a name="line.230"></a>
+<span class="sourceLineNo">231</span> * @param snapshotName name of the snapshot<a name="line.231"></a>
+<span class="sourceLineNo">232</span> * @param rootDir root directory of the hbase installation<a name="line.232"></a>
+<span class="sourceLineNo">233</span> * @param conf Configuration of the HBase instance<a name="line.233"></a>
+<span class="sourceLineNo">234</span> * @return {@link Path} where one can build a snapshot<a name="line.234"></a>
+<span class="sourceLineNo">235</span> */<a name="line.235"></a>
+<span class="sourceLineNo">236</span> public static Path getWorkingSnapshotDir(String snapshotName, final Path rootDir,<a name="line.236"></a>
+<span class="sourceLineNo">237</span> Configuration conf) {<a name="line.237"></a>
+<span class="sourceLineNo">238</span> return getSpecifiedSnapshotDir(getWorkingSnapshotDir(rootDir, conf), snapshotName);<a name="line.238"></a>
+<span class="sourceLineNo">239</span> }<a name="line.239"></a>
+<span class="sourceLineNo">240</span><a name="line.240"></a>
+<span class="sourceLineNo">241</span> /**<a name="line.241"></a>
+<span class="sourceLineNo">242</span> * Get the directory within the given filepath to store the snapshot instance<a name="line.242"></a>
+<span class="sourceLineNo">243</span> * @param snapshotsDir directory to store snapshot directory within<a name="line.243"></a>
+<span class="sourceLineNo">244</span> * @param snapshotName name of the snapshot to take<a name="line.244"></a>
+<span class="sourceLineNo">245</span> * @return the final directory for the snapshot in the given filepath<a name="line.245"></a>
+<span class="sourceLineNo">246</span> */<a name="line.246"></a>
+<span class="sourceLineNo">247</span> private static final Path getSpecifiedSnapshotDir(final Path snapshotsDir, String snapshotName) {<a name="line.247"></a>
+<span class="sourceLineNo">248</span> return new Path(snapshotsDir, snapshotName);<a name="line.248"></a>
+<span class="sourceLineNo">249</span> }<a name="line.249"></a>
+<span class="sourceLineNo">250</span><a name="line.250"></a>
+<span class="sourceLineNo">251</span> /**<a name="line.251"></a>
+<span class="sourceLineNo">252</span> * @param rootDir hbase root directory<a name="line.252"></a>
+<span class="sourceLineNo">253</span> * @return the directory for all completed snapshots;<a name="line.253"></a>
+<span class="sourceLineNo">254</span> */<a name="line.254"></a>
+<span class="sourceLineNo">255</span> public static final Path getSnapshotsDir(Path rootDir) {<a name="line.255"></a>
+<span class="sourceLineNo">256</span> return new Path(rootDir, HConstants.SNAPSHOT_DIR_NAME);<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> /**<a name="line.259"></a>
+<span class="sourceLineNo">260</span> * Determines if the given workingDir is a subdirectory of the given "root directory"<a name="line.260"></a>
+<span class="sourceLineNo">261</span> * @param workingDir a directory to check<a name="line.261"></a>
+<span class="sourceLineNo">262</span> * @param rootDir root directory of the HBase installation<a name="line.262"></a>
+<span class="sourceLineNo">263</span> * @return true if the given workingDir is a subdirectory of the given root directory,<a name="line.263"></a>
+<span class="sourceLineNo">264</span> * false otherwise<a name="line.264"></a>
+<span class="sourceLineNo">265</span> */<a name="line.265"></a>
+<span class="sourceLineNo">266</span> public static boolean isSubDirectoryOf(final Path workingDir, final Path rootDir) {<a name="line.266"></a>
+<span class="sourceLineNo">267</span> return workingDir.toString().startsWith(rootDir.toString() + Path.SEPARATOR);<a name="line.267"></a>
+<span class="sourceLineNo">268</span> }<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> * Determines if the given workingDir is a subdirectory of the default working snapshot directory<a name="line.271"></a>
+<span class="sourceLineNo">272</span> * @param workingDir a directory to check<a name="line.272"></a>
+<span class="sourceLineNo">273</span> * @param conf configuration for the HBase cluster<a name="line.273"></a>
+<span class="sourceLineNo">274</span> * @return true if the given workingDir is a subdirectory of the default working directory for<a name="line.274"></a>
+<span class="sourceLineNo">275</span> * snapshots, false otherwise<a name="line.275"></a>
+<span class="sourceLineNo">276</span> */<a name="line.276"></a>
+<span class="sourceLineNo">277</span> public static boolean isWithinDefaultWorkingDir(final Path workingDir, Configuration conf) {<a name="line.277"></a>
+<span class="sourceLineNo">278</span> Path defaultWorkingDir = getDefaultWorkingSnapshotDir(new Path(conf.get(HConstants.HBASE_DIR)));<a name="line.278"></a>
+<span class="sourceLineNo">279</span> return workingDir.equals(defaultWorkingDir) || isSubDirectoryOf(workingDir, defaultWorkingDir);<a name="line.279"></a>
<span class="sourceLineNo">280</span> }<a name="line.280"></a>
<span class="sourceLineNo">281</span><a name="line.281"></a>
<span class="sourceLineNo">282</span> /**<a name="line.282"></a>
-<span class="sourceLineNo">283</span> * Write the snapshot description into the working directory of a snapshot<a name="line.283"></a>
-<span class="sourceLineNo">284</span> * @param snapshot description of the snapshot being taken<a name="line.284"></a>
-<span class="sourceLineNo">285</span> * @param workingDir working directory of the snapshot<a name="line.285"></a>
-<span class="sourceLineNo">286</span> * @param fs {@link FileSystem} on which the snapshot should be taken<a name="line.286"></a>
-<span class="sourceLineNo">287</span> * @throws IOException if we can't reach the filesystem and the file cannot be cleaned up on<a name="line.287"></a>
-<span class="sourceLineNo">288</span> * failure<a name="line.288"></a>
-<span class="sourceLineNo">289</span> */<a name="line.289"></a>
-<span class="sourceLineNo">290</span> public static void writeSnapshotInfo(SnapshotDescription snapshot, Path workingDir, FileSystem fs)<a name="line.290"></a>
-<span class="sourceLineNo">291</span> throws IOException {<a name="line.291"></a>
-<span class="sourceLineNo">292</span> FsPermission perms = FSUtils.getFilePermissions(fs, fs.getConf(),<a name="line.292"></a>
-<span class="sourceLineNo">293</span> HConstants.DATA_FILE_UMASK_KEY);<a name="line.293"></a>
-<span class="sourceLineNo">294</span> Path snapshotInfo = new Path(workingDir, SnapshotDescriptionUtils.SNAPSHOTINFO_FILE);<a name="line.294"></a>
-<span class="sourceLineNo">295</span> try {<a name="line.295"></a>
-<span class="sourceLineNo">296</span> FSDataOutputStream out = FSUtils.create(fs, snapshotInfo, perms, true);<a name="line.296"></a>
-<span class="sourceLineNo">297</span> try {<a name="line.297"></a>
-<span class="sourceLineNo">298</span> snapshot.writeTo(out);<a name="line.298"></a>
-<span class="sourceLineNo">299</span> } finally {<a name="line.299"></a>
-<span class="sourceLineNo">300</span> out.close();<a name="line.300"></a>
-<span class="sourceLineNo">301</span> }<a name="line.301"></a>
-<span class="sourceLineNo">302</span> } catch (IOException e) {<a name="line.302"></a>
-<span class="sourceLineNo">303</span> // if we get an exception, try to remove the snapshot info<a name="line.303"></a>
-<span class="sourceLineNo">304</span> if (!fs.delete(snapshotInfo, false)) {<a name="line.304"></a>
-<span class="sourceLineNo">305</span> String msg = "Couldn't delete snapshot info file: " + snapshotInfo;<a name="line.305"></a>
-<span class="sourceLineNo">306</span> LOG.error(msg);<a name="line.306"></a>
-<span class="sourceLineNo">307</span> throw new IOException(msg);<a name="line.307"></a>
-<span class="sourceLineNo">308</span> }<a name="line.308"></a>
-<span class="sourceLineNo">309</span> }<a name="line.309"></a>
-<span class="sourceLineNo">310</span> }<a name="line.310"></a>
-<span class="sourceLineNo">311</span><a name="line.311"></a>
-<span class="sourceLineNo">312</span> /**<a name="line.312"></a>
-<span class="sourceLineNo">313</span> * Create in-progress tag under .tmp of in-progress snapshot<a name="line.313"></a>
-<span class="sourceLineNo">314</span> * */<a name="line.314"></a>
-<span class="sourceLineNo">315</span> public static void createInProgressTag(Path workingDir, FileSystem fs) throws IOException {<a name="line.315"></a>
-<span class="sourceLineNo">316</span> FsPermission perms = FSUtils.getFilePermissions(fs, fs.getConf(),<a name="line.316"></a>
-<span class="sourceLineNo">317</span> HConstants.DATA_FILE_UMASK_KEY);<a name="line.317"></a>
-<span class="sourceLineNo">318</span> Path snapshot_in_progress = new Path(workingDir, SnapshotDescriptionUtils.SNAPSHOT_IN_PROGRESS);<a name="line.318"></a>
-<span class="sourceLineNo">319</span> FSUtils.create(fs, snapshot_in_progress, perms, true);<a name="line.319"></a>
-<span class="sourceLineNo">320</span> }<a name="line.320"></a>
-<span class="sourceLineNo">321</span><a name="line.321"></a>
-<span class="sourceLineNo">322</span> /**<a name="line.322"></a>
-<span class="sourceLineNo">323</span> * Read in the {@link org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription} stored for the snapshot in the passed directory<a name="line.323"></a>
-<span class="sourceLineNo">324</span> * @param fs filesystem where the snapshot was taken<a name="line.324"></a>
-<span class="sourceLineNo">325</span> * @param snapshotDir directory where the snapshot was stored<a name="line.325"></a>
-<span class="sourceLineNo">326</span> * @return the stored snapshot description<a name="line.326"></a>
-<span class="sourceLineNo">327</span> * @throws CorruptedSnapshotException if the<a name="line.327"></a>
-<span class="sourceLineNo">328</span> * snapshot cannot be read<a name="line.328"></a>
-<span class="sourceLineNo">329</span> */<a name="line.329"></a>
-<span class="sourceLineNo">330</span> public static SnapshotDescription readSnapshotInfo(FileSystem fs, Path snapshotDir)<a name="line.330"></a>
-<span class="sourceLineNo">331</span> throws CorruptedSnapshotException {<a name="line.331"></a>
-<span class="sourceLineNo">332</span> Path snapshotInfo = new Path(snapshotDir, SNAPSHOTINFO_FILE);<a name="line.332"></a>
-<span class="sourceLineNo">333</span> try {<a name="line.333"></a>
-<span class="sourceLineNo">334</span> FSDataInputStream in = null;<a name="line.334"></a>
-<span class="sourceLineNo">335</span> try {<a name="line.335"></a>
-<span class="sourceLineNo">336</span> in = fs.open(snapshotInfo);<a name="line.336"></a>
-<span class="sourceLineNo">337</span> SnapshotDescription desc = SnapshotDescription.parseFrom(in);<a name="line.337"></a>
-<span class="sourceLineNo">338</span> return desc;<a name="line.338"></a>
-<span class="sourceLineNo">339</span> } finally {<a name="line.339"></a>
-<span class="sourceLineNo">340</span> if (in != null) in.close();<a name="line.340"></a>
-<span class="sourceLineNo">341</span> }<a name="line.341"></a>
-<span class="sourceLineNo">342</span> } catch (IOException e) {<a name="line.342"></a>
-<span class="sourceLineNo">343</span> throw new CorruptedSnapshotException("Couldn't read snapshot info from:" + snapshotInfo, e);<a name="line.343"></a>
-<span class="sourceLineNo">344</span> }<a name="line.344"></a>
-<span class="sourceLineNo">345</span> }<a name="line.345"></a>
-<span class="sourceLineNo">346</span><a name="line.346"></a>
-<span class="sourceLineNo">347</span> /**<a name="line.347"></a>
-<span class="sourceLineNo">348</span> * Move the finished snapshot to its final, publicly visible directory - this marks the snapshot<a name="line.348"></a>
-<span class="sourceLineNo">349</span> * as 'complete'.<a name="line.349"></a>
-<span class="sourceLineNo">350</span> * @param snapshot description of the snapshot being tabken<a name="line.350"></a>
-<span class="sourceLineNo">351</span> * @param rootdir root directory of the hbase installation<a name="line.351"></a>
-<span class="sourceLineNo">352</span> * @param workingDir directory where the in progress snapshot was built<a name="line.352"></a>
-<span class="sourceLineNo">353</span> * @param fs {@link FileSystem} where the snapshot was built<a name="line.353"></a>
-<span class="sourceLineNo">354</span> * @throws org.apache.hadoop.hbase.snapshot.SnapshotCreationException if the<a name="line.354"></a>
-<span class="sourceLineNo">355</span> * snapshot could not be moved<a name="line.355"></a>
-<span class="sourceLineNo">356</span> * @throws IOException the filesystem could not be reached<a name="line.356"></a>
-<span class="sourceLineNo">357</span> */<a name="line.357"></a>
-<span class="sourceLineNo">358</span> public static void completeSnapshot(SnapshotDescription snapshot, Path rootdir, Path workingDir,<a name="line.358"></a>
-<span class="sourceLineNo">359</span> FileSystem fs) throws SnapshotCreationException, IOException {<a name="line.359"></a>
-<span class="sourceLineNo">360</span> Path finishedDir = getCompletedSnapshotDir(snapshot, rootdir);<a name="line.360"></a>
-<span class="sourceLineNo">361</span> LOG.debug("Snapshot is done, just moving the snapshot from " + workingDir + " to "<a name="line.361"></a>
-<span class="sourceLineNo">362</span> + finishedDir);<a name="line.362"></a>
-<span class="sourceLineNo">363</span> if (!fs.rename(workingDir, finishedDir)) {<a name="line.363"></a>
-<span class="sourceLineNo">364</span> throw new SnapshotCreationException(<a name="line.364"></a>
-<span class="sourceLineNo">365</span> "Failed to move working directory(" + workingDir + ") to completed directory("<a name="line.365"></a>
-<span class="sourceLineNo">366</span> + finishedDir + ").", ProtobufUtil.createSnapshotDesc(snapshot));<a name="line.366"></a>
-<span class="sourceLineNo">367</span> }<a name="line.367"></a>
-<span class="sourceLineNo">368</span> }<a name="line.368"></a>
-<span class="sourceLineNo">369</span><a name="line.369"></a>
-<span class="sourceLineNo">370</span> /**<a name="line.370"></a>
-<span class="sourceLineNo">371</span> * Check if the user is this table snapshot's owner<a name="line.371"></a>
-<span class="sourceLineNo">372</span> * @param snapshot the table snapshot description<a name="line.372"></a>
-<span class="sourceLineNo">373</span> * @param user the user<a name="line.373"></a>
-<span class="sourceLineNo">374</span> * @return true if the user is the owner of the snapshot,<a name="line.374"></a>
-<span class="sourceLineNo">375</span> * false otherwise or the snapshot owner field is not present.<a name="line.375"></a>
-<span class="sourceLineNo">376</span> */<a name="line.376"></a>
-<span class="sourceLineNo">377</span> public static boolean isSnapshotOwner(org.apache.hadoop.hbase.client.SnapshotDescription snapshot,<a name="line.377"></a>
-<span class="sourceLineNo">378</span> User user) {<a name="line.378"></a>
-<span class="sourceLineNo">379</span> if (user == null) return false;<a name="line.379"></a>
-<span class="sourceLineNo">380</span> return user.getShortName().equals(snapshot.getOwner());<a name="line.380"></a>
-<span class="sourceLineNo">381</span> }<a name="line.381"></a>
-<span class="sourceLineNo">382</span><a name="line.382"></a>
-<span class="sourceLineNo">383</span> public static boolean isSecurityAvailable(Configuration conf) throws IOException {<a name="line.383"></a>
-<span class="sourceLineNo">384</span> try (Connection conn = ConnectionFactory.createConnection(conf)) {<a name="line.384"></a>
-<span class="sourceLineNo">385</span> try (Admin admin = conn.getAdmin()) {<a name="line.385"></a>
-<span class="sourceLineNo">386</span> return admin.tableExists(AccessControlLists.ACL_TABLE_NAME);<a name="line.386"></a>
-<span class="sourceLineNo">387</span> }<a name="line.387"></a>
-<span class="sourceLineNo">388</span> }<a name="line.388"></a>
-<span class="sourceLineNo">389</span> }<a name="line.389"></a>
-<span class="sourceLineNo">390</span><a name="line.390"></a>
-<span class="sourceLineNo">391</span> private static SnapshotDescription writeAclToSnapshotDescription(SnapshotDescription snapshot,<a name="line.391"></a>
-<span class="sourceLineNo">392</span> Configuration conf) throws IOException {<a name="line.392"></a>
-<span class="sourceLineNo">393</span> ListMultimap<String, TablePermission> perms =<a name="line.393"></a>
-<span class="sourceLineNo">394</span> User.runAsLoginUser(new PrivilegedExceptionAction<ListMultimap<String, TablePermission>>() {<a name="line.394"></a>
-<span class="sourceLineNo">395</span> @Override<a name="line.395"></a>
-<span class="sourceLineNo">396</span> public ListMultimap<String, TablePermission> run() throws Exception {<a name="line.396"></a>
-<span class="sourceLineNo">397</span> return AccessControlLists.getTablePermissions(conf,<a name="line.397"></a>
-<span class="sourceLineNo">398</span> TableName.valueOf(snapshot.getTable()));<a name="line.398"></a>
-<span class="sourceLineNo">399</span> }<a name="line.399"></a>
-<span class="sourceLineNo">400</span> });<a name="line.400"></a>
-<span class="sourceLineNo">401</span> return snapshot.toBuilder()<a name="line.401"></a>
-<span class="sourceLineNo">402</span> .setUsersAndPermissions(ShadedAccessControlUtil.toUserTablePermissions(perms)).build();<a name="line.402"></a>
-<span class="sourceLineNo">403</span> }<a name="line.403"></a>
-<span class="sourceLineNo">404</span>}<a name="line.404"></a>
+<span class="sourceLineNo">283</span> * Get the default working directory for snapshots - where they are built, where they are<a name="line.283"></a>
+<span class="sourceLineNo">284</span> * temporarily copied on export, etc.<a name="line.284"></a>
+<span class="sourceLineNo">285</span> * @param rootDir root directory of the HBase installation<a name="line.285"></a>
+<span class="sourceLineNo">286</span> * @return Path to the default snapshot tmp directory, relative to the passed root directory<a name="line.286"></a>
+<span class="sourceLineNo">287</span> */<a name="line.287"></a>
+<span class="sourceLineNo">288</span> private static Path getDefaultWorkingSnapshotDir(final Path rootDir) {<a name="line.288"></a>
+<span class="sourceLineNo">289</span> return new Path(getSnapshotsDir(rootDir), SNAPSHOT_TMP_DIR_NAME);<a name="line.289"></a>
+<span class="sourceLineNo">290</span> }<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> * Convert the passed snapshot description into a 'full' snapshot description based on default<a name="line.293"></a>
+<span class="sourceLineNo">294</span> * parameters, if none have been supplied. This resolves any 'optional' parameters that aren't<a name="line.294"></a>
+<span class="sourceLineNo">295</span> * supplied to their default values.<a name="line.295"></a>
+<span class="sourceLineNo">296</span> * @param snapshot general snapshot descriptor<a name="line.296"></a>
+<span class="sourceLineNo">297</span> * @param conf Configuration to read configured snapshot defaults if snapshot is not complete<a name="line.297"></a>
+<span class="sourceLineNo">298</span> * @return a valid snapshot description<a name="line.298"></a>
+<span class="sourceLineNo">299</span> * @throws IllegalArgumentException if the {@link SnapshotDescription} is not a complete<a name="line.299"></a>
+<span class="sourceLineNo">300</span> * {@link SnapshotDescription}.<a name="line.300"></a>
+<span class="sourceLineNo">301</span> */<a name="line.301"></a>
+<span class="sourceLineNo">302</span> public static SnapshotDescription validate(SnapshotDescription snapshot, Configuration conf)<a name="line.302"></a>
+<span class="sourceLineNo">303</span> throws IllegalArgumentException, IOException {<a name="line.303"></a>
+<span class="sourceLineNo">304</span> if (!snapshot.hasTable()) {<a name="line.304"></a>
+<span class="sourceLineNo">305</span> throw new IllegalArgumentException(<a name="line.305"></a>
+<span class="sourceLineNo">306</span> "Descriptor doesn't apply to a table, so we can't build it.");<a name="line.306"></a>
+<span class="sourceLineNo">307</span> }<a name="line.307"></a>
+<span class="sourceLineNo">308</span><a name="line.308"></a>
+<span class="sourceLineNo">309</span> // set the creation time, if one hasn't been set<a name="line.309"></a>
+<span class="sourceLineNo">310</span> long time = snapshot.getCreationTime();<a name="line.310"></a>
+<span class="sourceLineNo">311</span> if (time == SnapshotDescriptionUtils.NO_SNAPSHOT_START_TIME_SPECIFIED) {<a name="line.311"></a>
+<span class="sourceLineNo">312</span> time = EnvironmentEdgeManager.currentTime();<a name="line.312"></a>
+<span class="sourceLineNo">313</span> LOG.debug("Creation time not specified, setting to:" + time + " (current time:"<a name="line.313"></a>
+<span class="sourceLineNo">314</span> + EnvironmentEdgeManager.currentTime() + ").");<a name="line.314"></a>
+<span class="sourceLineNo">315</span> SnapshotDescription.Builder builder = snapshot.toBuilder();<a name="line.315"></a>
+<span class="sourceLineNo">316</span> builder.setCreationTime(time);<a name="line.316"></a>
+<span class="sourceLineNo">317</span> snapshot = builder.build();<a name="line.317"></a>
+<span class="sourceLineNo">318</span> }<a name="line.318"></a>
+<span class="sourceLineNo">319</span><a name="line.319"></a>
+<span class="sourceLineNo">320</span> // set the acl to snapshot if security feature is enabled.<a name="line.320"></a>
+<span class="sourceLineNo">321</span> if (isSecurityAvailable(conf)) {<a name="line.321"></a>
+<span class="sourceLineNo">322</span> snapshot = writeAclToSnapshotDescription(snapshot, conf);<a name="line.322"></a>
+<span class="sourceLineNo">323</span> }<a name="line.323"></a>
+<span class="sourceLineNo">324</span> return snapshot;<a name="line.324"></a>
+<span class="sourceLineNo">325</span> }<a name="line.325"></a>
+<span class="sourceLineNo">326</span><a name="line.326"></a>
+<span class="sourceLineNo">327</span> /**<a name="line.327"></a>
+<span class="sourceLineNo">328</span> * Write the snapshot description into the working directory of a snapshot<a name="line.328"></a>
+<span class="sourceLineNo">329</span> * @param snapshot description of the snapshot being taken<a name="line.329"></a>
+<span class="sourceLineNo">330</span> * @param workingDir working directory of the snapshot<a name="line.330"></a>
+<span class="sourceLineNo">331</span> * @param fs {@link FileSystem} on which the snapshot should be taken<a name="line.331"></a>
+<span class="sourceLineNo">332</span> * @throws IOException if we can't reach the filesystem and the file cannot be cleaned up on<a name="line.332"></a>
+<span class="sourceLineNo">333</span> * failure<a name="line.333"></a>
+<span class="sourceLineNo">334</span> */<a name="line.334"></a>
+<span class="sourceLineNo">335</span> public static void writeSnapshotInfo(SnapshotDescription snapshot, Path workingDir, FileSystem fs)<a name="line.335"></a>
+<span class="sourceLineNo">336</span> throws IOException {<a name="line.336"></a>
+<span class="sourceLineNo">337</span> FsPermission perms = FSUtils.getFilePermissions(fs, fs.getConf(),<a name="line.337"></a>
+<span class="sourceLineNo">338</span> HConstants.DATA_FILE_UMASK_KEY);<a name="line.338"></a>
+<span class="sourceLineNo">339</span> Path snapshotInfo = new Path(workingDir, SnapshotDescriptionUtils.SNAPSHOTINFO_FILE);<a name="line.339"></a>
+<span class="sourceLineNo">340</span> try {<a name="line.340"></a>
+<span class="sourceLineNo">341</span> FSDataOutputStream out = FSUtils.create(fs, snapshotInfo, perms, true);<a name="line.341"></a>
+<span class="sourceLineNo">342</span> try {<a name="line.342"></a>
+<span class="sourceLineNo">343</span> snapshot.writeTo(out);<a name="line.343"></a>
+<span class="sourceLineNo">344</span> } finally {<a name="line.344"></a>
+<span class="sourceLineNo">345</span> out.close();<a name="line.345"></a>
+<span class="sourceLineNo">346</span> }<a name="line.346"></a>
+<span class="sourceLineNo">347</span> } catch (IOException e) {<a name="line.347"></a>
+<span class="sourceLineNo">348</span> // if we get an exception, try to remove the snapshot info<a name="line.348"></a>
+<span class="sourceLineNo">349</span> if (!fs.delete(snapshotInfo, false)) {<a name="line.349"></a>
+<span class="sourceLineNo">350</span> String msg = "Couldn't delete snapshot info file: " + snapshotInfo;<a name="line.350"></a>
+<span class="sourceLineNo">351</span> LOG.error(msg);<a name="line.351"></a>
+<span class="sourceLineNo">352</span> throw new IOException(msg);<a name="line.352"></a>
+<span class="sourceLineNo">353</span> }<a name="line.353"></a>
+<span class="sourceLineNo">354</span> }<a name="line.354"></a>
+<span class="sourceLineNo">355</span> }<a name="line.355"></a>
+<span class="sourceLineNo">356</span><a name="line.356"></a>
+<span class="sourceLineNo">357</span> /**<a name="line.357"></a>
+<span class="sourceLineNo">358</span> * Create in-progress tag under .tmp of in-progress snapshot<a name="line.358"></a>
+<span class="sourceLineNo">359</span> * */<a name="line.359"></a>
+<span class="sourceLineNo">360</span> public static void createInProgressTag(Path workingDir, FileSystem fs) throws IOException {<a name="line.360"></a>
+<span class="sourceLineNo">361</span> FsPermission perms = FSUtils.getFilePermissions(fs, fs.getConf(),<a name="line.361"></a>
+<span class="sourceLineNo">362</span> HConstants.DATA_FILE_UMASK_KEY);<a name="line.362"></a>
+<span class="sourceLineNo">363</span> Path snapshot_in_progress = new Path(workingDir, SnapshotDescriptionUtils.SNAPSHOT_IN_PROGRESS);<a name="line.363"></a>
+<span class="sourceLineNo">364</span> FSUtils.create(fs, snapshot_in_progress, perms, true);<a name="line.364"></a>
+<span class="sourceLineNo">365</span> }<a name="line.365"></a>
+<span class="sourceLineNo">366</span><a name="line.366"></a>
+<span class="sourceLineNo">367</span> /**<a name="line.367"></a>
+<span class="sourceLineNo">368</span> * Read in the {@link org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription} stored for the snapshot in the passed directory<a name="line.368"></a>
+<span class="sourceLineNo">369</span> * @param fs filesystem where the snapshot was taken<a name="line.369"></a>
+<span class="sourceLineNo">370</span> * @param snapshotDir directory where the snapshot was stored<a name="line.370"></a>
+<span class="sourceLineNo">371</span> * @return the stored snapshot description<a name="line.371"></a>
+<span class="sourceLineNo">372</span> * @throws CorruptedSnapshotException if the<a name="line.372"></a>
+<span class="sourceLineNo">373</span> * snapshot cannot be read<a name="line.373"></a>
+<span class="sourceLineNo">374</span> */<a name="line.374"></a>
+<span class="sourceLineNo">375</span> public static SnapshotDescription readSnapshotInfo(FileSystem fs, Path snapshotDir)<a name="line.375"></a>
+<span class="sourceLineNo">376</span> throws CorruptedSnapshotException {<a name="line.376"></a>
+<span class="sourceLineNo">377</span> Path snapshotInfo = new Path(snapshotDir, SNAPSHOTINFO_FILE);<a name="line.377"></a>
+<span class="sourceLineNo">378</span> try {<a name="line.378"></a>
+<span class="sourceLineNo">379</span> FSDataInputStream in = null;<a name="line.379"></a>
+<span class="sourceLineNo">380</span> try {<a name="line.380"></a>
+<span class="sourceLineNo">381</span> in = fs.open(snapshotInfo);<a name="line.381"></a>
+<span class="sourceLineNo">382</span> SnapshotDescription desc = SnapshotDescription.parseFrom(in);<a name="line.382"></a>
+<span class="sourceLineNo">383</span> return desc;<a name="line.383"></a>
+<span class="sourceLineNo">384</span> } finally {<a name="line.384"></a>
+<span class="sourceLineNo">385</span> if (in != null) in.close();<a name="line.385"></a>
+<span class="sourceLineNo">386</span> }<a name="line.386"></a>
+<span class="sourceLineNo">387</span> } catch (IOException e) {<a name="line.387"></a>
+<span class="sourceLineNo">388</span> throw new CorruptedSnapshotException("Couldn't read snapshot info from:" + snapshotInfo, e);<a name="line.388"></a>
+<span class="sourceLineNo">389</span> }<a name="line.389"></a>
+<span class="sourceLineNo">390</span> }<a name="line.390"></a>
+<span class="sourceLineNo">391</span><a name="line.391"></a>
+<span class="sourceLineNo">392</span> /**<a name="line.392"></a>
+<span class="sourceLineNo">393</span> * Move the finished snapshot to its final, publicly visible directory - this marks the snapshot<a name="line.393"></a>
+<span class="sourceLineNo">394</span> * as 'complete'.<a name="line.394"></a>
+<span class="sourceLineNo">395</span> * @param snapshot description of the snapshot being tabken<a name="line.395"></a>
+<span class="sourceLineNo">396</span> * @param rootdir root directory of the hbase installation<a name="line.396"></a>
+<span class="sourceLineNo">397</span> * @param workingDir directory where the in progress snapshot was built<a name="line.397"></a>
+<span class="sourceLineNo">398</span> * @param fs {@link FileSystem} where the snapshot was built<a name="line.398"></a>
+<span class="sourceLineNo">399</span> * @throws org.apache.hadoop.hbase.snapshot.SnapshotCreationException if the<a name="line.399"></a>
+<span class="sourceLineNo">400</span> * snapshot could not be moved<a name="line.400"></a>
+<span class="sourceLineNo">401</span> * @throws IOException the filesystem could not be reached<a name="line.401"></a>
+<span class="sourceLineNo">402</span> */<a name="line.402"></a>
+<span class="sourceLineNo">403</span> public static void completeSnapshot(SnapshotDescription snapshot, Path rootdir, Path workingDir,<a name="line.403"></a>
+<span class="sourceLineNo">404</span> FileSystem fs) throws SnapshotCreationException, IOException {<a name="line.404"></a>
+<span class="sourceLineNo">405</span> Path finishedDir = getCompletedSnapshotDir(snapshot, rootdir);<a name="line.405"></a>
+<span class="sourceLineNo">406</span> LOG.debug("Snapshot is done, just moving the snapshot from " + workingDir + " to "<a name="line.406"></a>
+<span class="sourceLineNo">407</span> + finishedDir);<a name="line.407"></a>
+<span class="sourceLineNo">408</span> if (!fs.rename(workingDir, finishedDir)) {<a name="line.408"></a>
+<span class="sourceLineNo">409</span> throw new SnapshotCreationException(<a name="line.409"></a>
+<span class="sourceLineNo">410</span> "Failed to move working directory(" + workingDir + ") to completed directory("<a name="line.410"></a>
+<span class="sourceLineNo">411</span> + finishedDir + ").", ProtobufUtil.createSnapshotDesc(snapshot));<a name="line.411"></a>
+<span class="sourceLineNo">412</span> }<a name="line.412"></a>
+<span class="sourceLineNo">413</span> }<a name="line.413"></a>
+<span class="sourceLineNo">414</span><a name="line.414"></a>
+<span class="sourceLineNo">415</span> /**<a name="line.415"></a>
+<span class="sourceLineNo">416</span> * Check if the user is this table snapshot's owner<a name="line.416"></a>
+<span class="sourceLineNo">417</span> * @param snapshot the table snapshot description<a name="line.417"></a>
+<span class="sourceLineNo">418</span> * @param user the user<a name="line.418"></a>
+<span class="sourceLineNo">419</span> * @return true if the user is the owner of the snapshot,<a name="line.419"></a>
+<span class="sourceLineNo">420</span> * false otherwise or the snapshot owner field is not present.<a name="line.420"></a>
+<span class="sourceLineNo">421</span> */<a name="line.421"></a>
+<span class="sourceLineNo">422</span> public static boolean isSnapshotOwner(org.apache.hadoop.hbase.client.SnapshotDescription snapshot,<a name="line.422"></a>
+<span class="sourceLineNo">423</span> User user) {<a name="line.423"></a>
+<span class="sourceLineNo">424</span> if (user == null) return false;<a name="line.424"></a>
+<span class="sourceLineNo">425</span> return user.getShortName().equals(snapshot.getOwner());<a name="line.425"></a>
+<span class="sourceLineNo">426</span> }<a name="line.426"></a>
+<span class="sourceLineNo">427</span><a name="line.427"></a>
+<span class="sourceLineNo">428</span> public static boolean isSecurityAvailable(Configuration conf) throws IOException {<a name="line.428"></a>
+<span class="sourceLineNo">429</span> try (Connection conn = ConnectionFactory.createConnection(conf)) {<a name="line.429"></a>
+<span class="sourceLineNo">430</span> try (Admin admin = conn.getAdmin()) {<a name="line.430"></a>
+<span class="sourceLineNo">431</span> return admin.tableExists(AccessControlLists.ACL_TABLE_NAME);<a name="line.431"></a>
+<span class="sourceLineNo">432</span> }<a name="line.432"></a>
+<span class="sourceLineNo">433</span> }<a name="line.433"></a>
+<span class="sourceLineNo">434</span> }<a name="line.434"></a>
+<span class="sourceLineNo">435</span><a name="line.435"></a>
+<span class="sourceLineNo">436</span> private static SnapshotDescription writeAclToSnapshotDescription(SnapshotDescription snapshot,<a name="line.436"></a>
+<span class="sourceLineNo">437</span> Configuration conf) throws IOException {<a name="line.437"></a>
+<span class="sourceLineNo">438</span> ListMultimap<String, TablePermission> perms =<a name="line.438"></a>
+<span class="sourceLineNo">439</span> User.runAsLoginUser(new PrivilegedExceptionAction<ListMultimap<String, TablePermission>>() {<a name="line.439"></a>
+<span class="sourceLineNo">440</span> @Override<a name="line.440"></a>
+<span class="sourceLineNo">441</span> public ListMultimap<String, TablePermission> run() throws Exception {<a name="line.441"></a>
+<span class="sourceLineNo">442</span> return AccessControlLists.getTablePermissions(conf,<a name="line.442"></a>
+<span class="sourceLineNo">443</span> TableName.valueOf(snapshot.getTable()));<a name="line.443"></a>
+<span class="sourceLineNo">444</span> }<a name="line.444"></a>
+<span class="sourceLineNo">445</span> });<a name="line.445"></a>
+<span class="sourceLineNo">446</span> return snapshot.toBuilder()<a name="line.446"></a>
+<span class="sourceLineNo">447</span> .setUsersAndPermissions(ShadedAccessControlUtil.toUserTablePermissions(perms)).build();<a name="line.447"></a>
+<span class="sourceLineNo">448</span> }<a name="line.448"></a>
+<span class="sourceLineNo">449</span>}<a name="line.449"></a>