com.foxsmart.csu.config.global.mapclassframerelay
Class FrameRelayEndToEndKeepaliveComponent

java.lang.Object
  com.foxsmart.csu.config.CiscoRouterConfigParser
      com.foxsmart.csu.config.CiscoRouterConfigComponent
          com.foxsmart.csu.config.global.mapclassframerelay.FrameRelayEndToEndKeepaliveComponent

All Implemented Interfaces:

MultiLineComponent, java.io.Serializable

public class FrameRelayEndToEndKeepaliveComponent
extends CiscoRouterConfigComponent
implements MultiLineComponent

The frame relay end to end keepalive command configures frame-relay end-to-end VC parameters.

See Also:

Serialized Form

Field Summary

static java.lang.String	END_TO_END
static java.lang.String	ERROR_THRESHOLD
static java.lang.String	EVENT_WINDOW
static java.lang.String	FRAME_RELAY
static java.lang.String	KEEPALIVE
static java.lang.Integer	MAX_ERROR_THRESHOLD_COUNT The maximum error threshold count.
static java.lang.Integer	MAX_EVENT_WINDOW_COUNT The maximum event window count.
static java.lang.Integer	MAX_SUCCESS_EVENTS_COUNT The maximum success events count.
static java.lang.Integer	MAX_TIMER_SECONDS The maximum timer seconds.
static java.lang.Integer	MIN_ERROR_THRESHOLD_COUNT The minimum error threshold count.
static java.lang.Integer	MIN_EVENT_WINDOW_COUNT The minimum event window count.
static java.lang.Integer	MIN_SUCCESS_EVENTS_COUNT The minimum success events count.
static java.lang.Integer	MIN_TIMER_SECONDS The minimum timer seconds.
static java.lang.String	MODE
static java.lang.String	RECV
static java.lang.String	SEND
static java.lang.String	SUCCESS_EVENTS
static java.lang.String	TIMER

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

FrameRelayEndToEndKeepaliveComponent()
Constructs a frame relay end to end keepalive 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	getErrorThresholdReceiveCount() Gets the error threshold receive count.
java.lang.Integer	getErrorThresholdSendCount() Gets the error threshold send count.
java.lang.Integer	getEventWindowReceiveCount() Gets the event window receive count.
java.lang.Integer	getEventWindowSendCount() Gets the event window send count.
FrameRelayEndToEndKeepaliveModeEnum	getMode() Gets the mode.
java.lang.Integer	getSuccessEventsReceiveCount() Gets the success events receive count.
java.lang.Integer	getSuccessEventsSendCount() Gets the success events send count.
java.lang.Integer	getTimerReceiveValue() Gets the timer receive value.
java.lang.Integer	getTimerSendValue() Gets the timer send value.
void	setErrorThresholdReceiveCount(java.lang.Integer errorThresholdReceiveCount) Sets the error threshold receive count.
void	setErrorThresholdSendCount(java.lang.Integer errorThresholdSendCount) Sets the error threshold send count.
void	setEventWindowReceiveCount(java.lang.Integer eventWindowReceiveCount) Sets the event window receive count.
void	setEventWindowSendCount(java.lang.Integer eventWindowSendCount) Sets the event window send count.
void	setMode(FrameRelayEndToEndKeepaliveModeEnum mode) Sets the mode.
void	setSuccessEventsReceiveCount(java.lang.Integer successEventsReceiveCount) Sets the success events receive count.
void	setSuccessEventsSendCount(java.lang.Integer successEventsSendCount) Sets the success events send count.
void	setTimerReceiveValue(java.lang.Integer timerReceiveValue) Sets the timer receive value.
void	setTimerSendValue(java.lang.Integer timerSendValue) Sets the timer send value.
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

FRAME_RELAY

public static final java.lang.String FRAME_RELAY

See Also:

Constant Field Values

END_TO_END

public static final java.lang.String END_TO_END

See Also:

Constant Field Values

KEEPALIVE

public static final java.lang.String KEEPALIVE

See Also:

Constant Field Values

MODE

public static final java.lang.String MODE

See Also:

Constant Field Values

TIMER

public static final java.lang.String TIMER

See Also:

Constant Field Values

EVENT_WINDOW

public static final java.lang.String EVENT_WINDOW

See Also:

Constant Field Values

ERROR_THRESHOLD

public static final java.lang.String ERROR_THRESHOLD

See Also:

Constant Field Values

SUCCESS_EVENTS

public static final java.lang.String SUCCESS_EVENTS

See Also:

Constant Field Values

SEND

public static final java.lang.String SEND

See Also:

Constant Field Values

RECV

public static final java.lang.String RECV

See Also:

Constant Field Values

MIN_ERROR_THRESHOLD_COUNT

public static final java.lang.Integer MIN_ERROR_THRESHOLD_COUNT

The minimum error threshold count.

MAX_ERROR_THRESHOLD_COUNT

public static final java.lang.Integer MAX_ERROR_THRESHOLD_COUNT

The maximum error threshold count.

MIN_EVENT_WINDOW_COUNT

public static final java.lang.Integer MIN_EVENT_WINDOW_COUNT

The minimum event window count.

MAX_EVENT_WINDOW_COUNT

public static final java.lang.Integer MAX_EVENT_WINDOW_COUNT

The maximum event window count.

MIN_SUCCESS_EVENTS_COUNT

public static final java.lang.Integer MIN_SUCCESS_EVENTS_COUNT

The minimum success events count.

MAX_SUCCESS_EVENTS_COUNT

public static final java.lang.Integer MAX_SUCCESS_EVENTS_COUNT

The maximum success events count.

MIN_TIMER_SECONDS

public static final java.lang.Integer MIN_TIMER_SECONDS

The minimum timer seconds.

MAX_TIMER_SECONDS

public static final java.lang.Integer MAX_TIMER_SECONDS

The maximum timer seconds.

Constructor Detail

FrameRelayEndToEndKeepaliveComponent

public FrameRelayEndToEndKeepaliveComponent()

Constructs a frame relay end to end keepalive object.

Method Detail

setMode

public void setMode(FrameRelayEndToEndKeepaliveModeEnum mode)

Sets the mode.

Parameters:

mode - The mode.

getMode

public FrameRelayEndToEndKeepaliveModeEnum getMode()

Gets the mode.

Returns:

the mode.

setTimerReceiveValue

public void setTimerReceiveValue(java.lang.Integer timerReceiveValue)

Sets the timer receive value. Valid values are between 1 and 10000 seconds.

Parameters:

timerReceiveValue - The timer receive value.

getTimerReceiveValue

public java.lang.Integer getTimerReceiveValue()

Gets the timer receive value.

Returns:

the timer receive value.

setTimerSendValue

public void setTimerSendValue(java.lang.Integer timerSendValue)

Sets the timer send value. Valid values are between 1 and 10000 seconds.

Parameters:

timerSendValue - The timer send value.

getTimerSendValue

public java.lang.Integer getTimerSendValue()

Gets the timer send value.

Returns:

the timer send value.

setEventWindowReceiveCount

public void setEventWindowReceiveCount(java.lang.Integer eventWindowReceiveCount)

Sets the event window receive count. Valid values are between 1 and 32.

Parameters:

eventWindowReceiveCount - The event window receive count.

getEventWindowReceiveCount

public java.lang.Integer getEventWindowReceiveCount()

Gets the event window receive count.

Returns:

the event window receive count.

setEventWindowSendCount

public void setEventWindowSendCount(java.lang.Integer eventWindowSendCount)

Sets the event window send count. Valid values are between 1 and 32.

Parameters:

eventWindowSendCount - The event window send count.

getEventWindowSendCount

public java.lang.Integer getEventWindowSendCount()

Gets the event window send count.

Returns:

the event window send count.

setErrorThresholdReceiveCount

public void setErrorThresholdReceiveCount(java.lang.Integer errorThresholdReceiveCount)

Sets the error threshold receive count. Valid values are between 1 and 32.

Parameters:

errorThresholdReceiveCount - The error threshold receive count.

getErrorThresholdReceiveCount

public java.lang.Integer getErrorThresholdReceiveCount()

Gets the error threshold receive count.

Returns:

the error threshold receive count.

setErrorThresholdSendCount

public void setErrorThresholdSendCount(java.lang.Integer errorThresholdSendCount)

Sets the error threshold send count. Valid values are between 1 and 32.

Parameters:

errorThresholdSendCount - The error threshold send count.

getErrorThresholdSendCount

public java.lang.Integer getErrorThresholdSendCount()

Gets the error threshold send count.

Returns:

the error threshold send count.

setSuccessEventsReceiveCount

public void setSuccessEventsReceiveCount(java.lang.Integer successEventsReceiveCount)

Sets the success events receive count. Valid values are between 1 and 32.

Parameters:

successEventsReceiveCount - The success events receive count.

getSuccessEventsReceiveCount

public java.lang.Integer getSuccessEventsReceiveCount()

Gets the success events receive count.

Returns:

the success events receive count.

setSuccessEventsSendCount

public void setSuccessEventsSendCount(java.lang.Integer successEventsSendCount)

Sets the success events send count. Valid values are between 1 and 32.

Parameters:

successEventsSendCount - The success events send count.

getSuccessEventsSendCount

public java.lang.Integer getSuccessEventsSendCount()

Gets the success events send count.

Returns:

the success events send count.

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