com.foxsmart.csu.config.global.mapclassdialer
Class DialerIsdnComponent

java.lang.Object
  com.foxsmart.csu.config.CiscoRouterConfigParser
      com.foxsmart.csu.config.CiscoRouterConfigComponent
          com.foxsmart.csu.config.global.mapclassdialer.DialerIsdnComponent

All Implemented Interfaces:

MultiLineComponent, java.io.Serializable

public class DialerIsdnComponent
extends CiscoRouterConfigComponent
implements MultiLineComponent

The dailer isdn class represents the ISDN settings for the map class dailer.

See Also:

Serialized Form

Field Summary

static java.lang.String	_56
static java.lang.String	DIALER
static java.lang.String	ISDN
static java.lang.Integer	ISDN_56K_SPEED An ISDN speed of 56 Kbps.
static java.lang.Integer	MAX_SECONDS The maximum number of seconds.
static java.lang.Integer	MIN_SECONDS The minimum number of seconds.
static java.lang.String	SHORT_HOLD
static java.lang.String	SPC
static java.lang.String	SPEED

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

DialerIsdnComponent()
Constructs a dailer Isdn 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	generateDeleteIos(CiscoRouterConfig updatedCiscoRouterConfig) Generates the IOS configuration commands to delete this component.
Commands	generateIos() Returns the IOS configuration commands for this component.
java.lang.Integer	getIsdnSpeed() Gets the ISDN speed.
java.lang.Integer	getShortHoldTimeout() Gets the short hold timeout.
boolean	getSpcFlag() Gets the SPC flag.
void	setIsdnSpeed(java.lang.Integer isdnSpeed) Sets the ISDN speed in Kbps.
void	setShortHoldTimeout(java.lang.Integer shortHoldTimeout) Sets the short hold timeout.
void	setSpcFlag(boolean spcFlag) Sets the Semi-permanent connection (SPC) flag.
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, 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

DIALER

public static final java.lang.String DIALER

See Also:

Constant Field Values

ISDN

public static final java.lang.String ISDN

See Also:

Constant Field Values

SHORT_HOLD

public static final java.lang.String SHORT_HOLD

See Also:

Constant Field Values

SPC

public static final java.lang.String SPC

See Also:

Constant Field Values

SPEED

public static final java.lang.String SPEED

See Also:

Constant Field Values

_56

public static final java.lang.String _56

See Also:

Constant Field Values

MIN_SECONDS

public static final java.lang.Integer MIN_SECONDS

The minimum number of seconds.

MAX_SECONDS

public static final java.lang.Integer MAX_SECONDS

The maximum number of seconds.

ISDN_56K_SPEED

public static final java.lang.Integer ISDN_56K_SPEED

An ISDN speed of 56 Kbps.

Constructor Detail

DialerIsdnComponent

public DialerIsdnComponent()

Constructs a dailer Isdn object.

Method Detail

setIsdnSpeed

public void setIsdnSpeed(java.lang.Integer isdnSpeed)

Sets the ISDN speed in Kbps. This value must be set to the ISDN_56K_SPEED constant.

Parameters:

isdnSpeed - The ISDN speed.

getIsdnSpeed

public java.lang.Integer getIsdnSpeed()

Gets the ISDN speed.

Returns:

the ISDN speed.

setSpcFlag

public void setSpcFlag(boolean spcFlag)

Sets the Semi-permanent connection (SPC) flag.

Parameters:

spcFlag - The SPC flag.

getSpcFlag

public boolean getSpcFlag()

Gets the SPC flag.

Returns:

the SPC flag.

setShortHoldTimeout

public void setShortHoldTimeout(java.lang.Integer shortHoldTimeout)

Sets the short hold timeout. Valid values are from 0-2147483.

Parameters:

shortHoldTimeout - The short hold timeout.

getShortHoldTimeout

public java.lang.Integer getShortHoldTimeout()

Gets the short hold timeout.

Returns:

the short hold timeout.

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

generateDeleteIos

public Commands generateDeleteIos(CiscoRouterConfig updatedCiscoRouterConfig)
                           throws InvalidConfigurationException

Description copied from class: CiscoRouterConfigComponent

Generates the IOS configuration commands to delete this component. This is the default implementation that generates a "no" statement followed by the generateIos() string for non CompositeComponents or generateHeaderIos() for CompositeComponents. Specific components may choose to override this method if this implementation is incorrect. The "no" keyword is placed where the first character of the command is located. For example, if the IOS command is " length 255", then the returned command will be " no length 255" (and not "no length 255").

Note that this implementation will call the getDeferredDelete method on the component and set the "deferred flag" on the returned Commands with its returned value.

Specified by:

generateDeleteIos in interface MultiLineComponent

Overrides:

generateDeleteIos in class CiscoRouterConfigComponent

Parameters:

updatedCiscoRouterConfig - the updated Cisco router configuration.

Returns:

The generated IOS string to deleted the component.

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:

MultiLineComponent