blob: 12e718e627800603b3959a9feccf84d7b856b932 [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>package org.apache.hadoop.hbase.codec;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.InputStream;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.OutputStream;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.nio.ByteBuffer;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.Cell;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.KeyValueUtil;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.NoTagsByteBufferKeyValue;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.NoTagsKeyValue;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.nio.ByteBuff;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.util.ByteBufferUtils;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>/**<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Codec that does KeyValue version 1 serialization.<a name="line.35"></a>
<span class="sourceLineNo">036</span> *<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;p&gt;Encodes Cell as serialized in KeyValue with total length prefix.<a name="line.37"></a>
<span class="sourceLineNo">038</span> * This is how KVs were serialized in Puts, Deletes and Results pre-0.96. Its what would<a name="line.38"></a>
<span class="sourceLineNo">039</span> * happen if you called the Writable#write KeyValue implementation. This encoder will fail<a name="line.39"></a>
<span class="sourceLineNo">040</span> * if the passed Cell is not an old-school pre-0.96 KeyValue. Does not copy bytes writing.<a name="line.40"></a>
<span class="sourceLineNo">041</span> * It just writes them direct to the passed stream.<a name="line.41"></a>
<span class="sourceLineNo">042</span> *<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;p&gt;If you wrote two KeyValues to this encoder, it would look like this in the stream:<a name="line.43"></a>
<span class="sourceLineNo">044</span> * &lt;pre&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> * length-of-KeyValue1 // A java int with the length of KeyValue1 backing array<a name="line.45"></a>
<span class="sourceLineNo">046</span> * KeyValue1 backing array filled with a KeyValue serialized in its particular format<a name="line.46"></a>
<span class="sourceLineNo">047</span> * length-of-KeyValue2<a name="line.47"></a>
<span class="sourceLineNo">048</span> * KeyValue2 backing array<a name="line.48"></a>
<span class="sourceLineNo">049</span> * &lt;/pre&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> */<a name="line.50"></a>
<span class="sourceLineNo">051</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)<a name="line.51"></a>
<span class="sourceLineNo">052</span>public class KeyValueCodec implements Codec {<a name="line.52"></a>
<span class="sourceLineNo">053</span> public static class KeyValueEncoder extends BaseEncoder {<a name="line.53"></a>
<span class="sourceLineNo">054</span> public KeyValueEncoder(final OutputStream out) {<a name="line.54"></a>
<span class="sourceLineNo">055</span> super(out);<a name="line.55"></a>
<span class="sourceLineNo">056</span> }<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> @Override<a name="line.58"></a>
<span class="sourceLineNo">059</span> public void write(Cell cell) throws IOException {<a name="line.59"></a>
<span class="sourceLineNo">060</span> checkFlushed();<a name="line.60"></a>
<span class="sourceLineNo">061</span> // Do not write tags over RPC<a name="line.61"></a>
<span class="sourceLineNo">062</span> ByteBufferUtils.putInt(this.out, KeyValueUtil.getSerializedSize(cell, false));<a name="line.62"></a>
<span class="sourceLineNo">063</span> KeyValueUtil.oswrite(cell, out, false);<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span> }<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> public static class KeyValueDecoder extends BaseDecoder {<a name="line.67"></a>
<span class="sourceLineNo">068</span> public KeyValueDecoder(final InputStream in) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> super(in);<a name="line.69"></a>
<span class="sourceLineNo">070</span> }<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> @Override<a name="line.72"></a>
<span class="sourceLineNo">073</span> protected Cell parseCell() throws IOException {<a name="line.73"></a>
<span class="sourceLineNo">074</span> // No tags here<a name="line.74"></a>
<span class="sourceLineNo">075</span> return KeyValueUtil.createKeyValueFromInputStream(in, false);<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<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> public static class ByteBuffKeyValueDecoder implements Codec.Decoder {<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> protected final ByteBuff buf;<a name="line.81"></a>
<span class="sourceLineNo">082</span> protected Cell current = null;<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> public ByteBuffKeyValueDecoder(ByteBuff buf) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> this.buf = buf;<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> @Override<a name="line.88"></a>
<span class="sourceLineNo">089</span> public boolean advance() throws IOException {<a name="line.89"></a>
<span class="sourceLineNo">090</span> if (!this.buf.hasRemaining()) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> return false;<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span> int len = buf.getInt();<a name="line.93"></a>
<span class="sourceLineNo">094</span> ByteBuffer bb = buf.asSubByteBuffer(len);<a name="line.94"></a>
<span class="sourceLineNo">095</span> if (bb.isDirect()) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> this.current = createCell(bb, bb.position(), len);<a name="line.96"></a>
<span class="sourceLineNo">097</span> } else {<a name="line.97"></a>
<span class="sourceLineNo">098</span> this.current = createCell(bb.array(), bb.arrayOffset() + bb.position(), len);<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span> buf.skip(len);<a name="line.100"></a>
<span class="sourceLineNo">101</span> return true;<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span> @Override<a name="line.104"></a>
<span class="sourceLineNo">105</span> public Cell current() {<a name="line.105"></a>
<span class="sourceLineNo">106</span> return this.current;<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> protected Cell createCell(byte[] buf, int offset, int len) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> return new NoTagsKeyValue(buf, offset, len);<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> protected Cell createCell(ByteBuffer bb, int pos, int len) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> // We know there is not going to be any tags.<a name="line.114"></a>
<span class="sourceLineNo">115</span> return new NoTagsByteBufferKeyValue(bb, pos, len);<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<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> /**<a name="line.119"></a>
<span class="sourceLineNo">120</span> * Implementation depends on {@link InputStream#available()}<a name="line.120"></a>
<span class="sourceLineNo">121</span> */<a name="line.121"></a>
<span class="sourceLineNo">122</span> @Override<a name="line.122"></a>
<span class="sourceLineNo">123</span> public Decoder getDecoder(final InputStream is) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> return new KeyValueDecoder(is);<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span> @Override<a name="line.127"></a>
<span class="sourceLineNo">128</span> public Decoder getDecoder(ByteBuff buf) {<a name="line.128"></a>
<span class="sourceLineNo">129</span> return new ByteBuffKeyValueDecoder(buf);<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> @Override<a name="line.132"></a>
<span class="sourceLineNo">133</span> public Encoder getEncoder(OutputStream os) {<a name="line.133"></a>
<span class="sourceLineNo">134</span> return new KeyValueEncoder(os);<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span>}<a name="line.136"></a>
</pre>
</div>
</body>
</html>