| <!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.wal, interface: WALKey"> |
| <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.wal;</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.ArrayList;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.Collections;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.HashMap;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.List;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.Map;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.UUID;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.HConstants;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.TableName;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.regionserver.SequenceId;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.util.Bytes;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.yetus.audience.InterfaceAudience;</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"> * Key for WAL Entry.</span> |
| <span class="source-line-no">035</span><span id="line-35"> */</span> |
| <span class="source-line-no">036</span><span id="line-36">@InterfaceAudience.LimitedPrivate({ HBaseInterfaceAudience.REPLICATION,</span> |
| <span class="source-line-no">037</span><span id="line-37"> HBaseInterfaceAudience.COPROC })</span> |
| <span class="source-line-no">038</span><span id="line-38">public interface WALKey extends SequenceId, Comparable<WALKey> {</span> |
| <span class="source-line-no">039</span><span id="line-39"> /**</span> |
| <span class="source-line-no">040</span><span id="line-40"> * Unmodifiable empty list of UUIDs.</span> |
| <span class="source-line-no">041</span><span id="line-41"> */</span> |
| <span class="source-line-no">042</span><span id="line-42"> List<UUID> EMPTY_UUIDS = Collections.unmodifiableList(new ArrayList<UUID>());</span> |
| <span class="source-line-no">043</span><span id="line-43"></span> |
| <span class="source-line-no">044</span><span id="line-44"> default long estimatedSerializedSizeOf() {</span> |
| <span class="source-line-no">045</span><span id="line-45"> return 0;</span> |
| <span class="source-line-no">046</span><span id="line-46"> }</span> |
| <span class="source-line-no">047</span><span id="line-47"></span> |
| <span class="source-line-no">048</span><span id="line-48"> /** Returns encoded region name */</span> |
| <span class="source-line-no">049</span><span id="line-49"> byte[] getEncodedRegionName();</span> |
| <span class="source-line-no">050</span><span id="line-50"></span> |
| <span class="source-line-no">051</span><span id="line-51"> /** Returns table name */</span> |
| <span class="source-line-no">052</span><span id="line-52"> TableName getTableName();</span> |
| <span class="source-line-no">053</span><span id="line-53"></span> |
| <span class="source-line-no">054</span><span id="line-54"> /** Returns the write time */</span> |
| <span class="source-line-no">055</span><span id="line-55"> long getWriteTime();</span> |
| <span class="source-line-no">056</span><span id="line-56"></span> |
| <span class="source-line-no">057</span><span id="line-57"> /** Returns The nonce group */</span> |
| <span class="source-line-no">058</span><span id="line-58"> default long getNonceGroup() {</span> |
| <span class="source-line-no">059</span><span id="line-59"> return HConstants.NO_NONCE;</span> |
| <span class="source-line-no">060</span><span id="line-60"> }</span> |
| <span class="source-line-no">061</span><span id="line-61"></span> |
| <span class="source-line-no">062</span><span id="line-62"> /** Returns The nonce */</span> |
| <span class="source-line-no">063</span><span id="line-63"> default long getNonce() {</span> |
| <span class="source-line-no">064</span><span id="line-64"> return HConstants.NO_NONCE;</span> |
| <span class="source-line-no">065</span><span id="line-65"> }</span> |
| <span class="source-line-no">066</span><span id="line-66"></span> |
| <span class="source-line-no">067</span><span id="line-67"> UUID getOriginatingClusterId();</span> |
| <span class="source-line-no">068</span><span id="line-68"></span> |
| <span class="source-line-no">069</span><span id="line-69"> /**</span> |
| <span class="source-line-no">070</span><span id="line-70"> * Return a positive long if current WALKeyImpl is created from a replay edit; a replay edit is an</span> |
| <span class="source-line-no">071</span><span id="line-71"> * edit that came in when replaying WALs of a crashed server.</span> |
| <span class="source-line-no">072</span><span id="line-72"> * @return original sequence number of the WALEdit</span> |
| <span class="source-line-no">073</span><span id="line-73"> */</span> |
| <span class="source-line-no">074</span><span id="line-74"> long getOrigLogSeqNum();</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"> * Add a named String value to this WALKey to be persisted into the WAL</span> |
| <span class="source-line-no">078</span><span id="line-78"> * @param attributeKey Name of the attribute</span> |
| <span class="source-line-no">079</span><span id="line-79"> * @param attributeValue Value of the attribute</span> |
| <span class="source-line-no">080</span><span id="line-80"> */</span> |
| <span class="source-line-no">081</span><span id="line-81"> void addExtendedAttribute(String attributeKey, byte[] attributeValue);</span> |
| <span class="source-line-no">082</span><span id="line-82"></span> |
| <span class="source-line-no">083</span><span id="line-83"> /**</span> |
| <span class="source-line-no">084</span><span id="line-84"> * Return a named String value injected into the WALKey during processing, such as by a</span> |
| <span class="source-line-no">085</span><span id="line-85"> * coprocessor</span> |
| <span class="source-line-no">086</span><span id="line-86"> * @param attributeKey The key of a key / value pair</span> |
| <span class="source-line-no">087</span><span id="line-87"> */</span> |
| <span class="source-line-no">088</span><span id="line-88"> default byte[] getExtendedAttribute(String attributeKey) {</span> |
| <span class="source-line-no">089</span><span id="line-89"> return null;</span> |
| <span class="source-line-no">090</span><span id="line-90"> }</span> |
| <span class="source-line-no">091</span><span id="line-91"></span> |
| <span class="source-line-no">092</span><span id="line-92"> /**</span> |
| <span class="source-line-no">093</span><span id="line-93"> * Returns a map of all extended attributes injected into this WAL 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"> default Map<String, byte[]> getExtendedAttributes() {</span> |
| <span class="source-line-no">096</span><span id="line-96"> return new HashMap<>();</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"> * Produces a string map for this key. Useful for programmatic use and manipulation of the data</span> |
| <span class="source-line-no">101</span><span id="line-101"> * stored in an WALKeyImpl, for example, printing as JSON.</span> |
| <span class="source-line-no">102</span><span id="line-102"> * @return a Map containing data from this key</span> |
| <span class="source-line-no">103</span><span id="line-103"> */</span> |
| <span class="source-line-no">104</span><span id="line-104"> default Map<String, Object> toStringMap() {</span> |
| <span class="source-line-no">105</span><span id="line-105"> Map<String, Object> stringMap = new HashMap<>();</span> |
| <span class="source-line-no">106</span><span id="line-106"> stringMap.put("table", getTableName());</span> |
| <span class="source-line-no">107</span><span id="line-107"> stringMap.put("region", Bytes.toStringBinary(getEncodedRegionName()));</span> |
| <span class="source-line-no">108</span><span id="line-108"> stringMap.put("sequence", getSequenceId());</span> |
| <span class="source-line-no">109</span><span id="line-109"> Map<String, byte[]> extendedAttributes = getExtendedAttributes();</span> |
| <span class="source-line-no">110</span><span id="line-110"> if (extendedAttributes != null) {</span> |
| <span class="source-line-no">111</span><span id="line-111"> for (Map.Entry<String, byte[]> entry : extendedAttributes.entrySet()) {</span> |
| <span class="source-line-no">112</span><span id="line-112"> stringMap.put(entry.getKey(), Bytes.toStringBinary(entry.getValue()));</span> |
| <span class="source-line-no">113</span><span id="line-113"> }</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 stringMap;</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> |
