org.thales.punch.libraries.commons.netty.codec

Class NettyNetflowEncoder

java.lang.Object

org.thales.punch.libraries.commons.netty.codec.NettyNetflowEncoder

public class NettyNetflowEncoder
extends Object

This encoder is useful to send test netflow frames. It supports Netflow v5 and v9 format.

Author:

dimi

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
NettyNetflowEncoder()

Method Summary

Modifier and Type	Method and Description
NettyNetflowEncoder	encodev5Header(Map<String,Object> header) Encode a Netflow v5 Header
NettyNetflowEncoder	encodev5Record(Map<String,Object> record) Add a Netflow v5 record.
NettyNetflowEncoder	encodev9Data(int templateId, int length) Encode a v9 template flowset.
NettyNetflowEncoder	encodev9DataByte(int v)
NettyNetflowEncoder	encodev9DataInt(int v)
NettyNetflowEncoder	encodev9DataInt24(int v)
NettyNetflowEncoder	encodev9DataIpv6(String v)
NettyNetflowEncoder	encodev9DataMac(String v)
NettyNetflowEncoder	encodev9DataShort(int v)
NettyNetflowEncoder	encodev9DataString(String v)
NettyNetflowEncoder	encodev9Header(Map<String,Object> header) Encode a Netflow v5 Header
NettyNetflowEncoder	encodev9Option(int templateId, int scopeLength, int options) Encode a v9 template flowset.
NettyNetflowEncoder	encodev9OptionField(int fieldType)
NettyNetflowEncoder	encodev9OptionField(int fieldType, int fieldLength)
NettyNetflowEncoder	encodev9OptionScopeField(int fieldType, int fieldLength)
NettyNetflowEncoder	encodev9Padding(int length)
NettyNetflowEncoder	encodev9Template(int templateId, int fieldCount)
NettyNetflowEncoder	encodev9TemplateField(int fieldType) Encode a template field, using the default length as defined in the Netflow field standard.
NettyNetflowEncoder	encodev9TemplateField(int fieldType, int fieldLength) Encode a template field, using the default length as defined in the Netflow field standard.
byte[]	getBytes() Get the complete Netflow payload as 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

NettyNetflowEncoder

public NettyNetflowEncoder()

Method Detail

encodev5Header

public NettyNetflowEncoder encodev5Header(Map<String,Object> header)

Encode a Netflow v5 Header

Parameters:

header - the header as a map.

Returns:

this encoder

encodev5Record

public NettyNetflowEncoder encodev5Record(Map<String,Object> record)

Add a Netflow v5 record. If you call several time you must have add the right number of record in the header "flow_records" field.

Parameters:

record - the record as a map.

Returns:

this encoder

encodev9Header

public NettyNetflowEncoder encodev9Header(Map<String,Object> header)

Encode a Netflow v5 Header

Parameters:

header - the header as a map.

Returns:

this encoder

encodev9Option

public NettyNetflowEncoder encodev9Option(int templateId,
                                          int scopeLength,
                                          int options)

Encode a v9 template flowset. This one must be followed by fieldCount calls to encodev9TemplateField

Parameters:

templateId -

scopeLength -

options -

Returns:

the test encoder

encodev9Template

public NettyNetflowEncoder encodev9Template(int templateId,
                                            int fieldCount)

Parameters:

templateId -

fieldCount -

Returns:

the test encoder

encodev9OptionScopeField

public NettyNetflowEncoder encodev9OptionScopeField(int fieldType,
                                                    int fieldLength)

encodev9OptionField

public NettyNetflowEncoder encodev9OptionField(int fieldType,
                                               int fieldLength)

encodev9OptionField

public NettyNetflowEncoder encodev9OptionField(int fieldType)

encodev9TemplateField

public NettyNetflowEncoder encodev9TemplateField(int fieldType,
                                                 int fieldLength)

Encode a template field, using the default length as defined in the Netflow field standard.

Parameters:

fieldType - the field index

fieldLength - the associated length

Returns:

the netty encoder

encodev9TemplateField

public NettyNetflowEncoder encodev9TemplateField(int fieldType)

Encode a template field, using the default length as defined in the Netflow field standard.

Parameters:

fieldType - the field index

Returns:

this encoder

encodev9Data

public NettyNetflowEncoder encodev9Data(int templateId,
                                        int length)

Encode a v9 template flowset.

Parameters:

templateId - the template id

length - is the total length of values. A padding will be added to round up to 32 bits.

Returns:

the test encoder

encodev9Padding

public NettyNetflowEncoder encodev9Padding(int length)

encodev9DataByte

public NettyNetflowEncoder encodev9DataByte(int v)

encodev9DataString

public NettyNetflowEncoder encodev9DataString(String v)

encodev9DataShort

public NettyNetflowEncoder encodev9DataShort(int v)

encodev9DataInt24

public NettyNetflowEncoder encodev9DataInt24(int v)

encodev9DataInt

public NettyNetflowEncoder encodev9DataInt(int v)

encodev9DataMac

public NettyNetflowEncoder encodev9DataMac(String v)

encodev9DataIpv6

public NettyNetflowEncoder encodev9DataIpv6(String v)
                                     throws UnknownHostException

Throws:

UnknownHostException

getBytes

public byte[] getBytes()

Get the complete Netflow payload as a byte array

Returns:

the byte array