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