com.foxsmart.csu.config.global.mapclassframerelay
Class FrameRelayTrafficRateComponent

java.lang.Object
  com.foxsmart.csu.config.CiscoRouterConfigParser
      com.foxsmart.csu.config.CiscoRouterConfigComponent
          com.foxsmart.csu.config.global.mapclassframerelay.FrameRelayTrafficRateComponent

All Implemented Interfaces:

java.io.Serializable

public class FrameRelayTrafficRateComponent
extends CiscoRouterConfigComponent

The frame relay traffic rate class sets the VC traffic rate for frame relay.

See Also:

Serialized Form

Field Summary

static java.lang.String	FRAME_RELAY
static java.lang.Integer	MAX_CIR The maximum CIR.
static java.lang.Integer	MAX_PEAK_RATE The maximum Peak Rate.
static java.lang.Integer	MIN_CIR The minimum CIR.
static java.lang.Integer	MIN_PEAK_RATE The minimum Peak Rate.
static java.lang.String	TRAFFIC_RATE

Fields inherited from class com.foxsmart.csu.config.CiscoRouterConfigComponent

commentComponent, componentMap, log, parentComponent

Fields inherited from class com.foxsmart.csu.config.CiscoRouterConfigParser

NO, tokenIndex

Constructor Summary

FrameRelayTrafficRateComponent()
Constructs a frame relay traffic rate object.

Method Summary

java.util.List	buildFromIos(java.util.List configLines) Parse and populate the specific CiscoRouterComponent object based on the passed in individual lines of the IOS configuration.
Commands	generateIos() Returns the IOS configuration commands for this component.
java.lang.Integer	getCir() Gets the committed information rate (CIR).
java.lang.Integer	getPeakRate() Gets the peak rate.
void	setCir(java.lang.Integer cir) Sets the committed information rate (CIR).
void	setPeakRate(java.lang.Integer peakRate) Sets the peak rate (CIR + EIR).
void	validate() Validates this object to ensure it contains a valid IOS configuration.

Methods inherited from class com.foxsmart.csu.config.CiscoRouterConfigComponent

addComponent, addComponent, checkComponentType, deleteOldConfigWhenUpdating, dumpComponents, generateChildrenUpdateConfiglet, generateCompositeIos, generateCompositeIos, generateDeleteIos, generateIos, generateIos, generateIos, generateMultiLineUpdateConfiglet, generateUpdateCompositeIos, generateUpdateIos, generateUpdateIos, getAllComponents, getCiscoRouterConfig, getComment, getComponentClassName, getComponentClassName, getComponentKeys, getComponents, getComponents, getDeferredDelete, getFirstComponent, getFirstComponent, getParentComponent, getTotalComponents, getTotalComponents, getUpdateConfiglet, instantiateComponent, instantiateComponent, isValid, removeAllComponents, removeAllComponents, removeAllComponents, removeComponent, removeComponent, removeComponent, requiresCommentSeparator, setComment, setParentComponent, validateChildren

Methods inherited from class com.foxsmart.csu.config.CiscoRouterConfigParser

checkExists, checkLineComplete, checkNotEmpty, checkRange, checkTokenCount, checkTokenCount, checkTokenMatch, checkTokenMatch, decrementTokenIndex, generateCommands, getBigDecimalNumberFromString, getDoubleNumberFromString, getEnum, getHexadecimalNumberFromString, getIntegerNumberFromString, getIpAddressFromString, getLine, getLongNumberFromString, getMacAddressFromString, getNextOptionalToken, getNextToken, getToken, getTokenIndex, getTokens, getTotalIndentedLines, getTotalLines, incrementTokenIndex, invalidConfiguration, invalidTokenFound, isEmpty, moreIndentedLines, moreLines, moreTokens, removeLines, resetTokenIndex, setTokenIndex, tokensLeft

Methods inherited from class java.lang.Object

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

Field Detail

FRAME_RELAY

public static final java.lang.String FRAME_RELAY

See Also:

Constant Field Values

TRAFFIC_RATE

public static final java.lang.String TRAFFIC_RATE

See Also:

Constant Field Values

MIN_CIR

public static final java.lang.Integer MIN_CIR

The minimum CIR.

MAX_CIR

public static final java.lang.Integer MAX_CIR

The maximum CIR.

MIN_PEAK_RATE

public static final java.lang.Integer MIN_PEAK_RATE

The minimum Peak Rate.

MAX_PEAK_RATE

public static final java.lang.Integer MAX_PEAK_RATE

The maximum Peak Rate.

Constructor Detail

FrameRelayTrafficRateComponent

public FrameRelayTrafficRateComponent()

Constructs a frame relay traffic rate object.

Method Detail

setCir

public void setCir(java.lang.Integer cir)

Sets the committed information rate (CIR). Valid values are from 600-45000000.

Parameters:

cir - The committed information rate.

getCir

public java.lang.Integer getCir()

Gets the committed information rate (CIR).

Returns:

the committed information rate.

setPeakRate

public void setPeakRate(java.lang.Integer peakRate)

Sets the peak rate (CIR + EIR). Valid values are from 0-45000000.

Parameters:

peakRate - The peak rate.

getPeakRate

public java.lang.Integer getPeakRate()

Gets the peak rate.

Returns:

the peak rate.

buildFromIos

public java.util.List buildFromIos(java.util.List configLines)
                            throws InvalidConfigurationException

Description copied from class: CiscoRouterConfigComponent

Parse and populate the specific CiscoRouterComponent object based on the passed in individual lines of the IOS configuration. The passed in configuration lines should represent the first line in the configuration that applies to the specific component. The component should use all lines needed by its specific part of the configuration and return a List with the remaining lines that are not part of the component's configuration.

Specified by:

buildFromIos in class CiscoRouterConfigComponent

Parameters:

configLines - The list of IOS configuration lines.

Returns:

The rest of the lines that were not parsed by the component.

Throws:

InvalidConfigurationException - if the IOS configuration can not be parsed for any reason.

See Also:

CiscoRouterConfigComponent

validate

public void validate()
              throws InvalidConfigurationException

Description copied from class: CiscoRouterConfigComponent

Validates this object to ensure it contains a valid IOS configuration.

Specified by:

validate in class CiscoRouterConfigComponent

Throws:

InvalidConfigurationException - if the configuration is invalid.

See Also:

CiscoRouterConfigComponent

generateIos

public Commands generateIos()
                     throws InvalidConfigurationException

Description copied from class: CiscoRouterConfigComponent

Returns the IOS configuration commands for this component.

Specified by:

generateIos in class CiscoRouterConfigComponent

Returns:

The IOS configuration string as a list of Command objects. To generate a configlet from the list of Command objects, use Command.getConfiglet().

Throws:

InvalidConfigurationException - if the IOS configuration is invalid and the IOS string can not be generated. The validate() method is used to determine if the configuration is valid.

See Also:

CiscoRouterConfigComponent