com.comcast.oscar.configurationfile

Class ConfigurationFileExport

java.lang.Object

com.comcast.oscar.configurationfile.ConfigurationFileExport

public class ConfigurationFileExport
extends java.lang.Object

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	DOCSIS_PKTCBL
static java.lang.Integer	DOCSIS_VER_10
static java.lang.Integer	DOCSIS_VER_11
static java.lang.Integer	DOCSIS_VER_20
static java.lang.Integer	DOCSIS_VER_30
static java.lang.Integer	DOCSIS_VER_31
static java.lang.Integer	DPOE_VER_10
static java.lang.Integer	DPOE_VER_20
java.lang.String	END_OF_CODE_BLOCK
static java.lang.Boolean	EXPORT_DEFAULT_TLV
static java.lang.Boolean	EXPORT_FOUND_TLV
static java.lang.Integer	PKT_CBL_VER_10
static java.lang.Integer	PKT_CBL_VER_15
static java.lang.Integer	PKT_CBL_VER_20

Constructor Summary

Constructors

Constructor and Description
ConfigurationFileExport(ConfigurationFile cfConfigurationFile)
ConfigurationFileExport(java.io.File fTLV) Deprecated. - This is no longer supported but will work Only support DOCSIS and PacketCable
ConfigurationFileExport(java.io.File fTLV, int iConfigurationFileType)
ConfigurationFileExport(int iConfigurationFileType) This will only produce the Full Default Configuration Options
ConfigurationFileExport(TlvBuilder tbTLV) Deprecated. - This is no longer supported but will work Only support DOCSIS and PacketCable
ConfigurationFileExport(TlvBuilder tbTLV, boolean boolStripFinalize) Deprecated. - This is no longer supported but will work Only support DOCSIS and PacketCable
ConfigurationFileExport(TlvBuilder tbTLV, int iConfigurationFileType)

Method Summary

Methods

Modifier and Type	Method and Description
int	getConfigurationFileType()
TlvBuilder	getTlvBuilder()
java.lang.String	getTlvDefintion(java.lang.String sTlvDotNotation) Example: TLV Dot Notation: 25.1.2
org.json.JSONArray	getTopLevelTLVJSON(int iTlvType)
void	setExportVerbose(boolean boolVerboseExport) Deprecated.
java.util.Map<java.lang.Integer,java.lang.String>	toHex()
java.lang.String	toPrettyPrint(boolean boolIncludeDefaultTLV)
java.lang.String	toPrettyPrint(int iIndentation) Deprecated.
boolean	writeToDisk(java.io.File fOutput)

Methods inherited from class java.lang.Object

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

Field Detail

END_OF_CODE_BLOCK

public final java.lang.String END_OF_CODE_BLOCK

See Also:

Constant Field Values

DOCSIS_PKTCBL

public static final java.lang.Integer DOCSIS_PKTCBL

DOCSIS_VER_10

public static final java.lang.Integer DOCSIS_VER_10

DOCSIS_VER_11

public static final java.lang.Integer DOCSIS_VER_11

DOCSIS_VER_20

public static final java.lang.Integer DOCSIS_VER_20

DOCSIS_VER_30

public static final java.lang.Integer DOCSIS_VER_30

DOCSIS_VER_31

public static final java.lang.Integer DOCSIS_VER_31

PKT_CBL_VER_10

public static final java.lang.Integer PKT_CBL_VER_10

PKT_CBL_VER_15

public static final java.lang.Integer PKT_CBL_VER_15

PKT_CBL_VER_20

public static final java.lang.Integer PKT_CBL_VER_20

DPOE_VER_10

public static final java.lang.Integer DPOE_VER_10

DPOE_VER_20

public static final java.lang.Integer DPOE_VER_20

EXPORT_DEFAULT_TLV

public static final java.lang.Boolean EXPORT_DEFAULT_TLV

EXPORT_FOUND_TLV

public static final java.lang.Boolean EXPORT_FOUND_TLV

Constructor Detail

ConfigurationFileExport

public ConfigurationFileExport(java.io.File fTLV)

Deprecated. - This is no longer supported but will work Only support DOCSIS and PacketCable

Parameters:

fTLV - - Configuration File - Only support DOCSIS and PacketCable

ConfigurationFileExport

public ConfigurationFileExport(java.io.File fTLV,
                       int iConfigurationFileType)

Parameters:

fTLV - - Will Support all Configuration file Types: DOCSIS, PacketCable and DPoE

iConfigurationFileType - - Set Configuration Type via Static FIELDS

ConfigurationFileExport

public ConfigurationFileExport(TlvBuilder tbTLV)

Deprecated. - This is no longer supported but will work Only support DOCSIS and PacketCable

This constructor checks the first Byte to determine if it is a Packet Cable File or DOCSIS File Byte = 0xFE = Packet Cable

Parameters:

tbTLV - - Will ONLY Support Configuration file Types: DOCSIS and PacketCable

ConfigurationFileExport

public ConfigurationFileExport(TlvBuilder tbTLV,
                       int iConfigurationFileType)

Parameters:

tbTLV -

iConfigurationFileType -

ConfigurationFileExport

public ConfigurationFileExport(TlvBuilder tbTLV,
                       boolean boolStripFinalize)

Deprecated. - This is no longer supported but will work Only support DOCSIS and PacketCable

Parameters:

tbTLV -

boolStripFinalize - boolean

ConfigurationFileExport

public ConfigurationFileExport(ConfigurationFile cfConfigurationFile)

Parameters:

cfConfigurationFile - - Will Support all Configuration file Types: DOCSIS, PacketCable and DPoE

ConfigurationFileExport

public ConfigurationFileExport(int iConfigurationFileType)

This will only produce the Full Default Configuration Options

Parameters:

iConfigurationFileType - - Will Support all Configuration file Types: DOCSIS, PacketCable and DPoE - Set Configuration Type via Static FIELD

Method Detail

toPrettyPrint

public java.lang.String toPrettyPrint(int iIndentation)

Deprecated.

Parameters:

iIndentation -

Returns:

String

Since:

v1.0.1

toPrettyPrint

public java.lang.String toPrettyPrint(boolean boolIncludeDefaultTLV)

Parameters:

boolIncludeDefaultTLV - = True == will include default TLV if no value is found

Returns:

String of the Compiled Configuration File

toHex

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

Returns:

Map

getTlvBuilder

public TlvBuilder getTlvBuilder()
                         throws TlvException

Returns:

TlvBuilder

Throws:

TlvException

getTlvDefintion

public java.lang.String getTlvDefintion(java.lang.String sTlvDotNotation)

Example: TLV Dot Notation: 25.1.2

Parameters:

sTlvDotNotation -

Returns:

String

getTopLevelTLVJSON

public org.json.JSONArray getTopLevelTLVJSON(int iTlvType)

Parameters:

iTlvType -

Returns:

JSONArray

writeToDisk

public boolean writeToDisk(java.io.File fOutput)

Parameters:

fOutput -

Returns:

true is write, false is it did not write

getConfigurationFileType

public int getConfigurationFileType()

Returns:

the ConfigurationFile Type per the ConfigurationFile() field statics

setExportVerbose

public void setExportVerbose(boolean boolVerboseExport)

Deprecated.

DEFAULT = true;

Parameters:

boolVerboseExport -