com.comcast.oscar.compiler

Class DocsisCompiler

java.lang.Object

com.comcast.oscar.tlv.TlvBuilder

com.comcast.oscar.compiler.DocsisCompiler

All Implemented Interfaces:

TlvBuild

Direct Known Subclasses:

DPoECompiler

public class DocsisCompiler
extends TlvBuilder

Author:

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

Field Summary

Fields inherited from class com.comcast.oscar.tlv.TlvBuilder

END_OF_BYTE_ARRAY_INDEX, MAX_TLV_LENGTH, TLV_LENGTH_POS_OFFSET, TLV_ONE_BYTE_LENGTH, TLV_TYPE_LENGTH_OVERHEAD, TLV_TYPE_OVERHEAD

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

bTlvBuilder, miiTypeBytelength

Constructor Summary

Constructors

Constructor and Description
DocsisCompiler(java.lang.Integer iDocsisVersion)
DocsisCompiler(java.lang.String sSharedSecretKey, java.lang.Integer iDocsisVersion)
DocsisCompiler(java.lang.String sSharedSecretKey, java.lang.Integer iDocsisVersion, int iExtCmtsHashTechnique, HexString hsTopLevelTlvBitMAsk)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkSpecification(java.lang.Boolean boolReportStdOut)
void	commit() When commit() is called this process will: + calculate the CM/CMTS MIC + Add EOF Marker + Add Null Pad so that the byte array is divisible by 4
byte[]	getCmMIC(byte[] bTlvArray)
int	getDocsisVersion()
void	setSharedSecretKey(java.lang.String sSharedSecretKey)
byte[]	toByteArray() Method toByteArray.
java.lang.String	toString()
java.lang.String	toString(java.lang.String sSeperation)

Methods inherited from class com.comcast.oscar.tlv.TlvBuilder

add, add, add, add, add, add, add, add, add, add, add, clear, clone, cloneTlvBuffer, coupleMultipleTopLevelTlvValues, encapsulateTlv, encapsulateTlv, encapsulateTlv, fetchTlv, fetchTlv, findTLVIndex, findTLVIndex, findTLVIndex, getHexString, getMapTypeToByteLength, getTlvHexByType, getTlvHexByType, getTlvLength, getTlvValue, getTlvValue, getTlvValue, getTopLevelTlvList, getTopLevelTlvList, isEmpty, isTLVConstruct, isTLVConstruct, length, nextTLVIndex, nextTLVIndex, reorderTLV, sortByTopLevelTlv, sortByTopLevelTlv, stripTlv, stripTlv, stripZeroByteTLV, tlvDump, topLevelTlvToHexStringList, toStringArray, toStringSeperation

Methods inherited from class java.lang.Object

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

Constructor Detail

DocsisCompiler

public DocsisCompiler(java.lang.Integer iDocsisVersion)

Parameters:

iDocsisVersion -

DocsisCompiler

public DocsisCompiler(java.lang.String sSharedSecretKey,
              java.lang.Integer iDocsisVersion)

Parameters:

sSharedSecretKey -

iDocsisVersion -

DocsisCompiler

public DocsisCompiler(java.lang.String sSharedSecretKey,
              java.lang.Integer iDocsisVersion,
              int iExtCmtsHashTechnique,
              HexString hsTopLevelTlvBitMAsk)

Parameters:

sSharedSecretKey - String

iDocsisVersion - Integer

iExtCmtsHashTechnique - int

hsTopLevelTlvBitMAsk - HexString

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class TlvBuilder

Returns:

String

toString

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

Parameters:

sSeperation -

Returns:

String

toByteArray

public byte[] toByteArray()

Description copied from interface: TlvBuild

Method toByteArray.

Specified by:

toByteArray in interface TlvBuild

Overrides:

toByteArray in class TlvBuilder

Returns:

returns byte array of the configuration file * @see com.comcast.oscar.tlv.TlvBuild#toByteArray()

getDocsisVersion

public int getDocsisVersion()

Returns:

DOCSIS Version

commit

public void commit()

When commit() is called this process will: + calculate the CM/CMTS MIC + Add EOF Marker + Add Null Pad so that the byte array is divisible by 4

checkSpecification

public boolean checkSpecification(java.lang.Boolean boolReportStdOut)

Parameters:

boolReportStdOut -

Returns:

boolean

setSharedSecretKey

public void setSharedSecretKey(java.lang.String sSharedSecretKey)

Parameters:

sSharedSecretKey -

getCmMIC

public byte[] getCmMIC(byte[] bTlvArray)

Parameters:

bTlvArray -

Returns:

the CM MIC HASH of the TLV Byte Array * @see D.1.3.1 CM MIC Calculation The CM message integrity check configuration setting MUST be calculated by performing an MD5 digest over the bytes of the configuration setting fields. It is calculated over the bytes of these settings as they appear in the TFTPed image, without regard to TLV ordering or contents. There are two TLVs which are not included in the CM MIC calculation: • The bytes of the CM MIC TLV itself are omitted from the calculation. This includes the type, length, and value fields; • The bytes of the CMTS MIC TLV are omitted from the calculation. This includes the type, length, and value fields. These TLVs are the last TLVs in the CM configuration file.