blob: 27464f73f656ad8bce0e11f01e0e8e04a3657b5a [file] [log] [blame]
<!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.client, class: ClientIdGenerator">
<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.client;</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.io.IOException;</span>
<span class="source-line-no">021</span><span id="line-21">import java.lang.management.ManagementFactory;</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 org.apache.hadoop.hbase.util.Addressing;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</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">import org.slf4j.Logger;</span>
<span class="source-line-no">028</span><span id="line-28">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">029</span><span id="line-29"></span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hbase.thirdparty.com.google.common.base.Splitter;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hbase.thirdparty.com.google.common.collect.Iterators;</span>
<span class="source-line-no">032</span><span id="line-32"></span>
<span class="source-line-no">033</span><span id="line-33">/**</span>
<span class="source-line-no">034</span><span id="line-34"> * The class that is able to determine some unique strings for the client, such as an IP address,</span>
<span class="source-line-no">035</span><span id="line-35"> * PID, and composite deterministic ID.</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">final class ClientIdGenerator {</span>
<span class="source-line-no">039</span><span id="line-39"> private static final Logger LOG = LoggerFactory.getLogger(ClientIdGenerator.class);</span>
<span class="source-line-no">040</span><span id="line-40"></span>
<span class="source-line-no">041</span><span id="line-41"> private ClientIdGenerator() {</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"> * Returns a unique ID incorporating IP address, PID, TID and timer. Might be an overkill... Note</span>
<span class="source-line-no">046</span><span id="line-46"> * though that new UUID in java by default is just a random number.</span>
<span class="source-line-no">047</span><span id="line-47"> */</span>
<span class="source-line-no">048</span><span id="line-48"> public static byte[] generateClientId() {</span>
<span class="source-line-no">049</span><span id="line-49"> byte[] selfBytes = getIpAddressBytes();</span>
<span class="source-line-no">050</span><span id="line-50"> Long pid = getPid();</span>
<span class="source-line-no">051</span><span id="line-51"> long tid = Thread.currentThread().getId();</span>
<span class="source-line-no">052</span><span id="line-52"> long ts = EnvironmentEdgeManager.currentTime();</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> byte[] id = new byte[selfBytes.length + ((pid != null ? 1 : 0) + 2) * Bytes.SIZEOF_LONG];</span>
<span class="source-line-no">055</span><span id="line-55"> int offset = Bytes.putBytes(id, 0, selfBytes, 0, selfBytes.length);</span>
<span class="source-line-no">056</span><span id="line-56"> if (pid != null) {</span>
<span class="source-line-no">057</span><span id="line-57"> offset = Bytes.putLong(id, offset, pid);</span>
<span class="source-line-no">058</span><span id="line-58"> }</span>
<span class="source-line-no">059</span><span id="line-59"> offset = Bytes.putLong(id, offset, tid);</span>
<span class="source-line-no">060</span><span id="line-60"> offset = Bytes.putLong(id, offset, ts);</span>
<span class="source-line-no">061</span><span id="line-61"> assert offset == id.length;</span>
<span class="source-line-no">062</span><span id="line-62"> return id;</span>
<span class="source-line-no">063</span><span id="line-63"> }</span>
<span class="source-line-no">064</span><span id="line-64"></span>
<span class="source-line-no">065</span><span id="line-65"> /** Returns PID of the current process, if it can be extracted from JVM name, or null. */</span>
<span class="source-line-no">066</span><span id="line-66"> public static Long getPid() {</span>
<span class="source-line-no">067</span><span id="line-67"> String name = ManagementFactory.getRuntimeMXBean().getName();</span>
<span class="source-line-no">068</span><span id="line-68"> List&lt;String&gt; nameParts = Splitter.on('@').splitToList(name);</span>
<span class="source-line-no">069</span><span id="line-69"> if (nameParts.size() == 2) { // 12345@somewhere</span>
<span class="source-line-no">070</span><span id="line-70"> try {</span>
<span class="source-line-no">071</span><span id="line-71"> return Long.parseLong(Iterators.get(nameParts.iterator(), 0));</span>
<span class="source-line-no">072</span><span id="line-72"> } catch (NumberFormatException ex) {</span>
<span class="source-line-no">073</span><span id="line-73"> LOG.warn("Failed to get PID from [" + name + "]", ex);</span>
<span class="source-line-no">074</span><span id="line-74"> }</span>
<span class="source-line-no">075</span><span id="line-75"> } else {</span>
<span class="source-line-no">076</span><span id="line-76"> LOG.warn("Don't know how to get PID from [" + name + "]");</span>
<span class="source-line-no">077</span><span id="line-77"> }</span>
<span class="source-line-no">078</span><span id="line-78"> return null;</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"> /**</span>
<span class="source-line-no">082</span><span id="line-82"> * Returns Some IPv4/IPv6 address available on the current machine that is up, not virtual and not</span>
<span class="source-line-no">083</span><span id="line-83"> * a loopback address. Empty array if none can be found or error occurred.</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 static byte[] getIpAddressBytes() {</span>
<span class="source-line-no">086</span><span id="line-86"> try {</span>
<span class="source-line-no">087</span><span id="line-87"> return Addressing.getIpAddress().getAddress();</span>
<span class="source-line-no">088</span><span id="line-88"> } catch (IOException ex) {</span>
<span class="source-line-no">089</span><span id="line-89"> LOG.warn("Failed to get IP address bytes", ex);</span>
<span class="source-line-no">090</span><span id="line-90"> }</span>
<span class="source-line-no">091</span><span id="line-91"> return new byte[0];</span>
<span class="source-line-no">092</span><span id="line-92"> }</span>
<span class="source-line-no">093</span><span id="line-93">}</span>
</pre>
</div>
</main>
</body>
</html>