HFileBlockDefaultEncodingContext (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.io.encoding.HFileBlockDefaultEncodingContext

All Implemented Interfaces:

HFileBlockEncodingContext
```
@InterfaceAudience.Private
public class HFileBlockDefaultEncodingContext
extends Object
implements HFileBlockEncodingContext
```
A default implementation of HFileBlockEncodingContext. It will compress the data section as one continuous buffer.

See Also:
for the decompression part

Field Summary

Fields
Modifier and Type	Field and Description
`private BlockType`	`blockType`
`private ByteArrayOutputStream`	`compressedByteStream` Underlying stream to write compressed bytes to
`private org.apache.hadoop.io.compress.CompressionOutputStream`	`compressionStream` Compression output stream
`private org.apache.hadoop.io.compress.Compressor`	`compressor` Compressor, which is also reused between consecutive blocks.
`private ByteArrayOutputStream`	`cryptoByteStream` Underlying stream to write encrypted bytes to
`private byte[]`	`dummyHeader`
`private EncodingState`	`encoderState`
`private DataBlockEncoding`	`encodingAlgo`
`private HFileContext`	`fileContext`
`private byte[]`	`iv` Initialization vector
`private byte[]`	`onDiskBytesWithHeader`
`private TagCompressionContext`	`tagCompressionContext`

Constructor Summary

Constructors
Constructor and Description
`HFileBlockDefaultEncodingContext(DataBlockEncoding encoding, byte[] headerBytes, HFileContext fileContext)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Releases the compressor this writer uses to compress blocks into the compressor pool.
`protected void`	`compressAfterEncoding(byte[] uncompressedBytesWithHeader, byte[] headerBytes)`
`byte[]`	`compressAndEncrypt(byte[] uncompressedBytesWithHeader)`
`BlockType`	`getBlockType()`
`DataBlockEncoding`	`getDataBlockEncoding()`
`EncodingState`	`getEncodingState()`
`HFileContext`	`getHFileContext()`
`TagCompressionContext`	`getTagCompressionContext()`
`void`	`postEncoding(BlockType blockType)` Do any action that needs to be performed after the encoding.
`void`	`prepareEncoding(DataOutputStream out)` prepare to start a new encoding.
`void`	`setEncodingState(EncodingState state)` Sets the encoding state.
`void`	`setTagCompressionContext(TagCompressionContext tagCompressionContext)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - onDiskBytesWithHeader
```
private byte[] onDiskBytesWithHeader
```
  - blockType
```
private BlockType blockType
```
  - encodingAlgo
```
private final DataBlockEncoding encodingAlgo
```
  - dummyHeader
```
private byte[] dummyHeader
```
  - compressor
```
private org.apache.hadoop.io.compress.Compressor compressor
```
    Compressor, which is also reused between consecutive blocks.
  - compressionStream
```
private org.apache.hadoop.io.compress.CompressionOutputStream compressionStream
```
    Compression output stream
  - compressedByteStream
```
private ByteArrayOutputStream compressedByteStream
```
    Underlying stream to write compressed bytes to
  - fileContext
```
private HFileContext fileContext
```
  - tagCompressionContext
```
private TagCompressionContext tagCompressionContext
```
  - cryptoByteStream
```
private ByteArrayOutputStream cryptoByteStream
```
    Underlying stream to write encrypted bytes to
  - iv
```
private byte[] iv
```
    Initialization vector
  - encoderState
```
private EncodingState encoderState
```
- Constructor Detail
  - HFileBlockDefaultEncodingContext
```
public HFileBlockDefaultEncodingContext(DataBlockEncoding encoding,
                                byte[] headerBytes,
                                HFileContext fileContext)
```
    Parameters:
    encoding - encoding used
    headerBytes - dummy header bytes
    fileContext - HFile meta data
- Method Detail
  - prepareEncoding
```
public void prepareEncoding(DataOutputStream out)
                     throws IOException
```
    prepare to start a new encoding.
    
    Throws:
    
    IOException
  - postEncoding
```
public void postEncoding(BlockType blockType)
                  throws IOException
```
    Description copied from interface: HFileBlockEncodingContext
    
    Do any action that needs to be performed after the encoding. Compression is also included if a non-null compression algorithm is used
    
    Specified by:
    
    postEncoding in interface HFileBlockEncodingContext
    
    Throws:
    
    IOException
  - compressAndEncrypt
```
public byte[] compressAndEncrypt(byte[] uncompressedBytesWithHeader)
                          throws IOException
```
    Specified by:
    
    compressAndEncrypt in interface HFileBlockEncodingContext
    
    Parameters:
    uncompressedBytesWithHeader - encoded bytes with header
    
    Returns:
    Bytes with header which are ready to write out to disk. This is compressed and encrypted bytes applying the set compression algorithm and encryption.
    
    Throws:
    
    IOException
  - compressAfterEncoding
```
protected void compressAfterEncoding(byte[] uncompressedBytesWithHeader,
                         byte[] headerBytes)
                              throws IOException
```
    Parameters:
    uncompressedBytesWithHeader -
    headerBytes -
    
    Throws:
    
    IOException
  - getBlockType
```
public BlockType getBlockType()
```
    Specified by:
    
    getBlockType in interface HFileBlockEncodingContext
    
    Returns:
    the block type after encoding
  - close
```
public void close()
```
    Releases the compressor this writer uses to compress blocks into the compressor pool.
    
    Specified by:
    
    close in interface HFileBlockEncodingContext
  - getDataBlockEncoding
```
public DataBlockEncoding getDataBlockEncoding()
```
    Specified by:
    
    getDataBlockEncoding in interface HFileBlockEncodingContext
    
    Returns:
    the DataBlockEncoding encoding used
  - getHFileContext
```
public HFileContext getHFileContext()
```
    Specified by:
    
    getHFileContext in interface HFileBlockEncodingContext
    
    Returns:
    HFile context information
  - getTagCompressionContext
```
public TagCompressionContext getTagCompressionContext()
```
  - setTagCompressionContext
```
public void setTagCompressionContext(TagCompressionContext tagCompressionContext)
```
  - getEncodingState
```
public EncodingState getEncodingState()
```
    Specified by:
    
    getEncodingState in interface HFileBlockEncodingContext
    
    Returns:
    the encoding state
  - setEncodingState
```
public void setEncodingState(EncodingState state)
```
    Description copied from interface: HFileBlockEncodingContext
    
    Sets the encoding state.
    
    Specified by:
    
    setEncodingState in interface HFileBlockEncodingContext

Class HFileBlockDefaultEncodingContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

onDiskBytesWithHeader

blockType

encodingAlgo

dummyHeader

compressor

compressionStream

compressedByteStream

fileContext

tagCompressionContext

cryptoByteStream

iv

encoderState

Constructor Detail

HFileBlockDefaultEncodingContext

Method Detail

prepareEncoding

postEncoding

compressAndEncrypt

compressAfterEncoding

getBlockType

close

getDataBlockEncoding

getHFileContext

getTagCompressionContext

setTagCompressionContext

getEncodingState

setEncodingState