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

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

All Implemented Interfaces:

MultiLineComponent, java.io.Serializable

public class EscapeCharacterComponent
extends CiscoRouterConfigComponent
implements MultiLineComponent

The escape character class changes the current line's escape character.

See Also:

Serialized Form

Field Summary

static java.lang.String	BREAK
static java.lang.String	DEFAULT
static java.lang.String	ESCAPE_CHARACTER
static java.lang.Integer	MAX_DECIMAL_EQUIVALENT_VALUE The maximum decimal equivalent value.
static java.lang.Integer	MIN_DECIMAL_EQUIVALENT_VALUE The minimum decimal equivalent value.
static java.lang.String	NONE
static java.lang.String	SOFT

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

EscapeCharacterComponent()
Constructs an escape character 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.String	getEscapeCharacter() Gets the disconnect character.
java.lang.String	getSoftEscapeCharacter() Gets the soft escape character.
void	setEscapeCharacter(java.lang.String escapeCharacter) Sets the escape character.
void	setSoftEscapeCharacter(java.lang.String softEscapeCharacter) Sets the soft escape character.
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

ESCAPE_CHARACTER

public static final java.lang.String ESCAPE_CHARACTER

See Also:

Constant Field Values

BREAK

public static final java.lang.String BREAK

See Also:

Constant Field Values

DEFAULT

public static final java.lang.String DEFAULT

See Also:

Constant Field Values

NONE

public static final java.lang.String NONE

See Also:

Constant Field Values

SOFT

public static final java.lang.String SOFT

See Also:

Constant Field Values

MIN_DECIMAL_EQUIVALENT_VALUE

public static final java.lang.Integer MIN_DECIMAL_EQUIVALENT_VALUE

The minimum decimal equivalent value.

MAX_DECIMAL_EQUIVALENT_VALUE

public static final java.lang.Integer MAX_DECIMAL_EQUIVALENT_VALUE

The maximum decimal equivalent value.

Constructor Detail

EscapeCharacterComponent

public EscapeCharacterComponent()

Constructs an escape character object.

Method Detail

setEscapeCharacter

public void setEscapeCharacter(java.lang.String escapeCharacter)

Sets the escape character. Valid values include a character (e.g. "A"), a decimal equivalent (e.g. 65), or one of the following keywords: BREAK, DEFAULT, or NONE. To set the disconnect character to a single digit (e.g. 1), the associated decimal equivalent must be used since the passed in digit will be interpreted as a decimal value rather than a character. If a decimal equivalent value is used, it must be between 0 and 255.

Parameters:

escapeCharacter - The disconnect character.

getEscapeCharacter

public java.lang.String getEscapeCharacter()

Gets the disconnect character.

Returns:

the disconnect character.

setSoftEscapeCharacter

public void setSoftEscapeCharacter(java.lang.String softEscapeCharacter)

Sets the soft escape character. Valid values include a character (e.g. "A"), a decimal equivalent (e.g. 65), or NONE. To set the disconnect character to a single digit (e.g. 1), the associated decimal equivalent must be used since the passed in digit will be interpreted as a decimal value rather than a character. If a decimal equivalent value is used, it must be between 0 and 255.

Parameters:

softEscapeCharacter - The disconnect character.

getSoftEscapeCharacter

public java.lang.String getSoftEscapeCharacter()

Gets the soft escape character.

Returns:

the soft escape character.

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