org.apache.nifi.processors.beats.frame

Class BeatsDecoder

java.lang.Object

org.apache.nifi.processors.beats.frame.BeatsDecoder

public class BeatsDecoder
extends Object

Decodes a Beats frame by maintaining a state based on each byte that has been processed. This class should not be shared by multiple threads.

Field Summary

Fields

Modifier and Type	Field and Description
private Charset	charset
(package private) static int	COMPRESSED_MIN_LENGTH
private ByteArrayOutputStream	currBytes
private BeatsState	currState
private byte	decodedFrameType
private BeatsFrame.Builder	frameBuilder
(package private) static int	JSON_MIN_LENGTH
(package private) ComponentLog	logger
(package private) static int	MIN_FRAME_HEADER_LENGTH
private byte[]	unprocessedData
private long	windowSize
(package private) static int	WINDOWSIZE_LENGTH

Constructor Summary

Constructors

Constructor and Description
BeatsDecoder(Charset charset, ByteArrayOutputStream buffer, ComponentLog logger)
BeatsDecoder(Charset charset, ComponentLog logger)

Method Summary

Modifier and Type	Method and Description
List<BeatsFrame>	getFrames() Returns the decoded frame and resets the decoder for the next frame.
boolean	process(byte currByte) Process the next byte from the channel, updating the builder and state accordingly.
private void	processFRAMETYPE(byte b)
private void	processPAYLOAD(byte b) Process the outer PAYLOAD byte by byte.
private void	processVERSION(byte b)
void	reset() Resets this decoder back to its initial state.
private List<BeatsFrame>	splitCompressedFrames(byte[] decompressedData)

Methods inherited from class java.lang.Object

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

Field Detail

logger

final ComponentLog logger

frameBuilder

private BeatsFrame.Builder frameBuilder

currState

private BeatsState currState

decodedFrameType

private byte decodedFrameType

unprocessedData

private byte[] unprocessedData

charset

private final Charset charset

currBytes

private final ByteArrayOutputStream currBytes

windowSize

private long windowSize

MIN_FRAME_HEADER_LENGTH

static final int MIN_FRAME_HEADER_LENGTH

See Also:

Constant Field Values

WINDOWSIZE_LENGTH

static final int WINDOWSIZE_LENGTH

See Also:

Constant Field Values

COMPRESSED_MIN_LENGTH

static final int COMPRESSED_MIN_LENGTH

See Also:

Constant Field Values

JSON_MIN_LENGTH

static final int JSON_MIN_LENGTH

See Also:

Constant Field Values

Constructor Detail

BeatsDecoder

public BeatsDecoder(Charset charset,
                    ComponentLog logger)

Parameters:

charset - the charset to decode bytes from the frame

BeatsDecoder

public BeatsDecoder(Charset charset,
                    ByteArrayOutputStream buffer,
                    ComponentLog logger)

Parameters:

charset - the charset to decode bytes from the frame

buffer - a buffer to use while processing the bytes

Method Detail

reset

public void reset()

Resets this decoder back to its initial state.

process

public boolean process(byte currByte)
                throws BeatsFrameException

Process the next byte from the channel, updating the builder and state accordingly.

Parameters:

currByte - the next byte to process

Throws:

BeatsFrameException

getFrames

public List<BeatsFrame> getFrames()
                           throws BeatsFrameException

Returns the decoded frame and resets the decoder for the next frame. This method should be called after checking isComplete().

Returns:

the BeatsFrame that was decoded

Throws:

BeatsFrameException

splitCompressedFrames

private List<BeatsFrame> splitCompressedFrames(byte[] decompressedData)

processVERSION

private void processVERSION(byte b)

processFRAMETYPE

private void processFRAMETYPE(byte b)

processPAYLOAD

private void processPAYLOAD(byte b)

Process the outer PAYLOAD byte by byte. Once data is read state is set to COMPLETE so that the data payload can be processed fully using splitCompressedFrames(byte[])