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

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

All Implemented Interfaces:

java.io.Serializable

public class PrivilegeComponent
extends CiscoRouterConfigComponent

The privilege command assigns the default privilege level for the line.

See Also:

Serialized Form

Field Summary

static java.lang.String	LEVEL
static java.lang.Integer	MAX_LEVEL The maximum level.
static java.lang.Integer	MIN_LEVEL The minimum level.
static java.lang.String	PRIVILEGE

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

PrivilegeComponent()
Constructs a privilege 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	getLevel() Gets the privilege level.
void	setLevel(java.lang.Integer level) Sets the privilege level.
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

PRIVILEGE

public static final java.lang.String PRIVILEGE

See Also:

Constant Field Values

LEVEL

public static final java.lang.String LEVEL

See Also:

Constant Field Values

MIN_LEVEL

public static final java.lang.Integer MIN_LEVEL

The minimum level.

MAX_LEVEL

public static final java.lang.Integer MAX_LEVEL

The maximum level.

Constructor Detail

PrivilegeComponent

public PrivilegeComponent()

Constructs a privilege object.

Method Detail

setLevel

public void setLevel(java.lang.Integer level)

Sets the privilege level. Valid values are from 0-15.

Parameters:

level - The privilege level.

getLevel

public java.lang.Integer getLevel()

Gets the privilege level.

Returns:

the privilege level.

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.

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