View Javadoc

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.commons.io.IOUtils;
25  import org.apache.hadoop.classification.InterfaceAudience;
26  import org.apache.hadoop.hbase.Cell;
27  import org.apache.hadoop.hbase.CellUtil;
28  import org.apache.hadoop.hbase.HBaseInterfaceAudience;
29  import org.apache.hadoop.hbase.util.Bytes;
30  
31  /**
32   * Basic Cell codec that just writes out all the individual elements of a Cell including the tags.
33   * Uses ints delimiting all lengths. Profligate. Needs tune up.
34   * <b>Use this Codec only at server side.</b>
35   */
36  @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)
37  public class CellCodecWithTags implements Codec {
38    static class CellEncoder extends BaseEncoder {
39      CellEncoder(final OutputStream out) {
40        super(out);
41      }
42  
43      @Override
44      public void write(Cell cell) throws IOException {
45        checkFlushed();
46        // Row
47        write(cell.getRowArray(), cell.getRowOffset(), cell.getRowLength());
48        // Column family
49        write(cell.getFamilyArray(), cell.getFamilyOffset(), cell.getFamilyLength());
50        // Qualifier
51        write(cell.getQualifierArray(), cell.getQualifierOffset(), cell.getQualifierLength());
52        // Version
53        this.out.write(Bytes.toBytes(cell.getTimestamp()));
54        // Type
55        this.out.write(cell.getTypeByte());
56        // Value
57        write(cell.getValueArray(), cell.getValueOffset(), cell.getValueLength());
58        // Tags
59        write(cell.getTagsArray(), cell.getTagsOffset(), cell.getTagsLength());
60        // MvccVersion
61        this.out.write(Bytes.toBytes(cell.getMvccVersion()));
62      }
63  
64      /**
65       * Write int length followed by array bytes.
66       *
67       * @param bytes
68       * @param offset
69       * @param length
70       * @throws IOException
71       */
72      private void write(final byte[] bytes, final int offset, final int length) throws IOException {
73        this.out.write(Bytes.toBytes(length));
74        this.out.write(bytes, offset, length);
75      }
76    }
77  
78    static class CellDecoder extends BaseDecoder {
79      public CellDecoder(final InputStream in) {
80        super(in);
81      }
82  
83      protected Cell parseCell() throws IOException {
84        byte[] row = readByteArray(this.in);
85        byte[] family = readByteArray(in);
86        byte[] qualifier = readByteArray(in);
87        byte[] longArray = new byte[Bytes.SIZEOF_LONG];
88        IOUtils.readFully(this.in, longArray);
89        long timestamp = Bytes.toLong(longArray);
90        byte type = (byte) this.in.read();
91        byte[] value = readByteArray(in);
92        byte[] tags = readByteArray(in);
93        // Read memstore version
94        byte[] memstoreTSArray = new byte[Bytes.SIZEOF_LONG];
95        IOUtils.readFully(this.in, memstoreTSArray);
96        long memstoreTS = Bytes.toLong(memstoreTSArray);
97        return CellUtil.createCell(row, family, qualifier, timestamp, type, value, tags, memstoreTS);
98      }
99  
100     /**
101      * @return Byte array read from the stream.
102      * @throws IOException
103      */
104     private byte[] readByteArray(final InputStream in) throws IOException {
105       byte[] intArray = new byte[Bytes.SIZEOF_INT];
106       IOUtils.readFully(in, intArray);
107       int length = Bytes.toInt(intArray);
108       byte[] bytes = new byte[length];
109       IOUtils.readFully(in, bytes);
110       return bytes;
111     }
112   }
113 
114   @Override
115   public Decoder getDecoder(InputStream is) {
116     return new CellDecoder(is);
117   }
118 
119   @Override
120   public Encoder getEncoder(OutputStream os) {
121     return new CellEncoder(os);
122   }
123 }