com.foxsmart.csu.config.global.interfacepkg
Class RateLimitAction

java.lang.Object
  com.foxsmart.csu.config.CiscoRouterConfigParser
      com.foxsmart.csu.config.global.interfacepkg.RateLimitAction

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

RateLimitContinueAction, RateLimitDropAction, RateLimitSetDscpContinueAction, RateLimitSetDscpTransmitAction, RateLimitSetMplsExpContinueAction, RateLimitSetMplsExpTransmitAction, RateLimitSetPrecedenceContinueAction, RateLimitSetPrecedenceTransmitAction, RateLimitSetQosContinueAction, RateLimitSetQosTransmitAction, RateLimitTransmitAction

public abstract class RateLimitAction
extends CiscoRouterConfigParser
implements java.io.Serializable

The RateLimitAction class is the abstract base class for various rate limit actions.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.foxsmart.csu.config.CiscoRouterConfigParser

log, NO, tokenIndex

Constructor Summary

RateLimitAction()

Method Summary

java.lang.String	generateIosString() Generates the IOS configuration for this rate limit action.
abstract boolean	getActionAssociatedWithValue() Determines whether this action is associated with a value or not.
abstract java.lang.String	getActionKeyword() Gets the keyword for this action (e.g.
java.lang.Integer	getMaxValue() Returns the maximum value for this action.
java.lang.Integer	getMinValue() Returns the minimum value for this action.
java.lang.Integer	getValue() Gets the value for this action.
void	setValue(java.lang.Integer value) Sets the value for this action.
void	validate()

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

Constructor Detail

RateLimitAction

public RateLimitAction()

Method Detail

getActionAssociatedWithValue

public abstract boolean getActionAssociatedWithValue()

Determines whether this action is associated with a value or not.

Returns:

True if a value is associated with it or false if not.

getActionKeyword

public abstract java.lang.String getActionKeyword()

Gets the keyword for this action (e.g. set-dscp-continue).

Returns:

the keywork

getMinValue

public java.lang.Integer getMinValue()

Returns the minimum value for this action. Sub-classes should override this method to return the minimum value for their action (if applicable). This base class implementation returns null indicating no minimum value.

Returns:

null;

getMaxValue

public java.lang.Integer getMaxValue()

Returns the maximum value for this action. Sub-classes should override this method to return the maximum value for their action (if applicable). This base class implementation returns null indicating no maximum value.

Returns:

null;

getValue

public java.lang.Integer getValue()

Gets the value for this action.

Returns:

the value.

setValue

public void setValue(java.lang.Integer value)

Sets the value for this action.

Parameters:

value - the value

validate

public void validate()
              throws InvalidConfigurationException

Throws:

InvalidConfigurationException - if the rate limit action is not valid.

See Also:

CiscoRouterConfigComponent

generateIosString

public java.lang.String generateIosString()
                                   throws InvalidConfigurationException

Generates the IOS configuration for this rate limit action. Validation will be performed.

Returns:

the generated IOS.

Throws:

InvalidConfigurationException - if the configuration is invalid.

See Also:

CiscoRouterConfigComponent