org.thales.punch.netty.impl

Class NettyLumberjackEncoder

java.lang.Object

org.thales.punch.netty.impl.NettyLumberjackEncoder

public class NettyLumberjackEncoder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.logging.log4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
NettyLumberjackEncoder(boolean compression)

Method Summary

Modifier and Type	Method and Description
void	addDataToFrame(String key, String value, io.netty.buffer.ByteBuf buffer)
void	addSizeToFrame(int size, io.netty.buffer.ByteBuf buffer)
io.netty.buffer.ByteBuf	endDataFrame(io.netty.buffer.ByteBuf buffer)
String	getCharset()
byte[]	getFrame(io.netty.buffer.ByteBuf dataFrame) Convert one lumberjack frame to an encoded byte array
byte[]	getFrame(io.netty.buffer.ByteBuf[] dataFrames, int frameCount) Deprecated.
static io.netty.buffer.ByteBuf	prepareAckFrame(int sequenceNumber, byte version) Allocate and create a new ack frame with the corresponding sequence number
io.netty.buffer.ByteBuf	prepareCompressFrame(io.netty.buffer.ByteBuf dataFrame) If compression is enable return a compressed frame.
io.netty.buffer.ByteBuf	prepareCompressFrame(io.netty.buffer.ByteBuf[] dataFrames) Get a compressed frame out a several data frame.
io.netty.buffer.ByteBuf	prepareDataFrame(Map<String,String> dataMap, int sequenceNumber)
io.netty.buffer.ByteBuf	prepareDataFrame(String value, int sequenceNumber)
static io.netty.buffer.ByteBuf	prepareKeepAliveFrame()
void	startDataFrame(int seqnum, io.netty.buffer.ByteBuf buffer)
static byte[]	toByteArray(io.netty.buffer.ByteBuf buf) Convert a ByteBuf to a byte array.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static org.apache.logging.log4j.Logger LOG

Constructor Detail

NettyLumberjackEncoder

public NettyLumberjackEncoder(boolean compression)

Parameters:

compression - true or false to enable lumberjack compression

Method Detail

prepareCompressFrame

public io.netty.buffer.ByteBuf prepareCompressFrame(io.netty.buffer.ByteBuf dataFrame)

If compression is enable return a compressed frame. Otherwise it simply returns the input dataFrame.

Parameters:

dataFrame - the input frame

Returns:

the resulting frame

toByteArray

public static byte[] toByteArray(io.netty.buffer.ByteBuf buf)

Convert a ByteBuf to a byte array. This method allocate a new byte array, and data are copied from the ByteBuf to that array.

Parameters:

buf -

Returns:

the corresponding byte array

getFrame

public byte[] getFrame(io.netty.buffer.ByteBuf dataFrame)

Convert one lumberjack frame to an encoded byte array

Parameters:

dataFrame - the input lumberjack frame

Returns:

the encoded byte array

getFrame

@Deprecated
public byte[] getFrame(io.netty.buffer.ByteBuf[] dataFrames,
                                   int frameCount)

Deprecated.

Get a frame out a several data frame. If compression is enabled you'll get a compressed frame. This variantr returns a ready to be used byte buffer.

WATCH OUT : the returned ByteBuf can be empty, in case you give an array of

Parameters:

dataFrames - the input data lumberjack frames

frameCount - the number of frames in the array

Returns:

the encoded byte array

prepareCompressFrame

public io.netty.buffer.ByteBuf prepareCompressFrame(io.netty.buffer.ByteBuf[] dataFrames)

Get a compressed frame out a several data frame.

WATCH OUT : the returned ByteBuf can be empty, in case you give an array of

Parameters:

dataFrames - the input data lumberjack frames

Returns:

the encoded byte array

prepareAckFrame

public static io.netty.buffer.ByteBuf prepareAckFrame(int sequenceNumber,
                                                      byte version)

Allocate and create a new ack frame with the corresponding sequence number

Parameters:

sequenceNumber -

version - the version number

Returns:

the ready to use ack frame

prepareDataFrame

public io.netty.buffer.ByteBuf prepareDataFrame(String value,
                                                int sequenceNumber)
                                         throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

prepareKeepAliveFrame

public static io.netty.buffer.ByteBuf prepareKeepAliveFrame()

Returns:

a ready to use keep alive lumberjack frame.

prepareDataFrame

public io.netty.buffer.ByteBuf prepareDataFrame(Map<String,String> dataMap,
                                                int sequenceNumber)
                                         throws UnsupportedEncodingException

Parameters:

dataMap - the input map representing the document to send

sequenceNumber - the frame sequence number

Returns:

a lumberjack binary data frame

Throws:

UnsupportedEncodingException

startDataFrame

public void startDataFrame(int seqnum,
                           io.netty.buffer.ByteBuf buffer)

addSizeToFrame

public void addSizeToFrame(int size,
                           io.netty.buffer.ByteBuf buffer)

addDataToFrame

public void addDataToFrame(String key,
                           String value,
                           io.netty.buffer.ByteBuf buffer)
                    throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

endDataFrame

public io.netty.buffer.ByteBuf endDataFrame(io.netty.buffer.ByteBuf buffer)

getCharset

public String getCharset()

Returns:

the charset used to decode strings