| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>package org.apache.hadoop.hbase;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Collections;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.Comparator;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.HashSet;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.Map;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.Set;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.TreeMap;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.TreeSet;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span><a name="line.31"></a> |
| <span class="sourceLineNo">032</span>/**<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * Namespace POJO class. Used to represent and define namespaces.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> *<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * Descriptors will be persisted in an hbase table.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * This works since namespaces are essentially metadata of a group of tables<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * as opposed to a more tangible container.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> */<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>@InterfaceAudience.Public<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>public class NamespaceDescriptor {<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> /** System namespace name. */<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> public static final byte [] SYSTEM_NAMESPACE_NAME = Bytes.toBytes("hbase");<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> public static final String SYSTEM_NAMESPACE_NAME_STR =<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> Bytes.toString(SYSTEM_NAMESPACE_NAME);<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> /** Default namespace name. */<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> public static final byte [] DEFAULT_NAMESPACE_NAME = Bytes.toBytes("default");<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> public static final String DEFAULT_NAMESPACE_NAME_STR =<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> Bytes.toString(DEFAULT_NAMESPACE_NAME);<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> public static final NamespaceDescriptor DEFAULT_NAMESPACE = NamespaceDescriptor.create(<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> DEFAULT_NAMESPACE_NAME_STR).build();<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> public static final NamespaceDescriptor SYSTEM_NAMESPACE = NamespaceDescriptor.create(<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> SYSTEM_NAMESPACE_NAME_STR).build();<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> public final static Set<String> RESERVED_NAMESPACES;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> static {<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> Set<String> set = new HashSet<>();<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> set.add(NamespaceDescriptor.DEFAULT_NAMESPACE_NAME_STR);<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> set.add(NamespaceDescriptor.SYSTEM_NAMESPACE_NAME_STR);<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> RESERVED_NAMESPACES = Collections.unmodifiableSet(set);<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> }<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> public final static Set<byte[]> RESERVED_NAMESPACES_BYTES;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> static {<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> Set<byte[]> set = new TreeSet<>(Bytes.BYTES_RAWCOMPARATOR);<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> for(String name: RESERVED_NAMESPACES) {<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> set.add(Bytes.toBytes(name));<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> }<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> RESERVED_NAMESPACES_BYTES = Collections.unmodifiableSet(set);<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> }<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> private String name;<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> private Map<String, String> configuration;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> public static final Comparator<NamespaceDescriptor> NAMESPACE_DESCRIPTOR_COMPARATOR =<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> new Comparator<NamespaceDescriptor>() {<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> @Override<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> public int compare(NamespaceDescriptor namespaceDescriptor,<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> NamespaceDescriptor namespaceDescriptor2) {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> return namespaceDescriptor.getName().compareTo(namespaceDescriptor2.getName());<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> }<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> };<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> private NamespaceDescriptor() {<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> }<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> private NamespaceDescriptor(String name) {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> this.name = name;<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> }<a name="line.89"></a> |
| <span class="sourceLineNo">090</span><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> public String getName() {<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> return name;<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> }<a name="line.93"></a> |
| <span class="sourceLineNo">094</span><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> /**<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * Getter for accessing the configuration value by key<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> */<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> public String getConfigurationValue(String key) {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> return configuration.get(key);<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> }<a name="line.100"></a> |
| <span class="sourceLineNo">101</span><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> /**<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * Getter for fetching an unmodifiable {@link #configuration} map.<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> */<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> public Map<String, String> getConfiguration() {<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> // shallow pointer copy<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> return Collections.unmodifiableMap(configuration);<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> /**<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * Setter for storing a configuration setting in {@link #configuration} map.<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @param key Config key. Same as XML config key e.g. hbase.something.or.other.<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * @param value String value. If null, removes the setting.<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> */<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> public void setConfiguration(String key, String value) {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> if (value == null) {<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> removeConfiguration(key);<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> } else {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> configuration.put(key, value);<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> }<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> }<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> * Remove a config setting represented by the key from the {@link #configuration} map<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> */<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> public void removeConfiguration(final String key) {<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> configuration.remove(key);<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> @Override<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> public String toString() {<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> StringBuilder s = new StringBuilder();<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> s.append('{');<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> s.append(HConstants.NAME);<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> s.append(" => '");<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> s.append(name);<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> s.append("'");<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> for (Map.Entry<String, String> e : configuration.entrySet()) {<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> String key = e.getKey();<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> String value = e.getValue();<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> if (key == null) {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> continue;<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> }<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> s.append(", ");<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> s.append(key);<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> s.append(" => '");<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> s.append(value);<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> s.append("'");<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> }<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> s.append('}');<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> return s.toString();<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> }<a name="line.152"></a> |
| <span class="sourceLineNo">153</span><a name="line.153"></a> |
| <span class="sourceLineNo">154</span> public static Builder create(String name) {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> return new Builder(name);<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> }<a name="line.156"></a> |
| <span class="sourceLineNo">157</span><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> public static Builder create(NamespaceDescriptor ns) {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> return new Builder(ns);<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> }<a name="line.160"></a> |
| <span class="sourceLineNo">161</span><a name="line.161"></a> |
| <span class="sourceLineNo">162</span> @InterfaceAudience.Public<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> public static class Builder {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> private String bName;<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> private Map<String, String> bConfiguration = new TreeMap<>();<a name="line.165"></a> |
| <span class="sourceLineNo">166</span><a name="line.166"></a> |
| <span class="sourceLineNo">167</span> private Builder(NamespaceDescriptor ns) {<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> this.bName = ns.name;<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> this.bConfiguration = ns.configuration;<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> private Builder(String name) {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> this.bName = name;<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> }<a name="line.174"></a> |
| <span class="sourceLineNo">175</span><a name="line.175"></a> |
| <span class="sourceLineNo">176</span> public Builder addConfiguration(Map<String, String> configuration) {<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> this.bConfiguration.putAll(configuration);<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> return this;<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> }<a name="line.179"></a> |
| <span class="sourceLineNo">180</span><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> public Builder addConfiguration(String key, String value) {<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> this.bConfiguration.put(key, value);<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> return this;<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> }<a name="line.184"></a> |
| <span class="sourceLineNo">185</span><a name="line.185"></a> |
| <span class="sourceLineNo">186</span> public Builder removeConfiguration(String key) {<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> this.bConfiguration.remove(key);<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> return this;<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> }<a name="line.189"></a> |
| <span class="sourceLineNo">190</span><a name="line.190"></a> |
| <span class="sourceLineNo">191</span> public NamespaceDescriptor build() {<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> if (this.bName == null){<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> throw new IllegalArgumentException("A name has to be specified in a namespace.");<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> }<a name="line.194"></a> |
| <span class="sourceLineNo">195</span><a name="line.195"></a> |
| <span class="sourceLineNo">196</span> NamespaceDescriptor desc = new NamespaceDescriptor(this.bName);<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> desc.configuration = this.bConfiguration;<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> return desc;<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> }<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> }<a name="line.200"></a> |
| <span class="sourceLineNo">201</span>}<a name="line.201"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |