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

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

All Implemented Interfaces:

MultiInstanceComponent, java.io.Serializable

public class FrameRelayCirComponent
extends CiscoRouterConfigComponent
implements MultiInstanceComponent

The frame relay CIR class sets the Committed Information Rate (CIR). The default is 56000 bps.

See Also:

Serialized Form

Field Summary

static java.lang.String	CIR
static java.lang.String	DIRECTION_BOTH The CIR applies to both input and output.
static java.lang.String	DIRECTION_IN The CIR applies only to input.
static java.lang.String	DIRECTION_OUT The CIR applies only to output.
static java.lang.String	FRAME_RELAY
static java.lang.String	IN
static java.lang.Integer	MAX_CIR The maximum CIR value.
static java.lang.Integer	MIN_CIR The minimum CIR value.
static java.lang.String	OUT

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

FrameRelayCirComponent()
Constructs a frame relay CIR 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.
boolean	equalsComponentInstance(CiscoRouterConfigComponent component) Determines if this component and the passed in component are the same instance of component that can be compared from an IOS configuration standpoint.
Commands	generateIos() Returns the IOS configuration commands for this component.
protected java.lang.String	generateUniqueHeaderInfo() Generates the IOS header that makes each component unique.
java.lang.Integer	getCir() Gets the committed information rate (CIR).
java.lang.String	getDirection() Gets the direction.
void	setCir(java.lang.Integer cir) Sets the committed information rate (CIR).
void	setDirection(java.lang.String direction) Sets the direction.
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

Methods inherited from interface com.foxsmart.csu.config.MultiInstanceComponent

requiresCommentSeparator

Field Detail

FRAME_RELAY

public static final java.lang.String FRAME_RELAY

See Also:

Constant Field Values

CIR

public static final java.lang.String CIR

See Also:

Constant Field Values

OUT

public static final java.lang.String OUT

See Also:

Constant Field Values

IN

public static final java.lang.String IN

See Also:

Constant Field Values

DIRECTION_BOTH

public static final java.lang.String DIRECTION_BOTH

The CIR applies to both input and output.

See Also:

Constant Field Values

DIRECTION_IN

public static final java.lang.String DIRECTION_IN

The CIR applies only to input.

See Also:

Constant Field Values

DIRECTION_OUT

public static final java.lang.String DIRECTION_OUT

The CIR applies only to output.

See Also:

Constant Field Values

MIN_CIR

public static final java.lang.Integer MIN_CIR

The minimum CIR value.

MAX_CIR

public static final java.lang.Integer MAX_CIR

The maximum CIR value.

Constructor Detail

FrameRelayCirComponent

public FrameRelayCirComponent()

Constructs a frame relay CIR object.

Method Detail

setCir

public void setCir(java.lang.Integer cir)

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

Parameters:

cir - The committed information rate.

getCir

public java.lang.Integer getCir()

Gets the committed information rate (CIR).

Returns:

the committed information rate.

setDirection

public void setDirection(java.lang.String direction)

Sets the direction. This should be one of the following constants: DIRECTION_OUT, DIRECTION_IN, or DIRECTION_BOTH. Note that DIRECTION_INT applies to Frame-Relay SVC only.

Parameters:

direction - The direction.

getDirection

public java.lang.String getDirection()

Gets the direction.

Returns:

the direction.

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

generateUniqueHeaderInfo

protected java.lang.String generateUniqueHeaderInfo()

Generates the IOS header that makes each component unique.

Returns:

the unique header info.

equalsComponentInstance

public boolean equalsComponentInstance(CiscoRouterConfigComponent component)
                                throws InvalidConfigurationException

Determines if this component and the passed in component are the same instance of component that can be compared from an IOS configuration standpoint.

Specified by:

equalsComponentInstance in interface MultiInstanceComponent

Parameters:

component - The component to compare to this component.

Returns:

True if the components are of the same instance or false if not.

Throws:

InvalidConfigurationException - if either this or the passed in component aren't valid.