com.comcast.oscar.tlv

Class TlvBuilder

java.lang.Object

com.comcast.oscar.tlv.TlvBuilder

All Implemented Interfaces:

TlvBuild

Direct Known Subclasses:

DocsisCompiler, PacketCableCompiler, TlvAssembler

public class TlvBuilder
extends java.lang.Object
implements TlvBuild

Author:

Maurice Garcia (maurice.garcia.2015@gmail.com)

Field Summary

Fields

Modifier and Type	Field and Description
static int	END_OF_BYTE_ARRAY_INDEX
static int	MAX_TLV_LENGTH
static byte	TLV_LENGTH_POS_OFFSET
static byte	TLV_ONE_BYTE_LENGTH
static byte	TLV_TYPE_LENGTH_OVERHEAD
static byte	TLV_TYPE_OVERHEAD

Fields inherited from interface com.comcast.oscar.tlv.TlvBuild

bTlvBuilder, miiTypeBytelength

Constructor Summary

Constructors

Constructor and Description
TlvBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(ConfigurationFileImport cfi)
void	add(HexString hsObject) This method assumes that each Type is of 1 byte Length
void	add(int iTlvType, byte[] bValue) Method add.
void	add(int iTlvType, byte[] bValue, boolean booleanStripExistingTlv)
void	add(int iTlvType, HexString hsValue)
void	add(int iTlvType, java.lang.Integer iValue)
void	add(int iSnmpTlvType, org.snmp4j.smi.OID oObjectID, byte bBerDataType, byte[] bValue)
void	add(int iSnmpTlvType, org.snmp4j.smi.OID oObjectID, byte bBerDataType, long lNumber)
void	add(int iSnmpTlvType, org.snmp4j.smi.OID oObjectID, byte bBerDataType, java.lang.String sValue)
void	add(TlvBuilder tbObject)
void	add(TlvVariableBinding tvbObject) This option is used when TLVs are greater than 1 byte Length or a length of 254 bytes
void	clear()
TlvBuilder	clone()
java.util.List<java.lang.String>	cloneTlvBuffer()
static byte[]	coupleMultipleTopLevelTlvValues(TlvBuilder tbTLV) This method take a multiple single byte length TLV, strip the TopLevel TLV byte and length and concatenate all the values
void	encapsulateTlv(int iTlvType)
static byte[]	encapsulateTlv(int iTlvType, byte[] baValue)
void	encapsulateTlv(int iTlvType, int iLength)
static byte[]	fetchTlv(java.util.List<java.lang.Integer> liType, byte[] bTlvByteArray)
static byte[]	fetchTlv(java.util.List<java.lang.Integer> liType, java.util.Map<java.lang.Integer,java.lang.Integer> _miiTypeByteLength, byte[] bTlvByteArray) If a Type to Byte Length is not defined, this method assumes that the type is of 1 byte Length
static byte[]	findTLVIndex(byte[] bTlvBuffer, byte[] bParentChildTlvEncodeList)
static byte[]	findTLVIndex(byte[] bTlvBuffer, byte[] bParentChildTlvEncodeList, java.util.Map<java.lang.Integer,java.lang.Integer> miiTypeByteLength)
static int	findTLVIndex(byte[] bTlvBuffer, int iType)
HexString	getHexString()
java.util.Map<java.lang.Integer,java.lang.Integer>	getMapTypeToByteLength() Method getMapTypeToByteLength.
static java.util.List<byte[]>	getTlvHexByType(byte[] bTLV) This method assumes all TopLevel TLV are 1 Byte Length
static java.util.List<byte[]>	getTlvHexByType(byte[] bTLV, java.util.Map<java.lang.Integer,java.lang.Integer> miiTypeToByteLength)
static int	getTlvLength(byte[] bTlvBuffer, int iInitalPosition, int iByteLength)
static byte[]	getTlvValue(byte[] bTlvBuffer)
static byte[]	getTlvValue(byte[] bTlvBuffer, int iInitalPosition)
static byte[]	getTlvValue(byte[] bTlvBuffer, int iInitalPosition, int iByteLength)
java.util.List<java.lang.Integer>	getTopLevelTlvList() Method getTopLevelTlvList.
java.util.List<java.lang.Integer>	getTopLevelTlvList(java.util.Map<java.lang.Integer,java.lang.Integer> miiTypeByteLength) Method getTopLevelTlvList.
java.lang.Boolean	isEmpty() Method isEmpty.
boolean	isTLVConstruct()
static boolean	isTLVConstruct(byte[] bTLV, java.util.Map<java.lang.Integer,java.lang.Integer> miiTlvTypeTpByteLength)
int	length()
static int	nextTLVIndex(byte[] bTlvBuffer, int iInitalPosition)
static int	nextTLVIndex(byte[] bTlvBuffer, int iInitalPosition, int iByteLength)
static TlvBuilder	reorderTLV(boolean booDirection, TlvBuilder tb)
java.util.List<byte[]>	sortByTopLevelTlv()
java.util.List<byte[]>	sortByTopLevelTlv(java.util.Map<java.lang.Integer,java.lang.Integer> miiTopLevelTLVByteLength) Unless specified in the Map, this method assumes each TopLevel is 1 byte of length
static byte[]	stripTlv(int iType, byte[] bTlvByteArray) This method assumes each type has a 1 byte length encoding
static byte[]	stripTlv(int iType, byte[] bTlvByteArray, java.util.Map<java.lang.Integer,java.lang.Integer> miiTypeToByteLength)
static byte[]	stripZeroByteTLV(byte[] bTlvByteArray, java.util.Map<java.lang.Integer,java.lang.Integer> miiTypeToByteLength) This method will remove any TLV that contain a Zero Byte Length
static java.lang.String	tlvDump(byte[] ba)
byte[]	toByteArray() Method toByteArray.
static java.util.List<HexString>	topLevelTlvToHexStringList(byte[] baTlv, java.util.Map<java.lang.Integer,java.lang.Integer> miiTypeToByteLength)
java.lang.String	toString()
java.lang.String	toStringArray()
java.lang.String	toStringSeperation(java.lang.String sSeperation)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TLV_LENGTH_POS_OFFSET

public static final byte TLV_LENGTH_POS_OFFSET

See Also:

Constant Field Values

TLV_TYPE_OVERHEAD

public static final byte TLV_TYPE_OVERHEAD

See Also:

Constant Field Values

TLV_TYPE_LENGTH_OVERHEAD

public static final byte TLV_TYPE_LENGTH_OVERHEAD

See Also:

Constant Field Values

MAX_TLV_LENGTH

public static final int MAX_TLV_LENGTH

See Also:

Constant Field Values

END_OF_BYTE_ARRAY_INDEX

public static final int END_OF_BYTE_ARRAY_INDEX

See Also:

Constant Field Values

TLV_ONE_BYTE_LENGTH

public static final byte TLV_ONE_BYTE_LENGTH

See Also:

Constant Field Values

Constructor Detail

TlvBuilder

public TlvBuilder()

Method Detail

add

public void add(ConfigurationFileImport cfi)

Parameters:

cfi -

add

public void add(HexString hsObject)
         throws TlvException

This method assumes that each Type is of 1 byte Length

Parameters:

hsObject -

Throws:

TlvException

add

public void add(int iTlvType,
       java.lang.Integer iValue)
         throws TlvException

Parameters:

iTlvType -

iValue -

Throws:

TlvException

add

public void add(int iTlvType,
       HexString hsValue)
         throws TlvException

Parameters:

iTlvType -

hsValue -

Throws:

TlvException

add

public void add(TlvBuilder tbObject)

Parameters:

tbObject -

reorderTLV

public static TlvBuilder reorderTLV(boolean booDirection,
                    TlvBuilder tb)
                             throws TlvException

Parameters:

booDirection -

tb -

Returns:

TlvBuilder

Throws:

TlvException

add

public void add(int iTlvType,
       byte[] bValue)
         throws TlvException

Description copied from interface: TlvBuild

Method add.

Specified by:

add in interface TlvBuild

Parameters:

iTlvType -

bValue -

Throws:

TlvException - * @see com.comcast.oscar.tlv.TlvBuild#add(int, byte[])

add

public void add(int iTlvType,
       byte[] bValue,
       boolean booleanStripExistingTlv)
         throws TlvException

Parameters:

iTlvType -

bValue -

booleanStripExistingTlv - = True = Strip Existing TLV ; False = Do Not Strip TLV

Throws:

TlvException

add

public void add(int iSnmpTlvType,
       org.snmp4j.smi.OID oObjectID,
       byte bBerDataType,
       long lNumber)

Parameters:

iSnmpTlvType -

oObjectID -

bBerDataType -

lNumber -

add

public void add(int iSnmpTlvType,
       org.snmp4j.smi.OID oObjectID,
       byte bBerDataType,
       java.lang.String sValue)

Parameters:

iSnmpTlvType -

oObjectID -

bBerDataType -

sValue -

add

public void add(int iSnmpTlvType,
       org.snmp4j.smi.OID oObjectID,
       byte bBerDataType,
       byte[] bValue)

Parameters:

iSnmpTlvType -

oObjectID -

bBerDataType -

bValue -

add

public void add(TlvVariableBinding tvbObject)

This option is used when TLVs are greater than 1 byte Length or a length of 254 bytes

Parameters:

tvbObject -

toStringArray

public java.lang.String toStringArray()

Returns:

String

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

String

toStringSeperation

public java.lang.String toStringSeperation(java.lang.String sSeperation)

Parameters:

sSeperation -

Returns:

String

length

public int length()

Returns:

int

encapsulateTlv

public void encapsulateTlv(int iTlvType)
                    throws TlvException

Parameters:

iTlvType -

Throws:

TlvException

encapsulateTlv

public void encapsulateTlv(int iTlvType,
                  int iLength)
                    throws TlvException

Parameters:

iTlvType -

iLength -

Throws:

TlvException

clear

public void clear()

Specified by:

clear in interface TlvBuild

See Also:

TlvBuild.clear()

toByteArray

public byte[] toByteArray()

Description copied from interface: TlvBuild

Method toByteArray.

Specified by:

toByteArray in interface TlvBuild

Returns:

TLV in a byte array * @see com.comcast.oscar.tlv.TlvBuild#toByteArray()

getTopLevelTlvList

public java.util.List<java.lang.Integer> getTopLevelTlvList()

Description copied from interface: TlvBuild

Method getTopLevelTlvList.

Specified by:

getTopLevelTlvList in interface TlvBuild

Returns:

a list of TopLevel TLV * @see com.comcast.oscar.tlv.TlvBuild#getTopLevelTlvList()

getTopLevelTlvList

public java.util.List<java.lang.Integer> getTopLevelTlvList(java.util.Map<java.lang.Integer,java.lang.Integer> miiTypeByteLength)

Description copied from interface: TlvBuild

Method getTopLevelTlvList.

Specified by:

getTopLevelTlvList in interface TlvBuild

Parameters:

miiTypeByteLength -

Returns:

List

See Also:

com.comcast.oscar.tlv.TlvBuild#getTopLevelTlvList(Map)

cloneTlvBuffer

public java.util.List<java.lang.String> cloneTlvBuffer()

Returns:

a Clone of the TLV Buffer

clone

public TlvBuilder clone()

Overrides:

clone in class java.lang.Object

Returns:

This method returns a TlvBuild of the bytes contained

sortByTopLevelTlv

public java.util.List<byte[]> sortByTopLevelTlv()

Returns:

List

sortByTopLevelTlv

public java.util.List<byte[]> sortByTopLevelTlv(java.util.Map<java.lang.Integer,java.lang.Integer> miiTopLevelTLVByteLength)

Unless specified in the Map, this method assumes each TopLevel is 1 byte of length

Parameters:

miiTopLevelTLVByteLength -

Returns:

list of TLV Bytes

getMapTypeToByteLength

public java.util.Map<java.lang.Integer,java.lang.Integer> getMapTypeToByteLength()

Description copied from interface: TlvBuild

Method getMapTypeToByteLength.

Specified by:

getMapTypeToByteLength in interface TlvBuild

Returns:

Map

See Also:

TlvBuild.getMapTypeToByteLength()

isEmpty

public java.lang.Boolean isEmpty()

Description copied from interface: TlvBuild

Method isEmpty.

Specified by:

isEmpty in interface TlvBuild

Returns:

Boolean

See Also:

TlvBuild.isEmpty()

getHexString

public HexString getHexString()

Returns:

HexString

topLevelTlvToHexStringList

public static java.util.List<HexString> topLevelTlvToHexStringList(byte[] baTlv,
                                                   java.util.Map<java.lang.Integer,java.lang.Integer> miiTypeToByteLength)

Parameters:

baTlv -

miiTypeToByteLength -

Returns:

list of TLVs in Groups of TopLevel TLV

stripTlv

public static byte[] stripTlv(int iType,
              byte[] bTlvByteArray)
                       throws TlvException

This method assumes each type has a 1 byte length encoding

Parameters:

iType -

bTlvByteArray -

Returns:

byte[]

Throws:

TlvException

stripTlv

public static byte[] stripTlv(int iType,
              byte[] bTlvByteArray,
              java.util.Map<java.lang.Integer,java.lang.Integer> miiTypeToByteLength)
                       throws TlvException

Parameters:

iType -

bTlvByteArray -

miiTypeToByteLength -

Returns:

byte[]

Throws:

TlvException

fetchTlv

public static byte[] fetchTlv(java.util.List<java.lang.Integer> liType,
              byte[] bTlvByteArray)

Parameters:

liType -

bTlvByteArray -

Returns:

byte[]

fetchTlv

public static byte[] fetchTlv(java.util.List<java.lang.Integer> liType,
              java.util.Map<java.lang.Integer,java.lang.Integer> _miiTypeByteLength,
              byte[] bTlvByteArray)

If a Type to Byte Length is not defined, this method assumes that the type is of 1 byte Length

Parameters:

liType -

bTlvByteArray -

_miiTypeByteLength - Map

Returns:

byte[]

nextTLVIndex

public static int nextTLVIndex(byte[] bTlvBuffer,
               int iInitalPosition)
                        throws TlvException

Parameters:

bTlvBuffer -

iInitalPosition -

Returns:

-1 = End of ByteArray Index * @throws TlvException

Throws:

TlvException

nextTLVIndex

public static int nextTLVIndex(byte[] bTlvBuffer,
               int iInitalPosition,
               int iByteLength)
                        throws TlvException

Parameters:

bTlvBuffer -

iInitalPosition -

iByteLength -

Returns:

int

Throws:

TlvException

findTLVIndex

public static byte[] findTLVIndex(byte[] bTlvBuffer,
                  byte[] bParentChildTlvEncodeList)
                           throws TlvException

Parameters:

bTlvBuffer -

bParentChildTlvEncodeList -

Returns:

byte[]

Throws:

TlvException

findTLVIndex

public static int findTLVIndex(byte[] bTlvBuffer,
               int iType)
                        throws TlvException

Parameters:

bTlvBuffer -

iType -

Returns:

the index where the Type is found * @throws TlvException

Throws:

TlvException

findTLVIndex

public static byte[] findTLVIndex(byte[] bTlvBuffer,
                  byte[] bParentChildTlvEncodeList,
                  java.util.Map<java.lang.Integer,java.lang.Integer> miiTypeByteLength)
                           throws TlvException

Parameters:

bTlvBuffer -

bParentChildTlvEncodeList -

miiTypeByteLength -

Returns:

byte[]

Throws:

TlvException

getTlvValue

public static byte[] getTlvValue(byte[] bTlvBuffer)
                          throws TlvException

Parameters:

bTlvBuffer -

Returns:

byte[]

Throws:

TlvException

getTlvValue

public static byte[] getTlvValue(byte[] bTlvBuffer,
                 int iInitalPosition)
                          throws TlvException

Parameters:

bTlvBuffer -

iInitalPosition -

Returns:

byte[]

Throws:

TlvException

getTlvValue

public static byte[] getTlvValue(byte[] bTlvBuffer,
                 int iInitalPosition,
                 int iByteLength)
                          throws TlvException

Parameters:

bTlvBuffer -

iInitalPosition -

iByteLength -

Returns:

byte[]

Throws:

TlvException

getTlvLength

public static int getTlvLength(byte[] bTlvBuffer,
               int iInitalPosition,
               int iByteLength)
                        throws TlvException

Parameters:

bTlvBuffer -

iInitalPosition -

iByteLength -

Returns:

int

Throws:

TlvException

coupleMultipleTopLevelTlvValues

public static byte[] coupleMultipleTopLevelTlvValues(TlvBuilder tbTLV)

This method take a multiple single byte length TLV, strip the TopLevel TLV byte and length and concatenate all the values

Parameters:

tbTLV -

Returns:

byte[]

getTlvHexByType

public static java.util.List<byte[]> getTlvHexByType(byte[] bTLV)
                                              throws TlvException

This method assumes all TopLevel TLV are 1 Byte Length

Parameters:

bTLV -

Returns:

List

Throws:

TlvException

getTlvHexByType

public static java.util.List<byte[]> getTlvHexByType(byte[] bTLV,
                                     java.util.Map<java.lang.Integer,java.lang.Integer> miiTypeToByteLength)
                                              throws TlvException

Parameters:

bTLV -

miiTypeToByteLength -

Returns:

List

Throws:

TlvException

isTLVConstruct

public boolean isTLVConstruct()

Returns:

boolean

isTLVConstruct

public static boolean isTLVConstruct(byte[] bTLV,
                     java.util.Map<java.lang.Integer,java.lang.Integer> miiTlvTypeTpByteLength)

Parameters:

bTLV -

miiTlvTypeTpByteLength -

Returns:

boolean

encapsulateTlv

public static byte[] encapsulateTlv(int iTlvType,
                    byte[] baValue)
                             throws TlvException

Parameters:

iTlvType -

baValue -

Returns:

byte[]

Throws:

TlvException

stripZeroByteTLV

public static byte[] stripZeroByteTLV(byte[] bTlvByteArray,
                      java.util.Map<java.lang.Integer,java.lang.Integer> miiTypeToByteLength)
                               throws TlvException

This method will remove any TLV that contain a Zero Byte Length

Parameters:

bTlvByteArray -

miiTypeToByteLength - Map

Returns:

byte[]

Throws:

TlvException

tlvDump

public static java.lang.String tlvDump(byte[] ba)

Parameters:

ba -

Returns:

- return in Hex TopLevel TLV Dump separated by newline