Google Git
Sign in
apache / hbase-site / 433d453887335f1eda9816ed245c8f7e292bf2fb / . / devapidocs / src-html / org / apache / hadoop / hbase / util / ConfigurationUtil.html
blob: d0e0b74d84588e4939fb3dbcce8bc3d28d22f0c6 [file] [log] [blame]
<!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.util;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.hbase.thirdparty.com.google.common.collect.Lists;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.hadoop.conf.Configuration;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.util.StringUtils;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.AbstractMap;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Collection;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.List;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.Map;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>/**<a name="line.31"></a>
<span class="sourceLineNo">032</span> * Utilities for storing more complex collection types in<a name="line.32"></a>
<span class="sourceLineNo">033</span> * {@link org.apache.hadoop.conf.Configuration} instances.<a name="line.33"></a>
<span class="sourceLineNo">034</span> */<a name="line.34"></a>
<span class="sourceLineNo">035</span>@InterfaceAudience.Public<a name="line.35"></a>
<span class="sourceLineNo">036</span>public final class ConfigurationUtil {<a name="line.36"></a>
<span class="sourceLineNo">037</span> // TODO: hopefully this is a good delimiter; it's not in the base64 alphabet, <a name="line.37"></a>
<span class="sourceLineNo">038</span> // nor is it valid for paths<a name="line.38"></a>
<span class="sourceLineNo">039</span> public static final char KVP_DELIMITER = '^';<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span> // Disallow instantiation<a name="line.41"></a>
<span class="sourceLineNo">042</span> private ConfigurationUtil() {<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> }<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> /**<a name="line.46"></a>
<span class="sourceLineNo">047</span> * Store a collection of Map.Entry's in conf, with each entry separated by ','<a name="line.47"></a>
<span class="sourceLineNo">048</span> * and key values delimited by {@link #KVP_DELIMITER}<a name="line.48"></a>
<span class="sourceLineNo">049</span> *<a name="line.49"></a>
<span class="sourceLineNo">050</span> * @param conf configuration to store the collection in<a name="line.50"></a>
<span class="sourceLineNo">051</span> * @param key overall key to store keyValues under<a name="line.51"></a>
<span class="sourceLineNo">052</span> * @param keyValues kvps to be stored under key in conf<a name="line.52"></a>
<span class="sourceLineNo">053</span> */<a name="line.53"></a>
<span class="sourceLineNo">054</span> public static void setKeyValues(Configuration conf, String key,<a name="line.54"></a>
<span class="sourceLineNo">055</span> Collection&lt;Map.Entry&lt;String, String&gt;&gt; keyValues) {<a name="line.55"></a>
<span class="sourceLineNo">056</span> setKeyValues(conf, key, keyValues, KVP_DELIMITER);<a name="line.56"></a>
<span class="sourceLineNo">057</span> }<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> /**<a name="line.59"></a>
<span class="sourceLineNo">060</span> * Store a collection of Map.Entry's in conf, with each entry separated by ','<a name="line.60"></a>
<span class="sourceLineNo">061</span> * and key values delimited by delimiter.<a name="line.61"></a>
<span class="sourceLineNo">062</span> *<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @param conf configuration to store the collection in<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @param key overall key to store keyValues under<a name="line.64"></a>
<span class="sourceLineNo">065</span> * @param keyValues kvps to be stored under key in conf<a name="line.65"></a>
<span class="sourceLineNo">066</span> * @param delimiter character used to separate each kvp<a name="line.66"></a>
<span class="sourceLineNo">067</span> */<a name="line.67"></a>
<span class="sourceLineNo">068</span> public static void setKeyValues(Configuration conf, String key,<a name="line.68"></a>
<span class="sourceLineNo">069</span> Collection&lt;Map.Entry&lt;String, String&gt;&gt; keyValues, char delimiter) {<a name="line.69"></a>
<span class="sourceLineNo">070</span> List&lt;String&gt; serializedKvps = Lists.newArrayList();<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> for (Map.Entry&lt;String, String&gt; kvp : keyValues) {<a name="line.72"></a>
<span class="sourceLineNo">073</span> serializedKvps.add(kvp.getKey() + delimiter + kvp.getValue());<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> conf.setStrings(key, serializedKvps.toArray(new String[serializedKvps.size()]));<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> /**<a name="line.79"></a>
<span class="sourceLineNo">080</span> * Retrieve a list of key value pairs from configuration, stored under the provided key<a name="line.80"></a>
<span class="sourceLineNo">081</span> *<a name="line.81"></a>
<span class="sourceLineNo">082</span> * @param conf configuration to retrieve kvps from<a name="line.82"></a>
<span class="sourceLineNo">083</span> * @param key key under which the key values are stored<a name="line.83"></a>
<span class="sourceLineNo">084</span> * @return the list of kvps stored under key in conf, or null if the key isn't present.<a name="line.84"></a>
<span class="sourceLineNo">085</span> * @see #setKeyValues(Configuration, String, Collection, char)<a name="line.85"></a>
<span class="sourceLineNo">086</span> */<a name="line.86"></a>
<span class="sourceLineNo">087</span> public static List&lt;Map.Entry&lt;String, String&gt;&gt; getKeyValues(Configuration conf, String key) {<a name="line.87"></a>
<span class="sourceLineNo">088</span> return getKeyValues(conf, key, KVP_DELIMITER);<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> /**<a name="line.91"></a>
<span class="sourceLineNo">092</span> * Retrieve a list of key value pairs from configuration, stored under the provided key<a name="line.92"></a>
<span class="sourceLineNo">093</span> *<a name="line.93"></a>
<span class="sourceLineNo">094</span> * @param conf configuration to retrieve kvps from<a name="line.94"></a>
<span class="sourceLineNo">095</span> * @param key key under which the key values are stored<a name="line.95"></a>
<span class="sourceLineNo">096</span> * @param delimiter character used to separate each kvp<a name="line.96"></a>
<span class="sourceLineNo">097</span> * @return the list of kvps stored under key in conf, or null if the key isn't present.<a name="line.97"></a>
<span class="sourceLineNo">098</span> * @see #setKeyValues(Configuration, String, Collection, char)<a name="line.98"></a>
<span class="sourceLineNo">099</span> */<a name="line.99"></a>
<span class="sourceLineNo">100</span> public static List&lt;Map.Entry&lt;String, String&gt;&gt; getKeyValues(Configuration conf, String key,<a name="line.100"></a>
<span class="sourceLineNo">101</span> char delimiter) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> String[] kvps = conf.getStrings(key);<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span> if (kvps == null) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> return null;<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> List&lt;Map.Entry&lt;String, String&gt;&gt; rtn = Lists.newArrayList();<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> for (String kvp : kvps) {<a name="line.110"></a>
<span class="sourceLineNo">111</span> String[] splitKvp = StringUtils.split(kvp, delimiter);<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> if (splitKvp.length != 2) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> throw new IllegalArgumentException(<a name="line.114"></a>
<span class="sourceLineNo">115</span> "Expected key value pair for configuration key '" + key + "'" + " to be of form '&lt;key&gt;"<a name="line.115"></a>
<span class="sourceLineNo">116</span> + delimiter + "&lt;value&gt;; was " + kvp + " instead");<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span><a name="line.118"></a>
<span class="sourceLineNo">119</span> rtn.add(new AbstractMap.SimpleImmutableEntry&lt;&gt;(splitKvp[0], splitKvp[1]));<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span> return rtn;<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>
</pre>
</div>
</body>
</html>