org.apache.hadoop.hbase.regionserver.wal

Class AbstractProtobufLogWriter

java.lang.Object

org.apache.hadoop.hbase.regionserver.wal.AbstractProtobufLogWriter

Direct Known Subclasses:

AsyncProtobufLogWriter, ProtobufLogWriter

@InterfaceAudience.LimitedPrivate(value="Configuration")
public abstract class AbstractProtobufLogWriter
extends Object

Base class for Protobuf log writer.

Field Summary

Fields

Modifier and Type	Field and Description
protected Codec.Encoder	cellEncoder
protected CompressionContext	compressionContext
protected WALCellCodec.ByteStringCompressor	compressor
protected org.apache.hadoop.conf.Configuration	conf
protected AtomicLong	length
private static org.slf4j.Logger	LOG
protected org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALTrailer	trailer
protected int	trailerWarnSize
protected boolean	trailerWritten

Constructor Summary

Constructors

Constructor and Description
AbstractProtobufLogWriter()

Method Summary

Modifier and Type	Method and Description
protected org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALHeader	buildSecureWALHeader(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALHeader.Builder builder)
protected org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALHeader	buildWALHeader(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALHeader.Builder builder)
private org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALHeader	buildWALHeader0(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALHeader.Builder builder)
private org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALTrailer	buildWALTrailer(org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALTrailer.Builder builder)
protected void	closeOutputIfNecessary() It is straight forward to close the output, do not need to write trailer like the Writer.close
private WALCellCodec	getCodec(org.apache.hadoop.conf.Configuration conf, CompressionContext compressionContext)
long	getLength()
protected abstract OutputStream	getOutputStreamForCellEncoder()
protected String	getWriterClassName()
void	init(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path path, org.apache.hadoop.conf.Configuration conf, boolean overwritable, long blocksize, StreamSlowMonitor monitor)
protected void	initAfterHeader(boolean doCompress)
private void	initAfterHeader0(boolean doCompress)
private boolean	initializeCompressionContext(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.Path path)
protected abstract void	initOutput(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path path, boolean overwritable, int bufferSize, short replication, long blockSize, StreamSlowMonitor monitor)
protected void	secureInitAfterHeader(boolean doCompress, Encryptor encryptor)
protected void	setEncryptor(Encryptor encryptor)
(package private) void	setWALTrailer(org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALTrailer walTrailer)
protected abstract long	writeMagicAndWALHeader(byte[] magic, org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALHeader header) return the file length after written.
protected void	writeWALTrailer()
protected abstract long	writeWALTrailerAndMagic(org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALTrailer trailer, byte[] magic)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final org.slf4j.Logger LOG

compressionContext

protected CompressionContext compressionContext

conf

protected org.apache.hadoop.conf.Configuration conf

cellEncoder

protected Codec.Encoder cellEncoder

compressor

protected WALCellCodec.ByteStringCompressor compressor

trailerWritten

protected boolean trailerWritten

trailer

protected org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALTrailer trailer

trailerWarnSize

protected int trailerWarnSize

length

protected AtomicLong length

Constructor Detail

AbstractProtobufLogWriter

public AbstractProtobufLogWriter()

Method Detail

getCodec

private WALCellCodec getCodec(org.apache.hadoop.conf.Configuration conf,
                              CompressionContext compressionContext)
                       throws IOException

Throws:

IOException

buildWALHeader0

private org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALHeader buildWALHeader0(org.apache.hadoop.conf.Configuration conf,
                                                                                              org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALHeader.Builder builder)

buildWALHeader

protected org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALHeader buildWALHeader(org.apache.hadoop.conf.Configuration conf,
                                                                                               org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALHeader.Builder builder)
                                                                                        throws IOException

Throws:

IOException

buildSecureWALHeader

protected final org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALHeader buildSecureWALHeader(org.apache.hadoop.conf.Configuration conf,
                                                                                                           org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALHeader.Builder builder)
                                                                                                    throws IOException

Throws:

IOException

setEncryptor

protected void setEncryptor(Encryptor encryptor)

getWriterClassName

protected String getWriterClassName()

initializeCompressionContext

private boolean initializeCompressionContext(org.apache.hadoop.conf.Configuration conf,
                                             org.apache.hadoop.fs.Path path)
                                      throws IOException

Throws:

IOException

init

public void init(org.apache.hadoop.fs.FileSystem fs,
                 org.apache.hadoop.fs.Path path,
                 org.apache.hadoop.conf.Configuration conf,
                 boolean overwritable,
                 long blocksize,
                 StreamSlowMonitor monitor)
          throws IOException,
                 CommonFSUtils.StreamLacksCapabilityException

Throws:

IOException

CommonFSUtils.StreamLacksCapabilityException

initAfterHeader0

private void initAfterHeader0(boolean doCompress)
                       throws IOException

Throws:

IOException

initAfterHeader

protected void initAfterHeader(boolean doCompress)
                        throws IOException

Throws:

IOException

secureInitAfterHeader

protected final void secureInitAfterHeader(boolean doCompress,
                                           Encryptor encryptor)
                                    throws IOException

Throws:

IOException

setWALTrailer

void setWALTrailer(org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALTrailer walTrailer)

getLength

public long getLength()

buildWALTrailer

private org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALTrailer buildWALTrailer(org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALTrailer.Builder builder)

writeWALTrailer

protected void writeWALTrailer()

initOutput

protected abstract void initOutput(org.apache.hadoop.fs.FileSystem fs,
                                   org.apache.hadoop.fs.Path path,
                                   boolean overwritable,
                                   int bufferSize,
                                   short replication,
                                   long blockSize,
                                   StreamSlowMonitor monitor)
                            throws IOException,
                                   CommonFSUtils.StreamLacksCapabilityException

Throws:

IOException

CommonFSUtils.StreamLacksCapabilityException

closeOutputIfNecessary

protected void closeOutputIfNecessary()

It is straight forward to close the output, do not need to write trailer like the Writer.close

writeMagicAndWALHeader

protected abstract long writeMagicAndWALHeader(byte[] magic,
                                               org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALHeader header)
                                        throws IOException

return the file length after written.

Throws:

IOException

writeWALTrailerAndMagic

protected abstract long writeWALTrailerAndMagic(org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALTrailer trailer,
                                                byte[] magic)
                                         throws IOException

Throws:

IOException

getOutputStreamForCellEncoder

protected abstract OutputStream getOutputStreamForCellEncoder()