| <!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: ClientUtils"> |
| <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.nio.ByteBuffer;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.HashMap;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.Map;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.TreeMap;</span> |
| <span class="source-line-no">024</span><span id="line-24">import javax.security.auth.Subject;</span> |
| <span class="source-line-no">025</span><span id="line-25">import javax.security.auth.login.AppConfigurationEntry;</span> |
| <span class="source-line-no">026</span><span id="line-26">import javax.security.auth.login.Configuration;</span> |
| <span class="source-line-no">027</span><span id="line-27">import javax.security.auth.login.LoginContext;</span> |
| <span class="source-line-no">028</span><span id="line-28">import javax.security.auth.login.LoginException;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.commons.lang3.StringUtils;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.thrift.generated.TCell;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.thrift.generated.TRowResult;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">033</span><span id="line-33"></span> |
| <span class="source-line-no">034</span><span id="line-34">/**</span> |
| <span class="source-line-no">035</span><span id="line-35"> * Common Utility class for clients</span> |
| <span class="source-line-no">036</span><span id="line-36"> */</span> |
| <span class="source-line-no">037</span><span id="line-37">@InterfaceAudience.Private</span> |
| <span class="source-line-no">038</span><span id="line-38">public final class ClientUtils {</span> |
| <span class="source-line-no">039</span><span id="line-39"></span> |
| <span class="source-line-no">040</span><span id="line-40"> private ClientUtils() {</span> |
| <span class="source-line-no">041</span><span id="line-41"> // Empty block</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"> * To authenticate the demo client, kinit should be invoked ahead. Here we try to get the Kerberos</span> |
| <span class="source-line-no">046</span><span id="line-46"> * credential from the ticket cache</span> |
| <span class="source-line-no">047</span><span id="line-47"> * @return LoginContext Object</span> |
| <span class="source-line-no">048</span><span id="line-48"> * @throws LoginException Exception thrown if unable to get LoginContext</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 static LoginContext getLoginContext() throws LoginException {</span> |
| <span class="source-line-no">051</span><span id="line-51"></span> |
| <span class="source-line-no">052</span><span id="line-52"> return new LoginContext(StringUtils.EMPTY, new Subject(), null, new Configuration() {</span> |
| <span class="source-line-no">053</span><span id="line-53"> @Override</span> |
| <span class="source-line-no">054</span><span id="line-54"> public AppConfigurationEntry[] getAppConfigurationEntry(String name) {</span> |
| <span class="source-line-no">055</span><span id="line-55"> Map<String, String> options = new HashMap<>();</span> |
| <span class="source-line-no">056</span><span id="line-56"> options.put("useKeyTab", "false");</span> |
| <span class="source-line-no">057</span><span id="line-57"> options.put("storeKey", "false");</span> |
| <span class="source-line-no">058</span><span id="line-58"> options.put("doNotPrompt", "true");</span> |
| <span class="source-line-no">059</span><span id="line-59"> options.put("useTicketCache", "true");</span> |
| <span class="source-line-no">060</span><span id="line-60"> options.put("renewTGT", "true");</span> |
| <span class="source-line-no">061</span><span id="line-61"> options.put("refreshKrb5Config", "true");</span> |
| <span class="source-line-no">062</span><span id="line-62"> options.put("isInitiator", "true");</span> |
| <span class="source-line-no">063</span><span id="line-63"> String ticketCache = System.getenv("KRB5CCNAME");</span> |
| <span class="source-line-no">064</span><span id="line-64"> if (ticketCache != null) {</span> |
| <span class="source-line-no">065</span><span id="line-65"> options.put("ticketCache", ticketCache);</span> |
| <span class="source-line-no">066</span><span id="line-66"> }</span> |
| <span class="source-line-no">067</span><span id="line-67"> options.put("debug", "true");</span> |
| <span class="source-line-no">068</span><span id="line-68"></span> |
| <span class="source-line-no">069</span><span id="line-69"> return new AppConfigurationEntry[] {</span> |
| <span class="source-line-no">070</span><span id="line-70"> new AppConfigurationEntry("com.sun.security.auth.module.Krb5LoginModule",</span> |
| <span class="source-line-no">071</span><span id="line-71"> AppConfigurationEntry.LoginModuleControlFlag.REQUIRED, options) };</span> |
| <span class="source-line-no">072</span><span id="line-72"> }</span> |
| <span class="source-line-no">073</span><span id="line-73"> });</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"> /**</span> |
| <span class="source-line-no">078</span><span id="line-78"> * copy values into a TreeMap to get them in sorted order and print it</span> |
| <span class="source-line-no">079</span><span id="line-79"> * @param rowResult Holds row name and then a map of columns to cells</span> |
| <span class="source-line-no">080</span><span id="line-80"> */</span> |
| <span class="source-line-no">081</span><span id="line-81"> public static void printRow(final TRowResult rowResult) {</span> |
| <span class="source-line-no">082</span><span id="line-82"></span> |
| <span class="source-line-no">083</span><span id="line-83"> TreeMap<String, TCell> sorted = new TreeMap<>();</span> |
| <span class="source-line-no">084</span><span id="line-84"> for (Map.Entry<ByteBuffer, TCell> column : rowResult.columns.entrySet()) {</span> |
| <span class="source-line-no">085</span><span id="line-85"> sorted.put(utf8(column.getKey().array()), column.getValue());</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"> StringBuilder rowStr = new StringBuilder();</span> |
| <span class="source-line-no">089</span><span id="line-89"> for (Map.Entry<String, TCell> entry : sorted.entrySet()) {</span> |
| <span class="source-line-no">090</span><span id="line-90"> rowStr.append(entry.getKey());</span> |
| <span class="source-line-no">091</span><span id="line-91"> rowStr.append(" => ");</span> |
| <span class="source-line-no">092</span><span id="line-92"> rowStr.append(utf8(entry.getValue().value.array()));</span> |
| <span class="source-line-no">093</span><span id="line-93"> rowStr.append("; ");</span> |
| <span class="source-line-no">094</span><span id="line-94"> }</span> |
| <span class="source-line-no">095</span><span id="line-95"> System.out.println("row: " + utf8(rowResult.row.array()) + ", cols: " + rowStr);</span> |
| <span class="source-line-no">096</span><span id="line-96"></span> |
| <span class="source-line-no">097</span><span id="line-97"> }</span> |
| <span class="source-line-no">098</span><span id="line-98"></span> |
| <span class="source-line-no">099</span><span id="line-99"> /**</span> |
| <span class="source-line-no">100</span><span id="line-100"> * Helper to translate byte[]s to UTF8 strings</span> |
| <span class="source-line-no">101</span><span id="line-101"> * @param buf byte array</span> |
| <span class="source-line-no">102</span><span id="line-102"> * @return UTF8 decoded string value</span> |
| <span class="source-line-no">103</span><span id="line-103"> */</span> |
| <span class="source-line-no">104</span><span id="line-104"> public static String utf8(final byte[] buf) {</span> |
| <span class="source-line-no">105</span><span id="line-105"> try {</span> |
| <span class="source-line-no">106</span><span id="line-106"> return Bytes.toString(buf);</span> |
| <span class="source-line-no">107</span><span id="line-107"> } catch (IllegalArgumentException e) {</span> |
| <span class="source-line-no">108</span><span id="line-108"> return "[INVALID UTF-8]";</span> |
| <span class="source-line-no">109</span><span id="line-109"> }</span> |
| <span class="source-line-no">110</span><span id="line-110"> }</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"> * Helper to translate a byte buffer to UTF8 strings</span> |
| <span class="source-line-no">114</span><span id="line-114"> * @param bb byte buffer</span> |
| <span class="source-line-no">115</span><span id="line-115"> * @return UTF8 decoded string value</span> |
| <span class="source-line-no">116</span><span id="line-116"> */</span> |
| <span class="source-line-no">117</span><span id="line-117"> public static String utf8(final ByteBuffer bb) {</span> |
| <span class="source-line-no">118</span><span id="line-118"> // performance is not very critical here so we always copy the BB to a byte array</span> |
| <span class="source-line-no">119</span><span id="line-119"> byte[] buf = new byte[bb.remaining()];</span> |
| <span class="source-line-no">120</span><span id="line-120"> // duplicate so the get will not change the position of the original bb</span> |
| <span class="source-line-no">121</span><span id="line-121"> bb.duplicate().get(buf);</span> |
| <span class="source-line-no">122</span><span id="line-122"> return utf8(buf);</span> |
| <span class="source-line-no">123</span><span id="line-123"> }</span> |
| <span class="source-line-no">124</span><span id="line-124"></span> |
| <span class="source-line-no">125</span><span id="line-125">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
