1 /**
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18 package org.apache.hadoop.hbase.codec;
19
20 import java.io.IOException;
21 import java.io.InputStream;
22 import java.io.OutputStream;
23
24 import org.apache.hadoop.hbase.classification.InterfaceAudience;
25 import org.apache.hadoop.hbase.Cell;
26 import org.apache.hadoop.hbase.HBaseInterfaceAudience;
27 import org.apache.hadoop.hbase.KeyValue;
28 import org.apache.hadoop.hbase.KeyValueUtil;
29
30 /**
31 * Codec that does KeyValue version 1 serialization with serializing tags also.
32 *
33 * <p>
34 * Encodes Cell as serialized in KeyValue with total length prefix. This
35 * is how KVs were serialized in Puts, Deletes and Results pre-0.96. Its what would happen if you
36 * called the Writable#write KeyValue implementation. This encoder will fail if the passed Cell is
37 * not an old-school pre-0.96 KeyValue. Does not copy bytes writing. It just writes them direct to
38 * the passed stream.
39 *
40 * <p>
41 * If you wrote two KeyValues to this encoder, it would look like this in the stream:
42 *
43 * <pre>
44 * length-of-KeyValue1 // A java int with the length of KeyValue1 backing array
45 * KeyValue1 backing array filled with a KeyValue serialized in its particular format
46 * length-of-KeyValue2
47 * KeyValue2 backing array
48 * </pre>
49 *
50 * Note: The only difference of this with KeyValueCodec is the latter ignores tags in Cells.
51 * <b>Use this Codec only at server side.</b>
52 */
53 @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)
54 public class KeyValueCodecWithTags implements Codec {
55 public static class KeyValueEncoder extends BaseEncoder {
56 public KeyValueEncoder(final OutputStream out) {
57 super(out);
58 }
59
60 @Override
61 public void write(Cell cell) throws IOException {
62 checkFlushed();
63 // Write tags
64 KeyValueUtil.oswrite(cell, out, true);
65 }
66 }
67
68 public static class KeyValueDecoder extends BaseDecoder {
69 public KeyValueDecoder(final InputStream in) {
70 super(in);
71 }
72
73 protected Cell parseCell() throws IOException {
74 return KeyValue.iscreate(in);
75 }
76 }
77
78 /**
79 * Implementation depends on {@link InputStream#available()}
80 */
81 @Override
82 public Decoder getDecoder(final InputStream is) {
83 return new KeyValueDecoder(is);
84 }
85
86 @Override
87 public Encoder getEncoder(OutputStream os) {
88 return new KeyValueEncoder(os);
89 }
90 }