http://git-wip-us.apache.org/repos/asf/hbase/blob/ef7355e1/devapidocs/src-html/org/apache/hadoop/hbase/constraint/Constraints.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/constraint/Constraints.html b/devapidocs/src-html/org/apache/hadoop/hbase/constraint/Constraints.html index 7ae9959..f8957c4 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/constraint/Constraints.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/constraint/Constraints.html @@ -162,473 +162,471 @@ <span class="sourceLineNo">154</span> /**<a name="line.154"></a> <span class="sourceLineNo">155</span> * Get the kv {@link Entry} in the descriptor for the specified class<a name="line.155"></a> <span class="sourceLineNo">156</span> * <a name="line.156"></a> -<span class="sourceLineNo">157</span> * @param desc<a name="line.157"></a> -<span class="sourceLineNo">158</span> * {@link HTableDescriptor} to read<a name="line.158"></a> -<span class="sourceLineNo">159</span> * @param clazz<a name="line.159"></a> -<span class="sourceLineNo">160</span> * to search for<a name="line.160"></a> -<span class="sourceLineNo">161</span> * @return the {@link Pair} of <key, value> in the table, if that class is<a name="line.161"></a> -<span class="sourceLineNo">162</span> * present. <tt>null</tt> otherwise.<a name="line.162"></a> -<span class="sourceLineNo">163</span> */<a name="line.163"></a> -<span class="sourceLineNo">164</span> private static Pair<String, String> getKeyValueForClass(<a name="line.164"></a> -<span class="sourceLineNo">165</span> HTableDescriptor desc, Class<? extends Constraint> clazz) {<a name="line.165"></a> -<span class="sourceLineNo">166</span> // get the serialized version of the constraint<a name="line.166"></a> -<span class="sourceLineNo">167</span> String key = serializeConstraintClass(clazz);<a name="line.167"></a> -<span class="sourceLineNo">168</span> String value = desc.getValue(key);<a name="line.168"></a> -<span class="sourceLineNo">169</span><a name="line.169"></a> -<span class="sourceLineNo">170</span> return value == null ? null : new Pair<String, String>(key, value);<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> * Add configuration-less constraints to the table.<a name="line.174"></a> -<span class="sourceLineNo">175</span> * <p><a name="line.175"></a> -<span class="sourceLineNo">176</span> * This will overwrite any configuration associated with the previous<a name="line.176"></a> -<span class="sourceLineNo">177</span> * constraint of the same class.<a name="line.177"></a> -<span class="sourceLineNo">178</span> * <p><a name="line.178"></a> -<span class="sourceLineNo">179</span> * Each constraint, when added to the table, will have a specific priority,<a name="line.179"></a> -<span class="sourceLineNo">180</span> * dictating the order in which the {@link Constraint} will be run. A<a name="line.180"></a> -<span class="sourceLineNo">181</span> * {@link Constraint} earlier in the list will be run before those later in<a name="line.181"></a> -<span class="sourceLineNo">182</span> * the list. The same logic applies between two Constraints over time (earlier<a name="line.182"></a> -<span class="sourceLineNo">183</span> * added is run first on the regionserver).<a name="line.183"></a> -<span class="sourceLineNo">184</span> * <a name="line.184"></a> -<span class="sourceLineNo">185</span> * @param desc<a name="line.185"></a> -<span class="sourceLineNo">186</span> * {@link HTableDescriptor} to add {@link Constraint Constraints}<a name="line.186"></a> -<span class="sourceLineNo">187</span> * @param constraints<a name="line.187"></a> -<span class="sourceLineNo">188</span> * {@link Constraint Constraints} to add. All constraints are<a name="line.188"></a> -<span class="sourceLineNo">189</span> * considered automatically enabled on add<a name="line.189"></a> -<span class="sourceLineNo">190</span> * @throws IOException<a name="line.190"></a> -<span class="sourceLineNo">191</span> * If constraint could not be serialized/added to table<a name="line.191"></a> -<span class="sourceLineNo">192</span> */<a name="line.192"></a> -<span class="sourceLineNo">193</span> public static void add(HTableDescriptor desc,<a name="line.193"></a> -<span class="sourceLineNo">194</span> Class<? extends Constraint>... constraints) throws IOException {<a name="line.194"></a> -<span class="sourceLineNo">195</span> // make sure constraints are enabled<a name="line.195"></a> -<span class="sourceLineNo">196</span> enable(desc);<a name="line.196"></a> -<span class="sourceLineNo">197</span> long priority = getNextPriority(desc);<a name="line.197"></a> -<span class="sourceLineNo">198</span><a name="line.198"></a> -<span class="sourceLineNo">199</span> // store each constraint<a name="line.199"></a> -<span class="sourceLineNo">200</span> for (Class<? extends Constraint> clazz : constraints) {<a name="line.200"></a> -<span class="sourceLineNo">201</span> addConstraint(desc, clazz, null, priority++);<a name="line.201"></a> -<span class="sourceLineNo">202</span> }<a name="line.202"></a> -<span class="sourceLineNo">203</span> updateLatestPriority(desc, priority);<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> * Add constraints and their associated configurations to the table.<a name="line.207"></a> -<span class="sourceLineNo">208</span> * <p><a name="line.208"></a> -<span class="sourceLineNo">209</span> * Adding the same constraint class twice will overwrite the first<a name="line.209"></a> -<span class="sourceLineNo">210</span> * constraint's configuration<a name="line.210"></a> -<span class="sourceLineNo">211</span> * <p><a name="line.211"></a> -<span class="sourceLineNo">212</span> * Each constraint, when added to the table, will have a specific priority,<a name="line.212"></a> -<span class="sourceLineNo">213</span> * dictating the order in which the {@link Constraint} will be run. A<a name="line.213"></a> -<span class="sourceLineNo">214</span> * {@link Constraint} earlier in the list will be run before those later in<a name="line.214"></a> -<span class="sourceLineNo">215</span> * the list. The same logic applies between two Constraints over time (earlier<a name="line.215"></a> -<span class="sourceLineNo">216</span> * added is run first on the regionserver).<a name="line.216"></a> -<span class="sourceLineNo">217</span> * <a name="line.217"></a> -<span class="sourceLineNo">218</span> * @param desc<a name="line.218"></a> -<span class="sourceLineNo">219</span> * {@link HTableDescriptor} to add a {@link Constraint}<a name="line.219"></a> -<span class="sourceLineNo">220</span> * @param constraints<a name="line.220"></a> -<span class="sourceLineNo">221</span> * {@link Pair} of a {@link Constraint} and its associated<a name="line.221"></a> -<span class="sourceLineNo">222</span> * {@link Configuration}. The Constraint will be configured on load<a name="line.222"></a> -<span class="sourceLineNo">223</span> * with the specified configuration.All constraints are considered<a name="line.223"></a> -<span class="sourceLineNo">224</span> * automatically enabled on add<a name="line.224"></a> -<span class="sourceLineNo">225</span> * @throws IOException<a name="line.225"></a> -<span class="sourceLineNo">226</span> * if any constraint could not be deserialized. Assumes if 1<a name="line.226"></a> -<span class="sourceLineNo">227</span> * constraint is not loaded properly, something has gone terribly<a name="line.227"></a> -<span class="sourceLineNo">228</span> * wrong and that all constraints need to be enforced.<a name="line.228"></a> -<span class="sourceLineNo">229</span> */<a name="line.229"></a> -<span class="sourceLineNo">230</span> public static void add(HTableDescriptor desc,<a name="line.230"></a> -<span class="sourceLineNo">231</span> Pair<Class<? extends Constraint>, Configuration>... constraints)<a name="line.231"></a> -<span class="sourceLineNo">232</span> throws IOException {<a name="line.232"></a> -<span class="sourceLineNo">233</span> enable(desc);<a name="line.233"></a> -<span class="sourceLineNo">234</span> long priority = getNextPriority(desc);<a name="line.234"></a> -<span class="sourceLineNo">235</span> for (Pair<Class<? extends Constraint>, Configuration> pair : constraints) {<a name="line.235"></a> -<span class="sourceLineNo">236</span> addConstraint(desc, pair.getFirst(), pair.getSecond(), priority++);<a name="line.236"></a> -<span class="sourceLineNo">237</span> }<a name="line.237"></a> -<span class="sourceLineNo">238</span> updateLatestPriority(desc, priority);<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> * Add a {@link Constraint} to the table with the given configuration<a name="line.242"></a> -<span class="sourceLineNo">243</span> * <p><a name="line.243"></a> -<span class="sourceLineNo">244</span> * Each constraint, when added to the table, will have a specific priority,<a name="line.244"></a> -<span class="sourceLineNo">245</span> * dictating the order in which the {@link Constraint} will be run. A<a name="line.245"></a> -<span class="sourceLineNo">246</span> * {@link Constraint} added will run on the regionserver before those added to<a name="line.246"></a> -<span class="sourceLineNo">247</span> * the {@link HTableDescriptor} later.<a name="line.247"></a> -<span class="sourceLineNo">248</span> * <a name="line.248"></a> -<span class="sourceLineNo">249</span> * @param desc<a name="line.249"></a> -<span class="sourceLineNo">250</span> * table descriptor to the constraint to<a name="line.250"></a> -<span class="sourceLineNo">251</span> * @param constraint<a name="line.251"></a> -<span class="sourceLineNo">252</span> * to be added<a name="line.252"></a> -<span class="sourceLineNo">253</span> * @param conf<a name="line.253"></a> -<span class="sourceLineNo">254</span> * configuration associated with the constraint<a name="line.254"></a> -<span class="sourceLineNo">255</span> * @throws IOException<a name="line.255"></a> -<span class="sourceLineNo">256</span> * if any constraint could not be deserialized. Assumes if 1<a name="line.256"></a> -<span class="sourceLineNo">257</span> * constraint is not loaded properly, something has gone terribly<a name="line.257"></a> -<span class="sourceLineNo">258</span> * wrong and that all constraints need to be enforced.<a name="line.258"></a> -<span class="sourceLineNo">259</span> */<a name="line.259"></a> -<span class="sourceLineNo">260</span> public static void add(HTableDescriptor desc,<a name="line.260"></a> -<span class="sourceLineNo">261</span> Class<? extends Constraint> constraint, Configuration conf)<a name="line.261"></a> -<span class="sourceLineNo">262</span> throws IOException {<a name="line.262"></a> -<span class="sourceLineNo">263</span> enable(desc);<a name="line.263"></a> -<span class="sourceLineNo">264</span> long priority = getNextPriority(desc);<a name="line.264"></a> -<span class="sourceLineNo">265</span> addConstraint(desc, constraint, conf, priority++);<a name="line.265"></a> -<span class="sourceLineNo">266</span><a name="line.266"></a> -<span class="sourceLineNo">267</span> updateLatestPriority(desc, priority);<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> * Write the raw constraint and configuration to the descriptor.<a name="line.271"></a> -<span class="sourceLineNo">272</span> * <p><a name="line.272"></a> -<span class="sourceLineNo">273</span> * This method takes care of creating a new configuration based on the passed<a name="line.273"></a> -<span class="sourceLineNo">274</span> * in configuration and then updating that with enabled and priority of the<a name="line.274"></a> -<span class="sourceLineNo">275</span> * constraint.<a name="line.275"></a> -<span class="sourceLineNo">276</span> * <p><a name="line.276"></a> -<span class="sourceLineNo">277</span> * When a constraint is added, it is automatically enabled.<a name="line.277"></a> -<span class="sourceLineNo">278</span> */<a name="line.278"></a> -<span class="sourceLineNo">279</span> private static void addConstraint(HTableDescriptor desc,<a name="line.279"></a> -<span class="sourceLineNo">280</span> Class<? extends Constraint> clazz, Configuration conf, long priority)<a name="line.280"></a> -<span class="sourceLineNo">281</span> throws IOException {<a name="line.281"></a> -<span class="sourceLineNo">282</span> writeConstraint(desc, serializeConstraintClass(clazz),<a name="line.282"></a> -<span class="sourceLineNo">283</span> configure(conf, true, priority));<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">286</span> /**<a name="line.286"></a> -<span class="sourceLineNo">287</span> * Setup the configuration for a constraint as to whether it is enabled and<a name="line.287"></a> -<span class="sourceLineNo">288</span> * its priority<a name="line.288"></a> -<span class="sourceLineNo">289</span> * <a name="line.289"></a> -<span class="sourceLineNo">290</span> * @param conf<a name="line.290"></a> -<span class="sourceLineNo">291</span> * on which to base the new configuration<a name="line.291"></a> -<span class="sourceLineNo">292</span> * @param enabled<a name="line.292"></a> -<span class="sourceLineNo">293</span> * <tt>true</tt> if it should be run<a name="line.293"></a> -<span class="sourceLineNo">294</span> * @param priority<a name="line.294"></a> -<span class="sourceLineNo">295</span> * relative to other constraints<a name="line.295"></a> -<span class="sourceLineNo">296</span> * @return a new configuration, storable in the {@link HTableDescriptor}<a name="line.296"></a> -<span class="sourceLineNo">297</span> */<a name="line.297"></a> -<span class="sourceLineNo">298</span> private static Configuration configure(Configuration conf, boolean enabled,<a name="line.298"></a> -<span class="sourceLineNo">299</span> long priority) {<a name="line.299"></a> -<span class="sourceLineNo">300</span> // create the configuration to actually be stored<a name="line.300"></a> -<span class="sourceLineNo">301</span> // clone if possible, but otherwise just create an empty configuration<a name="line.301"></a> -<span class="sourceLineNo">302</span> Configuration toWrite = conf == null ? new Configuration()<a name="line.302"></a> -<span class="sourceLineNo">303</span> : new Configuration(conf);<a name="line.303"></a> -<span class="sourceLineNo">304</span><a name="line.304"></a> -<span class="sourceLineNo">305</span> // update internal properties<a name="line.305"></a> -<span class="sourceLineNo">306</span> toWrite.setBooleanIfUnset(ENABLED_KEY, enabled);<a name="line.306"></a> -<span class="sourceLineNo">307</span><a name="line.307"></a> -<span class="sourceLineNo">308</span> // set if unset long<a name="line.308"></a> -<span class="sourceLineNo">309</span> if (toWrite.getLong(PRIORITY_KEY, UNSET_PRIORITY) == UNSET_PRIORITY) {<a name="line.309"></a> -<span class="sourceLineNo">310</span> toWrite.setLong(PRIORITY_KEY, priority);<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> return toWrite;<a name="line.313"></a> -<span class="sourceLineNo">314</span> }<a name="line.314"></a> -<span class="sourceLineNo">315</span><a name="line.315"></a> -<span class="sourceLineNo">316</span> /**<a name="line.316"></a> -<span class="sourceLineNo">317</span> * Just write the class to a String representation of the class as a key for<a name="line.317"></a> -<span class="sourceLineNo">318</span> * the {@link HTableDescriptor}<a name="line.318"></a> -<span class="sourceLineNo">319</span> * <a name="line.319"></a> -<span class="sourceLineNo">320</span> * @param clazz<a name="line.320"></a> -<span class="sourceLineNo">321</span> * Constraint class to convert to a {@link HTableDescriptor} key<a name="line.321"></a> -<span class="sourceLineNo">322</span> * @return key to store in the {@link HTableDescriptor}<a name="line.322"></a> -<span class="sourceLineNo">323</span> */<a name="line.323"></a> -<span class="sourceLineNo">324</span> private static String serializeConstraintClass(<a name="line.324"></a> -<span class="sourceLineNo">325</span> Class<? extends Constraint> clazz) {<a name="line.325"></a> -<span class="sourceLineNo">326</span> String constraintClazz = clazz.getName();<a name="line.326"></a> -<span class="sourceLineNo">327</span> return CONSTRAINT_HTD_KEY_PREFIX + constraintClazz;<a name="line.327"></a> -<span class="sourceLineNo">328</span> }<a name="line.328"></a> -<span class="sourceLineNo">329</span><a name="line.329"></a> -<span class="sourceLineNo">330</span> /**<a name="line.330"></a> -<span class="sourceLineNo">331</span> * Write the given key and associated configuration to the<a name="line.331"></a> -<span class="sourceLineNo">332</span> * {@link HTableDescriptor}<a name="line.332"></a> -<span class="sourceLineNo">333</span> */<a name="line.333"></a> -<span class="sourceLineNo">334</span> private static void writeConstraint(HTableDescriptor desc, String key,<a name="line.334"></a> -<span class="sourceLineNo">335</span> Configuration conf) throws IOException {<a name="line.335"></a> -<span class="sourceLineNo">336</span> // store the key and conf in the descriptor<a name="line.336"></a> -<span class="sourceLineNo">337</span> desc.setValue(key, serializeConfiguration(conf));<a name="line.337"></a> -<span class="sourceLineNo">338</span> }<a name="line.338"></a> -<span class="sourceLineNo">339</span><a name="line.339"></a> -<span class="sourceLineNo">340</span> /**<a name="line.340"></a> -<span class="sourceLineNo">341</span> * Write the configuration to a String<a name="line.341"></a> -<span class="sourceLineNo">342</span> * <a name="line.342"></a> -<span class="sourceLineNo">343</span> * @param conf<a name="line.343"></a> -<span class="sourceLineNo">344</span> * to write<a name="line.344"></a> -<span class="sourceLineNo">345</span> * @return String representation of that configuration<a name="line.345"></a> -<span class="sourceLineNo">346</span> * @throws IOException<a name="line.346"></a> -<span class="sourceLineNo">347</span> */<a name="line.347"></a> -<span class="sourceLineNo">348</span> private static String serializeConfiguration(Configuration conf)<a name="line.348"></a> -<span class="sourceLineNo">349</span> throws IOException {<a name="line.349"></a> -<span class="sourceLineNo">350</span> // write the configuration out to the data stream<a name="line.350"></a> -<span class="sourceLineNo">351</span> ByteArrayOutputStream bos = new ByteArrayOutputStream();<a name="line.351"></a> -<span class="sourceLineNo">352</span> DataOutputStream dos = new DataOutputStream(bos);<a name="line.352"></a> -<span class="sourceLineNo">353</span> conf.writeXml(dos);<a name="line.353"></a> -<span class="sourceLineNo">354</span> dos.flush();<a name="line.354"></a> -<span class="sourceLineNo">355</span> byte[] data = bos.toByteArray();<a name="line.355"></a> -<span class="sourceLineNo">356</span> return Bytes.toString(data);<a name="line.356"></a> -<span class="sourceLineNo">357</span> }<a name="line.357"></a> -<span class="sourceLineNo">358</span><a name="line.358"></a> -<span class="sourceLineNo">359</span> /**<a name="line.359"></a> -<span class="sourceLineNo">360</span> * Read the {@link Configuration} stored in the byte stream.<a name="line.360"></a> -<span class="sourceLineNo">361</span> * <a name="line.361"></a> -<span class="sourceLineNo">362</span> * @param bytes<a name="line.362"></a> -<span class="sourceLineNo">363</span> * to read from<a name="line.363"></a> -<span class="sourceLineNo">364</span> * @return A valid configuration<a name="line.364"></a> -<span class="sourceLineNo">365</span> */<a name="line.365"></a> -<span class="sourceLineNo">366</span> private static Configuration readConfiguration(byte[] bytes)<a name="line.366"></a> -<span class="sourceLineNo">367</span> throws IOException {<a name="line.367"></a> -<span class="sourceLineNo">368</span> ByteArrayInputStream is = new ByteArrayInputStream(bytes);<a name="line.368"></a> -<span class="sourceLineNo">369</span> Configuration conf = new Configuration(false);<a name="line.369"></a> -<span class="sourceLineNo">370</span> conf.addResource(is);<a name="line.370"></a> -<span class="sourceLineNo">371</span> return conf;<a name="line.371"></a> -<span class="sourceLineNo">372</span> }<a name="line.372"></a> -<span class="sourceLineNo">373</span><a name="line.373"></a> -<span class="sourceLineNo">374</span> /**<a name="line.374"></a> -<span class="sourceLineNo">375</span> * Read in the configuration from the String encoded configuration<a name="line.375"></a> -<span class="sourceLineNo">376</span> * <a name="line.376"></a> -<span class="sourceLineNo">377</span> * @param bytes<a name="line.377"></a> -<span class="sourceLineNo">378</span> * to read from<a name="line.378"></a> -<span class="sourceLineNo">379</span> * @return A valid configuration<a name="line.379"></a> -<span class="sourceLineNo">380</span> * @throws IOException<a name="line.380"></a> -<span class="sourceLineNo">381</span> * if the configuration could not be read<a name="line.381"></a> -<span class="sourceLineNo">382</span> */<a name="line.382"></a> -<span class="sourceLineNo">383</span> private static Configuration readConfiguration(String bytes)<a name="line.383"></a> -<span class="sourceLineNo">384</span> throws IOException {<a name="line.384"></a> -<span class="sourceLineNo">385</span> return readConfiguration(Bytes.toBytes(bytes));<a name="line.385"></a> -<span class="sourceLineNo">386</span> }<a name="line.386"></a> -<span class="sourceLineNo">387</span><a name="line.387"></a> -<span class="sourceLineNo">388</span> private static long getNextPriority(HTableDescriptor desc) {<a name="line.388"></a> -<span class="sourceLineNo">389</span> String value = desc.getValue(COUNTER_KEY);<a name="line.389"></a> -<span class="sourceLineNo">390</span><a name="line.390"></a> -<span class="sourceLineNo">391</span> long priority;<a name="line.391"></a> -<span class="sourceLineNo">392</span> // get the current priority<a name="line.392"></a> -<span class="sourceLineNo">393</span> if (value == null) {<a name="line.393"></a> -<span class="sourceLineNo">394</span> priority = MIN_PRIORITY;<a name="line.394"></a> -<span class="sourceLineNo">395</span> } else {<a name="line.395"></a> -<span class="sourceLineNo">396</span> priority = Long.parseLong(value) + 1;<a name="line.396"></a> -<span class="sourceLineNo">397</span> }<a name="line.397"></a> -<span class="sourceLineNo">398</span><a name="line.398"></a> -<span class="sourceLineNo">399</span> return priority;<a name="line.399"></a> -<span class="sourceLineNo">400</span> }<a name="line.400"></a> -<span class="sourceLineNo">401</span><a name="line.401"></a> -<span class="sourceLineNo">402</span> private static void updateLatestPriority(HTableDescriptor desc, long priority) {<a name="line.402"></a> -<span class="sourceLineNo">403</span> // update the max priority<a name="line.403"></a> -<span class="sourceLineNo">404</span> desc.setValue(COUNTER_KEY, Long.toString(priority));<a name="line.404"></a> -<span class="sourceLineNo">405</span> }<a name="line.405"></a> -<span class="sourceLineNo">406</span><a name="line.406"></a> -<span class="sourceLineNo">407</span> /**<a name="line.407"></a> -<span class="sourceLineNo">408</span> * Update the configuration for the {@link Constraint}; does not change the<a name="line.408"></a> -<span class="sourceLineNo">409</span> * order in which the constraint is run.<a name="line.409"></a> -<span class="sourceLineNo">410</span> * <a name="line.410"></a> -<span class="sourceLineNo">411</span> * @param desc<a name="line.411"></a> -<span class="sourceLineNo">412</span> * {@link HTableDescriptor} to update<a name="line.412"></a> -<span class="sourceLineNo">413</span> * @param clazz<a name="line.413"></a> -<span class="sourceLineNo">414</span> * {@link Constraint} to update<a name="line.414"></a> -<span class="sourceLineNo">415</span> * @param configuration<a name="line.415"></a> -<span class="sourceLineNo">416</span> * to update the {@link Constraint} with.<a name="line.416"></a> -<span class="sourceLineNo">417</span> * @throws IOException<a name="line.417"></a> -<span class="sourceLineNo">418</span> * if the Constraint was not stored correctly<a name="line.418"></a> -<span class="sourceLineNo">419</span> * @throws IllegalArgumentException<a name="line.419"></a> -<span class="sourceLineNo">420</span> * if the Constraint was not present on this table.<a name="line.420"></a> -<span class="sourceLineNo">421</span> */<a name="line.421"></a> -<span class="sourceLineNo">422</span> public static void setConfiguration(HTableDescriptor desc,<a name="line.422"></a> -<span class="sourceLineNo">423</span> Class<? extends Constraint> clazz, Configuration configuration)<a name="line.423"></a> -<span class="sourceLineNo">424</span> throws IOException, IllegalArgumentException {<a name="line.424"></a> -<span class="sourceLineNo">425</span> // get the entry for this class<a name="line.425"></a> -<span class="sourceLineNo">426</span> Pair<String, String> e = getKeyValueForClass(desc, clazz);<a name="line.426"></a> -<span class="sourceLineNo">427</span><a name="line.427"></a> -<span class="sourceLineNo">428</span> if (e == null) {<a name="line.428"></a> -<span class="sourceLineNo">429</span> throw new IllegalArgumentException("Constraint: " + clazz.getName()<a name="line.429"></a> -<span class="sourceLineNo">430</span> + " is not associated with this table.");<a name="line.430"></a> -<span class="sourceLineNo">431</span> }<a name="line.431"></a> -<span class="sourceLineNo">432</span><a name="line.432"></a> -<span class="sourceLineNo">433</span> // clone over the configuration elements<a name="line.433"></a> -<span class="sourceLineNo">434</span> Configuration conf = new Configuration(configuration);<a name="line.434"></a> -<span class="sourceLineNo">435</span><a name="line.435"></a> -<span class="sourceLineNo">436</span> // read in the previous info about the constraint<a name="line.436"></a> -<span class="sourceLineNo">437</span> Configuration internal = readConfiguration(e.getSecond());<a name="line.437"></a> -<span class="sourceLineNo">438</span><a name="line.438"></a> -<span class="sourceLineNo">439</span> // update the fields based on the previous settings<a name="line.439"></a> -<span class="sourceLineNo">440</span> conf.setIfUnset(ENABLED_KEY, internal.get(ENABLED_KEY));<a name="line.440"></a> -<span class="sourceLineNo">441</span> conf.setIfUnset(PRIORITY_KEY, internal.get(PRIORITY_KEY));<a name="line.441"></a> -<span class="sourceLineNo">442</span><a name="line.442"></a> -<span class="sourceLineNo">443</span> // update the current value<a name="line.443"></a> -<span class="sourceLineNo">444</span> writeConstraint(desc, e.getFirst(), conf);<a name="line.444"></a> -<span class="sourceLineNo">445</span> }<a name="line.445"></a> -<span class="sourceLineNo">446</span><a name="line.446"></a> -<span class="sourceLineNo">447</span> /**<a name="line.447"></a> -<span class="sourceLineNo">448</span> * Remove the constraint (and associated information) for the table<a name="line.448"></a> -<span class="sourceLineNo">449</span> * descriptor.<a name="line.449"></a> -<span class="sourceLineNo">450</span> * <a name="line.450"></a> -<span class="sourceLineNo">451</span> * @param desc<a name="line.451"></a> -<span class="sourceLineNo">452</span> * {@link HTableDescriptor} to modify<a name="line.452"></a> -<span class="sourceLineNo">453</span> * @param clazz<a name="line.453"></a> -<span class="sourceLineNo">454</span> * {@link Constraint} class to remove<a name="line.454"></a> -<span class="sourceLineNo">455</span> */<a name="line.455"></a> -<span class="sourceLineNo">456</span> public static void remove(HTableDescriptor desc,<a name="line.456"></a> -<span class="sourceLineNo">457</span> Class<? extends Constraint> clazz) {<a name="line.457"></a> -<span class="sourceLineNo">458</span> String key = serializeConstraintClass(clazz);<a name="line.458"></a> -<span class="sourceLineNo">459</span> desc.remove(key);<a name="line.459"></a> -<span class="sourceLineNo">460</span> }<a name="line.460"></a> -<span class="sourceLineNo">461</span><a name="line.461"></a> -<span class="sourceLineNo">462</span> /**<a name="line.462"></a> -<span class="sourceLineNo">463</span> * Enable the given {@link Constraint}. Retains all the information (e.g.<a name="line.463"></a> -<span class="sourceLineNo">464</span> * Configuration) for the {@link Constraint}, but makes sure that it gets<a name="line.464"></a> -<span class="sourceLineNo">465</span> * loaded on the table.<a name="line.465"></a> -<span class="sourceLineNo">466</span> * <a name="line.466"></a> -<span class="sourceLineNo">467</span> * @param desc<a name="line.467"></a> -<span class="sourceLineNo">468</span> * {@link HTableDescriptor} to modify<a name="line.468"></a> -<span class="sourceLineNo">469</span> * @param clazz<a name="line.469"></a> -<span class="sourceLineNo">470</span> * {@link Constraint} to enable<a name="line.470"></a> -<span class="sourceLineNo">471</span> * @throws IOException<a name="line.471"></a> -<span class="sourceLineNo">472</span> * If the constraint cannot be properly deserialized<a name="line.472"></a> -<span class="sourceLineNo">473</span> */<a name="line.473"></a> -<span class="sourceLineNo">474</span> public static void enableConstraint(HTableDescriptor desc,<a name="line.474"></a> -<span class="sourceLineNo">475</span> Class<? extends Constraint> clazz) throws IOException {<a name="line.475"></a> -<span class="sourceLineNo">476</span> changeConstraintEnabled(desc, clazz, true);<a name="line.476"></a> -<span class="sourceLineNo">477</span> }<a name="line.477"></a> -<span class="sourceLineNo">478</span><a name="line.478"></a> -<span class="sourceLineNo">479</span> /**<a name="line.479"></a> -<span class="sourceLineNo">480</span> * Disable the given {@link Constraint}. Retains all the information (e.g.<a name="line.480"></a> -<span class="sourceLineNo">481</span> * Configuration) for the {@link Constraint}, but it just doesn't load the<a name="line.481"></a> -<span class="sourceLineNo">482</span> * {@link Constraint} on the table.<a name="line.482"></a> -<span class="sourceLineNo">483</span> * <a name="line.483"></a> -<span class="sourceLineNo">484</span> * @param desc<a name="line.484"></a> -<span class="sourceLineNo">485</span> * {@link HTableDescriptor} to modify<a name="line.485"></a> -<span class="sourceLineNo">486</span> * @param clazz<a name="line.486"></a> -<span class="sourceLineNo">487</span> * {@link Constraint} to disable.<a name="line.487"></a> -<span class="sourceLineNo">488</span> * @throws IOException<a name="line.488"></a> -<span class="sourceLineNo">489</span> * if the constraint cannot be found<a name="line.489"></a> -<span class="sourceLineNo">490</span> */<a name="line.490"></a> -<span class="sourceLineNo">491</span> public static void disableConstraint(HTableDescriptor desc,<a name="line.491"></a> -<span class="sourceLineNo">492</span> Class<? extends Constraint> clazz) throws IOException {<a name="line.492"></a> -<span class="sourceLineNo">493</span> changeConstraintEnabled(desc, clazz, false);<a name="line.493"></a> -<span class="sourceLineNo">494</span> }<a name="line.494"></a> -<span class="sourceLineNo">495</span><a name="line.495"></a> -<span class="sourceLineNo">496</span> /**<a name="line.496"></a> -<span class="sourceLineNo">497</span> * Change the whether the constraint (if it is already present) is enabled or<a name="line.497"></a> -<span class="sourceLineNo">498</span> * disabled.<a name="line.498"></a> -<span class="sourceLineNo">499</span> */<a name="line.499"></a> -<span class="sourceLineNo">500</span> private static void changeConstraintEnabled(HTableDescriptor desc,<a name="line.500"></a> -<span class="sourceLineNo">501</span> Class<? extends Constraint> clazz, boolean enabled) throws IOException {<a name="line.501"></a> -<span class="sourceLineNo">502</span> // get the original constraint<a name="line.502"></a> -<span class="sourceLineNo">503</span> Pair<String, String> entry = getKeyValueForClass(desc, clazz);<a name="line.503"></a> -<span class="sourceLineNo">504</span> if (entry == null) {<a name="line.504"></a> -<span class="sourceLineNo">505</span> throw new IllegalArgumentException("Constraint: " + clazz.getName()<a name="line.505"></a> -<span class="sourceLineNo">506</span> + " is not associated with this table. You can't enable it!");<a name="line.506"></a> -<span class="sourceLineNo">507</span> }<a name="line.507"></a> -<span class="sourceLineNo">508</span><a name="line.508"></a> -<span class="sourceLineNo">509</span> // create a new configuration from that conf<a name="line.509"></a> -<span class="sourceLineNo">510</span> Configuration conf = readConfiguration(entry.getSecond());<a name="line.510"></a> -<span class="sourceLineNo">511</span><a name="line.511"></a> -<span class="sourceLineNo">512</span> // set that it is enabled<a name="line.512"></a> -<span class="sourceLineNo">513</span> conf.setBoolean(ENABLED_KEY, enabled);<a name="line.513"></a> -<span class="sourceLineNo">514</span><a name="line.514"></a> -<span class="sourceLineNo">515</span> // write it back out<a name="line.515"></a> -<span class="sourceLineNo">516</span> writeConstraint(desc, entry.getFirst(), conf);<a name="line.516"></a> -<span class="sourceLineNo">517</span> }<a name="line.517"></a> -<span class="sourceLineNo">518</span><a name="line.518"></a> -<span class="sourceLineNo">519</span> /**<a name="line.519"></a> -<span class="sourceLineNo">520</span> * Check to see if the given constraint is enabled.<a name="line.520"></a> -<span class="sourceLineNo">521</span> * <a name="line.521"></a> -<span class="sourceLineNo">522</span> * @param desc<a name="line.522"></a> -<span class="sourceLineNo">523</span> * {@link HTableDescriptor} to check.<a name="line.523"></a> -<span class="sourceLineNo">524</span> * @param clazz<a name="line.524"></a> -<span class="sourceLineNo">525</span> * {@link Constraint} to check for<a name="line.525"></a> -<span class="sourceLineNo">526</span> * @return <tt>true</tt> if the {@link Constraint} is present and enabled.<a name="line.526"></a> -<span class="sourceLineNo">527</span> * <tt>false</tt> otherwise.<a name="line.527"></a> -<span class="sourceLineNo">528</span> * @throws IOException<a name="line.528"></a> -<span class="sourceLineNo">529</span> * If the constraint has improperly stored in the table<a name="line.529"></a> -<span class="sourceLineNo">530</span> */<a name="line.530"></a> -<span class="sourceLineNo">531</span> public static boolean enabled(HTableDescriptor desc,<a name="line.531"></a> -<span class="sourceLineNo">532</span> Class<? extends Constraint> clazz) throws IOException {<a name="line.532"></a> -<span class="sourceLineNo">533</span> // get the kv<a name="line.533"></a> -<span class="sourceLineNo">534</span> Pair<String, String> entry = getKeyValueForClass(desc, clazz);<a name="line.534"></a> -<span class="sourceLineNo">535</span> // its not enabled so just return false. In fact, its not even present!<a name="line.535"></a> -<span class="sourceLineNo">536</span> if (entry == null) {<a name="line.536"></a> -<span class="sourceLineNo">537</span> return false;<a name="line.537"></a> -<span class="sourceLineNo">538</span> }<a name="line.538"></a> -<span class="sourceLineNo">539</span><a name="line.539"></a> -<span class="sourceLineNo">540</span> // get the info about the constraint<a name="line.540"></a> -<span class="sourceLineNo">541</span> Configuration conf = readConfiguration(entry.getSecond());<a name="line.541"></a> -<span class="sourceLineNo">542</span><a name="line.542"></a> -<span class="sourceLineNo">543</span> return conf.getBoolean(ENABLED_KEY, false);<a name="line.543"></a> -<span class="sourceLineNo">544</span> }<a name="line.544"></a> -<span class="sourceLineNo">545</span><a name="line.545"></a> -<span class="sourceLineNo">546</span> /**<a name="line.546"></a> -<span class="sourceLineNo">547</span> * Get the constraints stored in the table descriptor<a name="line.547"></a> -<span class="sourceLineNo">548</span> * <a name="line.548"></a> -<span class="sourceLineNo">549</span> * @param desc<a name="line.549"></a> -<span class="sourceLineNo">550</span> * To read from<a name="line.550"></a> -<span class="sourceLineNo">551</span> * @param classloader<a name="line.551"></a> -<span class="sourceLineNo">552</span> * To use when loading classes. If a special classloader is used on a<a name="line.552"></a> -<span class="sourceLineNo">553</span> * region, for instance, then that should be the classloader used to<a name="line.553"></a> -<span class="sourceLineNo">554</span> * load the constraints. This could also apply to unit-testing<a name="line.554"></a> -<span class="sourceLineNo">555</span> * situation, where want to ensure that class is reloaded or not.<a name="line.555"></a> -<span class="sourceLineNo">556</span> * @return List of configured {@link Constraint Constraints}<a name="line.556"></a> -<span class="sourceLineNo">557</span> * @throws IOException<a name="line.557"></a> -<span class="sourceLineNo">558</span> * if any part of reading/arguments fails<a name="line.558"></a> -<span class="sourceLineNo">559</span> */<a name="line.559"></a> -<span class="sourceLineNo">560</span> static List<? extends Constraint> getConstraints(HTableDescriptor desc,<a name="line.560"></a> -<span class="sourceLineNo">561</span> ClassLoader classloader) throws IOException {<a name="line.561"></a> -<span class="sourceLineNo">562</span> List<Constraint> constraints = new ArrayList<Constraint>();<a name="line.562"></a> -<span class="sourceLineNo">563</span> // loop through all the key, values looking for constraints<a name="line.563"></a> -<span class="sourceLineNo">564</span> for (Map.Entry<Bytes, Bytes> e : desc<a name="line.564"></a> -<span class="sourceLineNo">565</span> .getValues().entrySet()) {<a name="line.565"></a> -<span class="sourceLineNo">566</span> // read out the constraint<a name="line.566"></a> -<span class="sourceLineNo">567</span> String key = Bytes.toString(e.getKey().get()).trim();<a name="line.567"></a> -<span class="sourceLineNo">568</span> String[] className = CONSTRAINT_HTD_ATTR_KEY_PATTERN.split(key);<a name="line.568"></a> -<span class="sourceLineNo">569</span> if (className.length == 2) {<a name="line.569"></a> -<span class="sourceLineNo">570</span> key = className[1];<a name="line.570"></a> -<span class="sourceLineNo">571</span> if (LOG.isDebugEnabled()) {<a name="line.571"></a> -<span class="sourceLineNo">572</span> LOG.debug("Loading constraint:" + key);<a name="line.572"></a> -<span class="sourceLineNo">573</span> }<a name="line.573"></a> -<span class="sourceLineNo">574</span><a name="line.574"></a> -<span class="sourceLineNo">575</span> // read in the rest of the constraint<a name="line.575"></a> -<span class="sourceLineNo">576</span> Configuration conf;<a name="line.576"></a> -<span class="sourceLineNo">577</span> try {<a name="line.577"></a> -<span class="sourceLineNo">578</span> conf = readConfiguration(e.getValue().get());<a name="line.578"></a> -<span class="sourceLineNo">579</span> } catch (IOException e1) {<a name="line.579"></a> -<span class="sourceLineNo">580</span> // long that we don't have a valid configuration stored, and move on.<a name="line.580"></a> -<span class="sourceLineNo">581</span> LOG.warn("Corrupted configuration found for key:" + key<a name="line.581"></a> -<span class="sourceLineNo">582</span> + ", skipping it.");<a name="line.582"></a> -<span class="sourceLineNo">583</span> continue;<a name="line.583"></a> -<span class="sourceLineNo">584</span> }<a name="line.584"></a> -<span class="sourceLineNo">585</span> // if it is not enabled, skip it<a name="line.585"></a> -<span class="sourceLineNo">586</span> if (!conf.getBoolean(ENABLED_KEY, false)) {<a name="line.586"></a> -<span class="sourceLineNo">587</span> if (LOG.isDebugEnabled())<a name="line.587"></a> -<span class="sourceLineNo">588</span> LOG.debug("Constraint: " + key + " is DISABLED - skipping it");<a name="line.588"></a> -<span class="sourceLineNo">589</span> // go to the next constraint<a name="line.589"></a> -<span class="sourceLineNo">590</span> continue;<a name="line.590"></a> -<span class="sourceLineNo">591</span> }<a name="line.591"></a> -<span class="sourceLineNo">592</span><a name="line.592"></a> -<span class="sourceLineNo">593</span> try {<a name="line.593"></a> -<span class="sourceLineNo">594</span> // add the constraint, now that we expect it to be valid.<a name="line.594"></a> -<span class="sourceLineNo">595</span> Class<? extends Constraint> clazz = classloader.loadClass(key)<a name="line.595"></a> -<span class="sourceLineNo">596</span> .asSubclass(Constraint.class);<a name="line.596"></a> -<span class="sourceLineNo">597</span> Constraint constraint = clazz.newInstance();<a name="line.597"></a> -<span class="sourceLineNo">598</span> constraint.setConf(conf);<a name="line.598"></a> -<span class="sourceLineNo">599</span> constraints.add(constraint);<a name="line.599"></a> -<span class="sourceLineNo">600</span> } catch (ClassNotFoundException e1) {<a name="line.600"></a> +<span class="sourceLineNo">157</span> * @param desc {@link HTableDescriptor} to read<a name="line.157"></a> +<span class="sourceLineNo">158</span> * @param clazz To search for<a name="line.158"></a> +<span class="sourceLineNo">159</span> * @return The {@link Pair} of {@literal <key, value>} in the table, if that class is<a name="line.159"></a> +<span class="sourceLineNo">160</span> * present. {@code NULL} otherwise.<a name="line.160"></a> +<span class="sourceLineNo">161</span> */<a name="line.161"></a> +<span class="sourceLineNo">162</span> private static Pair<String, String> getKeyValueForClass(<a name="line.162"></a> +<span class="sourceLineNo">163</span> HTableDescriptor desc, Class<? extends Constraint> clazz) {<a name="line.163"></a> +<span class="sourceLineNo">164</span> // get the serialized version of the constraint<a name="line.164"></a> +<span class="sourceLineNo">165</span> String key = serializeConstraintClass(clazz);<a name="line.165"></a> +<span class="sourceLineNo">166</span> String value = desc.getValue(key);<a name="line.166"></a> +<span class="sourceLineNo">167</span><a name="line.167"></a> +<span class="sourceLineNo">168</span> return value == null ? null : new Pair<String, String>(key, value);<a name="line.168"></a> +<span class="sourceLineNo">169</span> }<a name="line.169"></a> +<span class="sourceLineNo">170</span><a name="line.170"></a> +<span class="sourceLineNo">171</span> /**<a name="line.171"></a> +<span class="sourceLineNo">172</span> * Add configuration-less constraints to the table.<a name="line.172"></a> +<span class="sourceLineNo">173</span> * <p><a name="line.173"></a> +<span class="sourceLineNo">174</span> * This will overwrite any configuration associated with the previous<a name="line.174"></a> +<span class="sourceLineNo">175</span> * constraint of the same class.<a name="line.175"></a> +<span class="sourceLineNo">176</span> * <p><a name="line.176"></a> +<span class="sourceLineNo">177</span> * Each constraint, when added to the table, will have a specific priority,<a name="line.177"></a> +<span class="sourceLineNo">178</span> * dictating the order in which the {@link Constraint} will be run. A<a name="line.178"></a> +<span class="sourceLineNo">179</span> * {@link Constraint} earlier in the list will be run before those later in<a name="line.179"></a> +<span class="sourceLineNo">180</span> * the list. The same logic applies between two Constraints over time (earlier<a name="line.180"></a> +<span class="sourceLineNo">181</span> * added is run first on the regionserver).<a name="line.181"></a> +<span class="sourceLineNo">182</span> * <a name="line.182"></a> +<span class="sourceLineNo">183</span> * @param desc<a name="line.183"></a> +<span class="sourceLineNo">184</span> * {@link HTableDescriptor} to add {@link Constraint Constraints}<a name="line.184"></a> +<span class="sourceLineNo">185</span> * @param constraints<a name="line.185"></a> +<span class="sourceLineNo">186</span> * {@link Constraint Constraints} to add. All constraints are<a name="line.186"></a> +<span class="sourceLineNo">187</span> * considered automatically enabled on add<a name="line.187"></a> +<span class="sourceLineNo">188</span> * @throws IOException<a name="line.188"></a> +<span class="sourceLineNo">189</span> * If constraint could not be serialized/added to table<a name="line.189"></a> +<span class="sourceLineNo">190</span> */<a name="line.190"></a> +<span class="sourceLineNo">191</span> public static void add(HTableDescriptor desc,<a name="line.191"></a> +<span class="sourceLineNo">192</span> Class<? extends Constraint>... constraints) throws IOException {<a name="line.192"></a> +<span class="sourceLineNo">193</span> // make sure constraints are enabled<a name="line.193"></a> +<span class="sourceLineNo">194</span> enable(desc);<a name="line.194"></a> +<span class="sourceLineNo">195</span> long priority = getNextPriority(desc);<a name="line.195"></a> +<span class="sourceLineNo">196</span><a name="line.196"></a> +<span class="sourceLineNo">197</span> // store each constraint<a name="line.197"></a> +<span class="sourceLineNo">198</span> for (Class<? extends Constraint> clazz : constraints) {<a name="line.198"></a> +<span class="sourceLineNo">199</span> addConstraint(desc, clazz, null, priority++);<a name="line.199"></a> +<span class="sourceLineNo">200</span> }<a name="line.200"></a> +<span class="sourceLineNo">201</span> updateLatestPriority(desc, priority);<a name="line.201"></a> +<span class="sourceLineNo">202</span> }<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> * Add constraints and their associated configurations to the table.<a name="line.205"></a> +<span class="sourceLineNo">206</span> * <p><a name="line.206"></a> +<span class="sourceLineNo">207</span> * Adding the same constraint class twice will overwrite the first<a name="line.207"></a> +<span class="sourceLineNo">208</span> * constraint's configuration<a name="line.208"></a> +<span class="sourceLineNo">209</span> * <p><a name="line.209"></a> +<span class="sourceLineNo">210</span> * Each constraint, when added to the table, will have a specific priority,<a name="line.210"></a> +<span class="sourceLineNo">211</span> * dictating the order in which the {@link Constraint} will be run. A<a name="line.211"></a> +<span class="sourceLineNo">212</span> * {@link Constraint} earlier in the list will be run before those later in<a name="line.212"></a> +<span class="sourceLineNo">213</span> * the list. The same logic applies between two Constraints over time (earlier<a name="line.213"></a> +<span class="sourceLineNo">214</span> * added is run first on the regionserver).<a name="line.214"></a> +<span class="sourceLineNo">215</span> * <a name="line.215"></a> +<span class="sourceLineNo">216</span> * @param desc<a name="line.216"></a> +<span class="sourceLineNo">217</span> * {@link HTableDescriptor} to add a {@link Constraint}<a name="line.217"></a> +<span class="sourceLineNo">218</span> * @param constraints<a name="line.218"></a> +<span class="sourceLineNo">219</span> * {@link Pair} of a {@link Constraint} and its associated<a name="line.219"></a> +<span class="sourceLineNo">220</span> * {@link Configuration}. The Constraint will be configured on load<a name="line.220"></a> +<span class="sourceLineNo">221</span> * with the specified configuration.All constraints are considered<a name="line.221"></a> +<span class="sourceLineNo">222</span> * automatically enabled on add<a name="line.222"></a> +<span class="sourceLineNo">223</span> * @throws IOException<a name="line.223"></a> +<span class="sourceLineNo">224</span> * if any constraint could not be deserialized. Assumes if 1<a name="line.224"></a> +<span class="sourceLineNo">225</span> * constraint is not loaded properly, something has gone terribly<a name="line.225"></a> +<span class="sourceLineNo">226</span> * wrong and that all constraints need to be enforced.<a name="line.226"></a> +<span class="sourceLineNo">227</span> */<a name="line.227"></a> +<span class="sourceLineNo">228</span> public static void add(HTableDescriptor desc,<a name="line.228"></a> +<span class="sourceLineNo">229</span> Pair<Class<? extends Constraint>, Configuration>... constraints)<a name="line.229"></a> +<span class="sourceLineNo">230</span> throws IOException {<a name="line.230"></a> +<span class="sourceLineNo">231</span> enable(desc);<a name="line.231"></a> +<span class="sourceLineNo">232</span> long priority = getNextPriority(desc);<a name="line.232"></a> +<span class="sourceLineNo">233</span> for (Pair<Class<? extends Constraint>, Configuration> pair : constraints) {<a name="line.233"></a> +<span class="sourceLineNo">234</span> addConstraint(desc, pair.getFirst(), pair.getSecond(), priority++);<a name="line.234"></a> +<span class="sourceLineNo">235</span> }<a name="line.235"></a> +<span class="sourceLineNo">236</span> updateLatestPriority(desc, priority);<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> * Add a {@link Constraint} to the table with the given configuration<a name="line.240"></a> +<span class="sourceLineNo">241</span> * <p><a name="line.241"></a> +<span class="sourceLineNo">242</span> * Each constraint, when added to the table, will have a specific priority,<a name="line.242"></a> +<span class="sourceLineNo">243</span> * dictating the order in which the {@link Constraint} will be run. A<a name="line.243"></a> +<span class="sourceLineNo">244</span> * {@link Constraint} added will run on the regionserver before those added to<a name="line.244"></a> +<span class="sourceLineNo">245</span> * the {@link HTableDescriptor} later.<a name="line.245"></a> +<span class="sourceLineNo">246</span> * <a name="line.246"></a> +<span class="sourceLineNo">247</span> * @param desc<a name="line.247"></a> +<span class="sourceLineNo">248</span> * table descriptor to the constraint to<a name="line.248"></a> +<span class="sourceLineNo">249</span> * @param constraint<a name="line.249"></a> +<span class="sourceLineNo">250</span> * to be added<a name="line.250"></a> +<span class="sourceLineNo">251</span> * @param conf<a name="line.251"></a> +<span class="sourceLineNo">252</span> * configuration associated with the constraint<a name="line.252"></a> +<span class="sourceLineNo">253</span> * @throws IOException<a name="line.253"></a> +<span class="sourceLineNo">254</span> * if any constraint could not be deserialized. Assumes if 1<a name="line.254"></a> +<span class="sourceLineNo">255</span> * constraint is not loaded properly, something has gone terribly<a name="line.255"></a> +<span class="sourceLineNo">256</span> * wrong and that all constraints need to be enforced.<a name="line.256"></a> +<span class="sourceLineNo">257</span> */<a name="line.257"></a> +<span class="sourceLineNo">258</span> public static void add(HTableDescriptor desc,<a name="line.258"></a> +<span class="sourceLineNo">259</span> Class<? extends Constraint> constraint, Configuration conf)<a name="line.259"></a> +<span class="sourceLineNo">260</span> throws IOException {<a name="line.260"></a> +<span class="sourceLineNo">261</span> enable(desc);<a name="line.261"></a> +<span class="sourceLineNo">262</span> long priority = getNextPriority(desc);<a name="line.262"></a> +<span class="sourceLineNo">263</span> addConstraint(desc, constraint, conf, priority++);<a name="line.263"></a> +<span class="sourceLineNo">264</span><a name="line.264"></a> +<span class="sourceLineNo">265</span> updateLatestPriority(desc, priority);<a name="line.265"></a> +<span class="sourceLineNo">266</span> }<a name="line.266"></a> +<span class="sourceLineNo">267</span><a name="line.267"></a> +<span class="sourceLineNo">268</span> /**<a name="line.268"></a> +<span class="sourceLineNo">269</span> * Write the raw constraint and configuration to the descriptor.<a name="line.269"></a> +<span class="sourceLineNo">270</span> * <p><a name="line.270"></a> +<span class="sourceLineNo">271</span> * This method takes care of creating a new configuration based on the passed<a name="line.271"></a> +<span class="sourceLineNo">272</span> * in configuration and then updating that with enabled and priority of the<a name="line.272"></a> +<span class="sourceLineNo">273</span> * constraint.<a name="line.273"></a> +<span class="sourceLineNo">274</span> * <p><a name="line.274"></a> +<span class="sourceLineNo">275</span> * When a constraint is added, it is automatically enabled.<a name="line.275"></a> +<span class="sourceLineNo">276</span> */<a name="line.276"></a> +<span class="sourceLineNo">277</span> private static void addConstraint(HTableDescriptor desc,<a name="line.277"></a> +<span class="sourceLineNo">278</span> Class<? extends Constraint> clazz, Configuration conf, long priority)<a name="line.278"></a> +<span class="sourceLineNo">279</span> throws IOException {<a name="line.279"></a> +<span class="sourceLineNo">280</span> writeConstraint(desc, serializeConstraintClass(clazz),<a name="line.280"></a> +<span class="sourceLineNo">281</span> configure(conf, true, priority));<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> * Setup the configuration for a constraint as to whether it is enabled and<a name="line.285"></a> +<span class="sourceLineNo">286</span> * its priority<a name="line.286"></a> +<span class="sourceLineNo">287</span> * <a name="line.287"></a> +<span class="sourceLineNo">288</span> * @param conf<a name="line.288"></a> +<span class="sourceLineNo">289</span> * on which to base the new configuration<a name="line.289"></a> +<span class="sourceLineNo">290</span> * @param enabled<a name="line.290"></a> +<span class="sourceLineNo">291</span> * <tt>true</tt> if it should be run<a name="line.291"></a> +<span class="sourceLineNo">292</span> * @param priority<a name="line.292"></a> +<span class="sourceLineNo">293</span> * relative to other constraints<a name="line.293"></a> +<span class="sourceLineNo">294</span> * @return a new configuration, storable in the {@link HTableDescriptor}<a name="line.294"></a> +<span class="sourceLineNo">295</span> */<a name="line.295"></a> +<span class="sourceLineNo">296</span> private static Configuration configure(Configuration conf, boolean enabled,<a name="line.296"></a> +<span class="sourceLineNo">297</span> long priority) {<a name="line.297"></a> +<span class="sourceLineNo">298</span> // create the configuration to actually be stored<a name="line.298"></a> +<span class="sourceLineNo">299</span> // clone if possible, but otherwise just create an empty configuration<a name="line.299"></a> +<span class="sourceLineNo">300</span> Configuration toWrite = conf == null ? new Configuration()<a name="line.300"></a> +<span class="sourceLineNo">301</span> : new Configuration(conf);<a name="line.301"></a> +<span class="sourceLineNo">302</span><a name="line.302"></a> +<span class="sourceLineNo">303</span> // update internal properties<a name="line.303"></a> +<span class="sourceLineNo">304</span> toWrite.setBooleanIfUnset(ENABLED_KEY, enabled);<a name="line.304"></a> +<span class="sourceLineNo">305</span><a name="line.305"></a> +<span class="sourceLineNo">306</span> // set if unset long<a name="line.306"></a> +<span class="sourceLineNo">307</span> if (toWrite.getLong(PRIORITY_KEY, UNSET_PRIORITY) == UNSET_PRIORITY) {<a name="line.307"></a> +<span class="sourceLineNo">308</span> toWrite.setLong(PRIORITY_KEY, priority);<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> return toWrite;<a name="line.311"></a> +<span class="sourceLineNo">312</span> }<a name="line.312"></a> +<span class="sourceLineNo">313</span><a name="line.313"></a> +<span class="sourceLineNo">314</span> /**<a name="line.314"></a> +<span class="sourceLineNo">315</span> * Just write the class to a String representation of the class as a key for<a name="line.315"></a> +<span class="sourceLineNo">316</span> * the {@link HTableDescriptor}<a name="line.316"></a> +<span class="sourceLineNo">317</span> * <a name="line.317"></a> +<span class="sourceLineNo">318</span> * @param clazz<a name="line.318"></a> +<span class="sourceLineNo">319</span> * Constraint class to convert to a {@link HTableDescriptor} key<a name="line.319"></a> +<span class="sourceLineNo">320</span> * @return key to store in the {@link HTableDescriptor}<a name="line.320"></a> +<span class="sourceLineNo">321</span> */<a name="line.321"></a> +<span class="sourceLineNo">322</span> private static String serializeConstraintClass(<a name="line.322"></a> +<span class="sourceLineNo">323</span> Class<? extends Constraint> clazz) {<a name="line.323"></a> +<span class="sourceLineNo">324</span> String constraintClazz = clazz.getName();<a name="line.324"></a> +<span class="sourceLineNo">325</span> return CONSTRAINT_HTD_KEY_PREFIX + constraintClazz;<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> /**<a name="line.328"></a> +<span class="sourceLineNo">329</span> * Write the given key and associated configuration to the<a name="line.329"></a> +<span class="sourceLineNo">330</span> * {@link HTableDescriptor}<a name="line.330"></a> +<span class="sourceLineNo">331</span> */<a name="line.331"></a> +<span class="sourceLineNo">332</span> private static void writeConstraint(HTableDescriptor desc, String key,<a name="line.332"></a> +<span class="sourceLineNo">333</span> Configuration conf) throws IOException {<a name="line.333"></a> +<span class="sourceLineNo">334</span> // store the key and conf in the descriptor<a name="line.334"></a> +<span class="sourceLineNo">335</span> desc.setValue(key, serializeConfiguration(conf));<a name="line.335"></a> +<span class="sourceLineNo">336</span> }<a name="line.336"></a> +<span class="sourceLineNo">337</span><a name="line.337"></a> +<span class="sourceLineNo">338</span> /**<a name="line.338"></a> +<span class="sourceLineNo">339</span> * Write the configuration to a String<a name="line.339"></a> +<span class="sourceLineNo">340</span> * <a name="line.340"></a> +<span class="sourceLineNo">341</span> * @param conf<a name="line.341"></a> +<span class="sourceLineNo">342</span> * to write<a name="line.342"></a> +<span class="sourceLineNo">343</span> * @return String representation of that configuration<a name="line.343"></a> +<span class="sourceLineNo">344</span> * @throws IOException<a name="line.344"></a> +<span class="sourceLineNo">345</span> */<a name="line.345"></a> +<span class="sourceLineNo">346</span> private static String serializeConfiguration(Configuration conf)<a name="line.346"></a> +<span class="sourceLineNo">347</span> throws IOException {<a name="line.347"></a> +<span class="sourceLineNo">348</span> // write the configuration out to the data stream<a name="line.348"></a> +<span class="sourceLineNo">349</span> ByteArrayOutputStream bos = new ByteArrayOutputStream();<a name="line.349"></a> +<span class="sourceLineNo">350</span> DataOutputStream dos = new DataOutputStream(bos);<a name="line.350"></a> +<span class="sourceLineNo">351</span> conf.writeXml(dos);<a name="line.351"></a> +<span class="sourceLineNo">352</span> dos.flush();<a name="line.352"></a> +<span class="sourceLineNo">353</span> byte[] data = bos.toByteArray();<a name="line.353"></a> +<span class="sourceLineNo">354</span> return Bytes.toString(data);<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> * Read the {@link Configuration} stored in the byte stream.<a name="line.358"></a> +<span class="sourceLineNo">359</span> * <a name="line.359"></a> +<span class="sourceLineNo">360</span> * @param bytes<a name="line.360"></a> +<span class="sourceLineNo">361</span> * to read from<a name="line.361"></a> +<span class="sourceLineNo">362</span> * @return A valid configuration<a name="line.362"></a> +<span class="sourceLineNo">363</span> */<a name="line.363"></a> +<span class="sourceLineNo">364</span> private static Configuration readConfiguration(byte[] bytes)<a name="line.364"></a> +<span class="sourceLineNo">365</span> throws IOException {<a name="line.365"></a> +<span class="sourceLineNo">366</span> ByteArrayInputStream is = new ByteArrayInputStream(bytes);<a name="line.366"></a> +<span class="sourceLineNo">367</span> Configuration conf = new Configuration(false);<a name="line.367"></a> +<span class="sourceLineNo">368</span> conf.addResource(is);<a name="line.368"></a> +<span class="sourceLineNo">369</span> return conf;<a name="line.369"></a> +<span class="sourceLineNo">370</span> }<a name="line.370"></a> +<span class="sourceLineNo">371</span><a name="line.371"></a> +<span class="sourceLineNo">372</span> /**<a name="line.372"></a> +<span class="sourceLineNo">373</span> * Read in the configuration from the String encoded configuration<a name="line.373"></a> +<span class="sourceLineNo">374</span> * <a name="line.374"></a> +<span class="sourceLineNo">375</span> * @param bytes<a name="line.375"></a> +<span class="sourceLineNo">376</span> * to read from<a name="line.376"></a> +<span class="sourceLineNo">377</span> * @return A valid configuration<a name="line.377"></a> +<span class="sourceLineNo">378</span> * @throws IOException<a name="line.378"></a> +<span class="sourceLineNo">379</span> * if the configuration could not be read<a name="line.379"></a> +<span class="sourceLineNo">380</span> */<a name="line.380"></a> +<span class="sourceLineNo">381</span> private static Configuration readConfiguration(String bytes)<a name="line.381"></a> +<span class="sourceLineNo">382</span> throws IOException {<a name="line.382"></a> +<span class="sourceLineNo">383</span> return readConfiguration(Bytes.toBytes(bytes));<a name="line.383"></a> +<span class="sourceLineNo">384</span> }<a name="line.384"></a> +<span class="sourceLineNo">385</span><a name="line.385"></a> +<span class="sourceLineNo">386</span> private static long getNextPriority(HTableDescriptor desc) {<a name="line.386"></a> +<span class="sourceLineNo">387</span> String value = desc.getValue(COUNTER_KEY);<a name="line.387"></a> +<span class="sourceLineNo">388</span><a name="line.388"></a> +<span class="sourceLineNo">389</span> long priority;<a name="line.389"></a> +<span class="sourceLineNo">390</span> // get the current priority<a name="line.390"></a> +<span class="sourceLineNo">391</span> if (value == null) {<a name="line.391"></a> +<span class="sourceLineNo">392</span> priority = MIN_PRIORITY;<a name="line.392"></a> +<span class="sourceLineNo">393</span> } else {<a name="line.393"></a> +<span class="sourceLineNo">394</span> priority = Long.parseLong(value) + 1;<a name="line.394"></a> +<span class="sourceLineNo">395</span> }<a name="line.395"></a> +<span class="sourceLineNo">396</span><a name="line.396"></a> +<span class="sourceLineNo">397</span> return priority;<a name="line.397"></a> +<span class="sourceLineNo">398</span> }<a name="line.398"></a> +<span class="sourceLineNo">399</span><a name="line.399"></a> +<span class="sourceLineNo">400</span> private static void updateLatestPriority(HTableDescriptor desc, long priority) {<a name="line.400"></a> +<span class="sourceLineNo">401</span> // update the max priority<a name="line.401"></a> +<span class="sourceLineNo">402</span> desc.setValue(COUNTER_KEY, Long.toString(priority));<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">405</span> /**<a name="line.405"></a> +<span class="sourceLineNo">406</span> * Update the configuration for the {@link Constraint}; does not change the<a name="line.406"></a> +<span class="sourceLineNo">407</span> * order in which the constraint is run.<a name="line.407"></a> +<span class="sourceLineNo">408</span> * <a name="line.408"></a> +<span class="sourceLineNo">409</span> * @param desc<a name="line.409"></a> +<span class="sourceLineNo">410</span> * {@link HTableDescriptor} to update<a name="line.410"></a> +<span class="sourceLineNo">411</span> * @param clazz<a name="line.411"></a> +<span class="sourceLineNo">412</span> * {@link Constraint} to update<a name="line.412"></a> +<span class="sourceLineNo">413</span> * @param configuration<a name="line.413"></a> +<span class="sourceLineNo">414</span> * to update the {@link Constraint} with.<a name="line.414"></a> +<span class="sourceLineNo">415</span> * @throws IOException<a name="line.415"></a> +<span class="sourceLineNo">416</span> * if the Constraint was not stored correctly<a name="line.416"></a> +<span class="sourceLineNo">417</span> * @throws IllegalArgumentException<a name="line.417"></a> +<span class="sourceLineNo">418</span> * if the Constraint was not present on this table.<a name="line.418"></a> +<span class="sourceLineNo">419</span> */<a name="line.419"></a> +<span class="sourceLineNo">420</span> public static void setConfiguration(HTableDescriptor desc,<a name="line.420"></a> +<span class="sourceLineNo">421</span> Class<? extends Constraint> clazz, Configuration configuration)<a name="line.421"></a> +<span class="sourceLineNo">422</span> throws IOException, IllegalArgumentException {<a name="line.422"></a> +<span class="sourceLineNo">423</span> // get the entry for this class<a name="line.423"></a> +<span class="sourceLineNo">424</span> Pair<String, String> e = getKeyValueForClass(desc, clazz);<a name="line.424"></a> +<span class="sourceLineNo">425</span><a name="line.425"></a> +<span class="sourceLineNo">426</span> if (e == null) {<a name="line.426"></a> +<span class="sourceLineNo">427</span> throw new IllegalArgumentException("Constraint: " + clazz.getName()<a name="line.427"></a> +<span class="sourceLineNo">428</span> + " is not associated with this table.");<a name="line.428"></a> +<span class="sourceLineNo">429</span> }<a name="line.429"></a> +<span class="sourceLineNo">430</span><a name="line.430"></a> +<span class="sourceLineNo">431</span> // clone over the configuration elements<a name="line.431"></a> +<span class="sourceLineNo">432</span> Configuration conf = new Configuration(configuration);<a name="line.432"></a> +<span class="sourceLineNo">433</span><a name="line.433"></a> +<span class="sourceLineNo">434</span> // read in the previous info about the constraint<a name="line.434"></a> +<span class="sourceLineNo">435</span> Configuration internal = readConfiguration(e.getSecond());<a name="line.435"></a> +<span class="sourceLineNo">436</span><a name="line.436"></a> +<span class="sourceLineNo">437</span> // update the fields based on the previous settings<a name="line.437"></a> +<span class="sourceLineNo">438</span> conf.setIfUnset(ENABLED_KEY, internal.get(ENABLED_KEY));<a name="line.438"></a> +<span class="sourceLineNo">439</span> conf.setIfUnset(PRIORITY_KEY, internal.get(PRIORITY_KEY));<a name="line.439"></a> +<span class="sourceLineNo">440</span><a name="line.440"></a> +<span class="sourceLineNo">441</span> // update the current value<a name="line.441"></a> +<span class="sourceLineNo">442</span> writeConstraint(desc, e.getFirst(), conf);<a name="line.442"></a> +<span class="sourceLineNo">443</span> }<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> * Remove the constraint (and associated information) for the table<a name="line.446"></a> +<span class="sourceLineNo">447</span> * descriptor.<a name="line.447"></a> +<span class="sourceLineNo">448</span> * <a name="line.448"></a> +<span class="sourceLineNo">449</span> * @param desc<a name="line.449"></a> +<span class="sourceLineNo">450</span> * {@link HTableDescriptor} to modify<a name="line.450"></a> +<span class="sourceLineNo">451</span> * @param clazz<a name="line.451"></a> +<span class="sourceLineNo">452</span> * {@link Constraint} class to remove<a name="line.452"></a> +<span class="sourceLineNo">453</span> */<a name="line.453"></a> +<span class="sourceLineNo">454</span> public static void remove(HTableDescriptor desc,<a name="line.454"></a> +<span class="sourceLineNo">455</span> Class<? extends Constraint> clazz) {<a name="line.455"></a> +<span class="sourceLineNo">456</span> String key = serializeConstraintClass(clazz);<a name="line.456"></a> +<span class="sourceLineNo">457</span> desc.remove(key);<a name="line.457"></a> +<span class="sourceLineNo">458</span> }<a name="line.458"></a> +<span class="sourceLineNo">459</span><a name="line.459"></a> +<span class="sourceLineNo">460</span> /**<a name="line.460"></a> +<span class="sourceLineNo">461</span> * Enable the given {@link Constraint}. Retains all the information (e.g.<a name="line.461"></a> +<span class="sourceLineNo">462</span> * Configuration) for the {@link Constraint}, but makes sure that it gets<a name="line.462"></a> +<span class="sourceLineNo">463</span> * loaded on the table.<a name="line.463"></a> +<span class="sourceLineNo">464</span> * <a name="line.464"></a> +<span class="sourceLineNo">465</span> * @param desc<a name="line.465"></a> +<span class="sourceLineNo">466</span> * {@link HTableDescriptor} to modify<a name="line.466"></a> +<span class="sourceLineNo">467</span> * @param clazz<a name="line.467"></a> +<span class="sourceLineNo">468</span> * {@link Constraint} to enable<a name="line.468"></a> +<span class="sourceLineNo">469</span> * @throws IOException<a name="line.469"></a> +<span class="sourceLineNo">470</span> * If the constraint cannot be properly deserialized<a name="line.470"></a> +<span class="sourceLineNo">471</span> */<a name="line.471"></a> +<span class="sourceLineNo">472</span> public static void enableConstraint(HTableDescriptor desc,<a name="line.472"></a> +<span class="sourceLineNo">473</span> Class<? extends Constraint> clazz) throws IOException {<a name="line.473"></a> +<span class="sourceLineNo">474</span> changeConstraintEnabled(desc, clazz, true);<a name="line.474"></a> +<span class="sourceLineNo">475</span> }<a name="line.475"></a> +<span class="sourceLineNo">476</span><a name="line.476"></a> +<span class="sourceLineNo">477</span> /**<a name="line.477"></a> +<span class="sourceLineNo">478</span> * Disable the given {@link Constraint}. Retains all the information (e.g.<a name="line.478"></a> +<span class="sourceLineNo">479</span> * Configuration) for the {@link Constraint}, but it just doesn't load the<a name="line.479"></a> +<span class="sourceLineNo">480</span> * {@link Constraint} on the table.<a name="line.480"></a> +<span class="sourceLineNo">481</span> * <a name="line.481"></a> +<span class="sourceLineNo">482</span> * @param desc<a name="line.482"></a> +<span class="sourceLineNo">483</span> * {@link HTableDescriptor} to modify<a name="line.483"></a> +<span class="sourceLineNo">484</span> * @param clazz<a name="line.484"></a> +<span class="sourceLineNo">485</span> * {@link Constraint} to disable.<a name="line.485"></a> +<span class="sourceLineNo">486</span> * @throws IOException<a name="line.486"></a> +<span class="sourceLineNo">487</span> * if the constraint cannot be found<a name="line.487"></a> +<span class="sourceLineNo">488</span> */<a name="line.488"></a> +<span class="sourceLineNo">489</span> public static void disableConstraint(HTableDescriptor desc,<a name="line.489"></a> +<span class="sourceLineNo">490</span> Class<? extends Constraint> clazz) throws IOException {<a name="line.490"></a> +<span class="sourceLineNo">491</span> changeConstraintEnabled(desc, clazz, false);<a name="line.491"></a> +<span class="sourceLineNo">492</span> }<a name="line.492"></a> +<span class="sourceLineNo">493</span><a name="line.493"></a> +<span class="sourceLineNo">494</span> /**<a name="line.494"></a> +<span class="sourceLineNo">495</span> * Change the whether the constraint (if it is already present) is enabled or<a name="line.495"></a> +<span class="sourceLineNo">496</span> * disabled.<a name="line.496"></a> +<span class="sourceLineNo">497</span> */<a name="line.497"></a> +<span class="sourceLineNo">498</span> private static void changeConstraintEnabled(HTableDescriptor desc,<a name="line.498"></a> +<span class="sourceLineNo">499</span> Class<? extends Constraint> clazz, boolean enabled) throws IOException {<a name="line.499"></a> +<span class="sourceLineNo">500</span> // get the original constraint<a name="line.500"></a> +<span class="sourceLineNo">501</span> Pair<String, String> entry = getKeyValueForClass(desc, clazz);<a name="line.501"></a> +<span class="sourceLineNo">502</span> if (entry == null) {<a name="line.502"></a> +<span class="sourceLineNo">503</span> throw new IllegalArgumentException("Constraint: " + clazz.getName()<a name="line.503"></a> +<span class="sourceLineNo">504</span> + " is not associated with this table. You can't enable it!");<a name="line.504"></a> +<span class="sourceLineNo">505</span> }<a name="line.505"></a> +<span class="sourceLineNo">506</span><a name="line.506"></a> +<span class="sourceLineNo">507</span> // create a new configuration from that conf<a name="line.507"></a> +<span class="sourceLineNo">508</span> Configuration conf = readConfiguration(entry.getSecond());<a name="line.508"></a> +<span class="sourceLineNo">509</span><a name="line.509"></a> +<span class="sourceLineNo">510</span> // set that it is enabled<a name="line.510"></a> +<span class="sourceLineNo">511</span> conf.setBoolean(ENABLED_KEY, enabled);<a name="line.511"></a> +<span class="sourceLineNo">512</span><a name="line.512"></a> +<span class="sourceLineNo">513</span> // write it back out<a name="line.513"></a> +<span class="sourceLineNo">514</span> writeConstraint(desc, entry.getFirst(), conf);<a name="line.514"></a> +<span class="sourceLineNo">515</span> }<a name="line.515"></a> +<span class="sourceLineNo">516</span><a name="line.516"></a> +<span class="sourceLineNo">517</span> /**<a name="line.517"></a> +<span class="sourceLineNo">518</span> * Check to see if the given constraint is enabled.<a name="line.518"></a> +<span class="sourceLineNo">519</span> * <a name="line.519"></a> +<span class="sourceLineNo">520</span> * @param desc<a name="line.520"></a> +<span class="sourceLineNo">521</span> * {@link HTableDescriptor} to check.<a name="line.521"></a> +<span class="sourceLineNo">522</span> * @param clazz<a name="line.522"></a> +<span class="sourceLineNo">523</span> * {@link Constraint} to check for<a name="line.523"></a> +<span class="sourceLineNo">524</span> * @return <tt>true</tt> if the {@link Constraint} is present and enabled.<a name="line.524"></a> +<span class="sourceLineNo">525</span> * <tt>false</tt> otherwise.<a name="line.525"></a> +<span class="sourceLineNo">526</span> * @throws IOException<a name="line.526"></a> +<span class="sourceLineNo">527</span> * If the constraint has improperly stored in the table<a name="line.527"></a> +<span class="sourceLineNo">528</span> */<a name="line.528"></a> +<span class="sourceLineNo">529</span> public static boolean enabled(HTableDescriptor desc,<a name="line.529"></a> +<span class="sourceLineNo">530</span> Class<? extends Constraint> clazz) throws IOException {<a name="line.530"></a> +<span class="sourceLineNo">531</span> // get the kv<a name="line.531"></a> +<span class="sourceLineNo">532</span> Pair<String, String> entry = getKeyValueForClass(desc, clazz);<a name="line.532"></a> +<span class="sourceLineNo">533</span> // its not enabled so just return false. In fact, its not even present!<a name="line.533"></a> +<span class="sourceLineNo">534</span> if (entry == null) {<a name="line.534"></a> +<span class="sourceLineNo">535</span> return false;<a name="line.535"></a> +<span class="sourceLineNo">536</span> }<a name="line.536"></a> +<span class="sourceLineNo">537</span><a name="line.537"></a> +<span class="sourceLineNo">538</span> // get the info about the constraint<a name="line.538"></a> +<span class="sourceLineNo">539</span> Configuration conf = readConfiguration(entry.getSecond());<a name="line.539"></a> +<span class="sourceLineNo">540</span><a name="line.540"></a> +<span class="sourceLineNo">541</span> return conf.getBoolean(ENABLED_KEY, false);<a name="line.541"></a> +<span class="sourceLineNo">542</span> }<a name="line.542"></a> +<span class="sourceLineNo">543</span><a name="line.543"></a> +<span class="sourceLineNo">544</span> /**<a name="line.544"></a> +<span class="sourceLineNo">545</span> * Get the constraints stored in the table descriptor<a name="line.545"></a> +<span class="sourceLineNo">546</span> * <a name="line.546"></a> +<span class="sourceLineNo">547</span> * @param desc<a name="line.547"></a> +<span class="sourceLineNo">548</span> * To read from<a name="line.548"></a> +<span class="sourceLineNo">549</span> * @param classloader<a name="line.549"></a> +<span class="sourceLineNo">550</span> * To use when loading classes. If a special classloader is used on a<a name="line.550"></a> +<span class="sourceLineNo">551</span> * region, for instance, then that should be the classloader used to<a name="line.551"></a> +<span class="sourceLineNo">552</span> * load the constraints. This could also apply to unit-testing<a name="line.552"></a> +<span class="sourceLineNo">553</span> * situation, where want to ensure that class is reloaded or not.<a name="line.553"></a> +<span class="sourceLineNo">554</span> * @return List of configured {@link Constraint Constraints}<a name="line.554"></a> +<span class="sourceLineNo">555</span> * @throws IOException<a name="line.555"></a> +<span class="sourceLineNo">556</span> * if any part of reading/arguments fails<a name="line.556"></a> +<span class="sourceLineNo">557</span> */<a name="line.557"></a> +<span class="sourceLineNo">558</span> static List<? extends Constraint> getConstraints(HTableDescriptor desc,<a name="line.558"></a> +<span class="sourceLineNo">559</span> ClassLoader classloader) throws IOException {<a name="line.559"></a> +<span class="sourceLineNo">560</span> List<Constraint> constraints = new ArrayList<Constraint>();<a name="line.560"></a> +<span class="sourceLineNo">561</span> // loop through all the key, values looking for constraints<a name="line.561"></a> +<span class="sourceLineNo">562</span> for (Map.Entry<Bytes, Bytes> e : desc<a name="line.562"></a> +<span class="sourceLineNo">563</span> .getValues().entrySet()) {<a name="line.563"></a> +<span class="sourceLineNo">564</span> // read out the constraint<a name="line.564"></a> +<span class="sourceLineNo">565</span> String key = Bytes.toString(e.getKey().get()).trim();<a name="line.565"></a> +<span class="sourceLineNo">566</span> String[] className = CONSTRAINT_HTD_ATTR_KEY_PATTERN.split(key);<a name="line.566"></a> +<span class="sourceLineNo">567</span> if (className.length == 2) {<a name="line.567"></a> +<span class="sourceLineNo">568</span> key = className[1];<a name="line.568"></a> +<span class="sourceLineNo">569</span> if (LOG.isDebugEnabled()) {<a name="line.569"></a> +<span class="sourceLineNo">570</span> LOG.debug("Loading constraint:" + key);<a name="line.570"></a> +<span class="sourceLineNo">571</span> }<a name="line.571"></a> +<span class="sourceLineNo">572</span><a name="line.572"></a> +<span class="sourceLineNo">573</span> // read in the rest of the constraint<a name="line.573"></a> +<span class="sourceLineNo">574</span> Configuration conf;<a name="line.574"></a> +<span class="sourceLineNo">575</span> try {<a name="line.575"></a> +<span class="sourceLineNo">576</span> conf = readConfiguration(e.getValue().get());<a name="line.576"></a> +<span class="sourceLineNo">577</span> } catch (IOException e1) {<a name="line.577"></a> +<span class="sourceLineNo">578</span> // long that we don't have a valid configuration stored, and move on.<a name="line.578"></a> +<span class="sourceLineNo">579</span> LOG.warn("Corrupted configuration found for key:" + key<a name="line.579"></a> +<span class="sourceLineNo">580</span> + ", skipping it.");<a name="line.580"></a> +<span class="sourceLineNo">581</span> continue;<a name="line.581"></a> +<span class="sourceLineNo">582</span> }<a name="line.582"></a> +<span class="sourceLineNo">583</span> // if it is not enabled, skip it<a name="line.583"></a> +<span class="sourceLineNo">584</span> if (!conf.getBoolean(ENABLED_KEY, false)) {<a name="line.584"></a> +<span class="sourceLineNo">585</span> if (LOG.isDebugEnabled())<a name="line.585"></a> +<span class="sourceLineNo">586</span> LOG.debug("Constraint: " + key + " is DISABLED - skipping it");<a name="line.586"></a> +<span class="sourceLineNo">587</span> // go to the next constraint<a name="line.587"></a> +<span class="sourceLineNo">588</span> continue;<a name="line.588"></a> +<span class="sourceLineNo">589</span> }<a name="line.589"></a> +<span class="sourceLineNo">590</span><a name="line.590"></a> +<span class="sourceLineNo">591</span> try {<a name="line.591"></a> +<span class="sourceLineNo">592</span> // add the constraint, now that we expect it to be valid.<a name="line.592"></a> +<span class="sourceLineNo">593</span> Class<? extends Constraint> clazz = classloader.loadClass(key)<a name="line.593"></a> +<span class="sourceLineNo">594</span> .asSubclass(Constraint.class);<a name="line.594"></a> +<span class="sourceLineNo">595</span> Constraint constraint = clazz.newInstance();<a name="line.595"></a> +<span class="sourceLineNo">596</span> constraint.setConf(conf);<a name="line.596"></a> +<span class="sourceLineNo">597</span> constraints.add(constraint);<a name="line.597"></a> +<span class="sourceLineNo">598</span> } catch (ClassNotFoundException e1) {<a name="line.598"></a> +<span class="sourceLineNo">599</span> throw new IOException(e1);<a name="line.599"></a> +<span class="sourceLineNo">600</span> } catch (InstantiationException e1) {<a name="line.600"></a> <span class="sourceLineNo">601</span> throw new IOException(e1);<a name="line.601"></a> -<span class="sourceLineNo">602</span> } catch (InstantiationException e1) {<a name="line.602"></a> +<span class="sourceLineNo">602</span> } catch (IllegalAccessException e1) {<a name="line.602"></a> <span class="sourceLineNo">603</span> throw new IOException(e1);<a name="line.603"></a> -<span class="sourceLineNo">604</span> } catch (IllegalAccessException e1) {<a name="line.604"></a> -<span class="sourceLineNo">605</span> throw new IOException(e1);<a name="line.605"></a> -<span class="sourceLineNo">606</span> }<a name="line.606"></a> -<span class="sourceLineNo">607</span> }<a name="line.607"></a> -<span class="sourceLineNo">608</span> }<a name="line.608"></a> -<span class="sourceLineNo">609</span> // sort them, based on the priorities<a name="line.609"></a> -<span class="sourceLineNo">610</span> Collections.sort(constraints, constraintComparator);<a name="line.610"></a> -<span class="sourceLineNo">611</span> return constraints;<a name="line.611"></a> -<span class="sourceLineNo">612</span> }<a name="line.612"></a> -<span class="sourceLineNo">613</span><a name="line.613"></a> -<span class="sourceLineNo">614</span> private static final Comparator<Constraint> constraintComparator = new Comparator<Constraint>() {<a name="line.614"></a> -<span class="sourceLineNo">615</span> @Override<a name="line.615"></a> -<span class="sourceLineNo">616</span> public int compare(Constraint c1, Constraint c2) {<a name="line.616"></a> -<span class="sourceLineNo">617</span> // compare the priorities of the constraints stored in their configuration<a name="line.617"></a> -<span class="sourceLineNo">618</span> return Long.valueOf(c1.getConf().getLong(PRIORITY_KEY, DEFAULT_PRIORITY))<a name="line.618"></a> -<span class="sourceLineNo">619</span> .compareTo(c2.getConf().getLong(PRIORITY_KEY, DEFAULT_PRIORITY));<a name="line.619"></a> -<span class="sourceLineNo">620</span> }<a name="line.620"></a> -<span class="sourceLineNo">6
<TRUNCATED>
