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