com.foxsmart.csu.config.global.line
Class AutoselectComponent

java.lang.Object
  com.foxsmart.csu.config.CiscoRouterConfigParser
      com.foxsmart.csu.config.CiscoRouterConfigComponent
          com.foxsmart.csu.config.global.line.AutoselectComponent

All Implemented Interfaces:

MultiLineComponent, java.io.Serializable

public class AutoselectComponent
extends CiscoRouterConfigComponent
implements MultiLineComponent

The auto select class configures the line to automatically startup a specific protocol.

See Also:

Serialized Form

Field Summary

static java.lang.String	ARAP
static java.lang.String	AUTOSELECT
static java.lang.String	DURING_LOGIN
static int	MAX_TIMEOUT_SECS The maximum timeout in seconds.
static int	MIN_TIMEOUT_SECS The minimum timeout in seconds.
static java.lang.String	PPP
static java.lang.String	SLIP
static java.lang.String	TIMEOUT

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

AutoselectComponent()
Constructs an autoselect 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.
boolean	getArapFlag() Gets the ARAP autoselection flag.
boolean	getDuringLoginFlag() Gets the "during login" flag.
boolean	getPppFlag() Gets the PPP autoselection flag.
boolean	getSlipFlag() Gets the SLIP autoselection flag.
java.lang.Integer	getTimeout() Gets the wait timeout for initial autoselect byte.
void	setArapFlag(boolean arapFlag) Sets the ARAP (AppleTalk Remote Access) autoselection flag.
void	setDuringLoginFlag(boolean duringLoginFlag) Sets the "during login" flag.
void	setPppFlag(boolean pppFlag) Sets the PPP (Point-to-Point Protocol) autoselection flag.
void	setSlipFlag(boolean slipFlag) Sets the SLIP (Serial Line Internet Protocol) autoselection flag.
void	setTimeout(java.lang.Integer timeout) Sets the wait timeout for initial autoselect byte.
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

MIN_TIMEOUT_SECS

public static final int MIN_TIMEOUT_SECS

The minimum timeout in seconds.

See Also:

Constant Field Values

MAX_TIMEOUT_SECS

public static final int MAX_TIMEOUT_SECS

The maximum timeout in seconds.

See Also:

Constant Field Values

AUTOSELECT

public static final java.lang.String AUTOSELECT

See Also:

Constant Field Values

ARAP

public static final java.lang.String ARAP

See Also:

Constant Field Values

DURING_LOGIN

public static final java.lang.String DURING_LOGIN

See Also:

Constant Field Values

PPP

public static final java.lang.String PPP

See Also:

Constant Field Values

SLIP

public static final java.lang.String SLIP

See Also:

Constant Field Values

TIMEOUT

public static final java.lang.String TIMEOUT

See Also:

Constant Field Values

Constructor Detail

AutoselectComponent

public AutoselectComponent()

Constructs an autoselect object.

Method Detail

setArapFlag

public void setArapFlag(boolean arapFlag)

Sets the ARAP (AppleTalk Remote Access) autoselection flag. Default is false.

Parameters:

arapFlag - The ARAP autoselection flag.

getArapFlag

public boolean getArapFlag()

Gets the ARAP autoselection flag.

Returns:

the ARAP autoselection flag.

setPppFlag

public void setPppFlag(boolean pppFlag)

Sets the PPP (Point-to-Point Protocol) autoselection flag. Default is false.

Parameters:

pppFlag - The PPP autoselection flag.

getPppFlag

public boolean getPppFlag()

Gets the PPP autoselection flag.

Returns:

the PPP autoselection flag.

setSlipFlag

public void setSlipFlag(boolean slipFlag)

Sets the SLIP (Serial Line Internet Protocol) autoselection flag. Default is false.

Parameters:

slipFlag - The SLIP autoselection flag.

getSlipFlag

public boolean getSlipFlag()

Gets the SLIP autoselection flag.

Returns:

the SLIP autoselection flag.

setDuringLoginFlag

public void setDuringLoginFlag(boolean duringLoginFlag)

Sets the "during login" flag. If true, autoselection is done at the username/password prompt. Default is false.

Parameters:

duringLoginFlag - The "during login" flag.

getDuringLoginFlag

public boolean getDuringLoginFlag()

Gets the "during login" flag.

Returns:

the "during login" flag.

setTimeout

public void setTimeout(java.lang.Integer timeout)

Sets the wait timeout for initial autoselect byte. Valid values are between 1-120.

Parameters:

timeout - The wait timeout for initial autoselect byte.

getTimeout

public java.lang.Integer getTimeout()

Gets the wait timeout for initial autoselect byte.

Returns:

the wait timeout for initial autoselect byte.

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