com.ibm.di.config.interfaces
Interface ReconnectConfig

All Superinterfaces:

BaseConfiguration, Serializable

All Known Implementing Classes:

ReconnectConfigImpl

public interface ReconnectConfig
extends BaseConfiguration

Information about Reconnect for a Connector

Field Summary

Fields inherited from interface com.ibm.di.config.interfaces.BaseConfiguration

CHILD_PATH_SEPARATOR, DISABLE_EXTPROPS, DISABLE_INHERITANCE, INHERIT_NONE, INHERIT_PARENT, ONE_LEVEL, RECURSIVE, RECURSIVE_ONELEVEL, RECURSIVE_SUBTREE, SEARCH_EXACTCASE, SEARCH_ONELEVEL, SEARCH_PARAMNAME, SEARCH_PARAMNAME_RE, SEARCH_PROPERTY, SEARCH_REGEX, SEARCH_SUBSTRING, SUBTREE

Method Summary

boolean	getAutoReconnect()
boolean	getAutoSkipForward() Should we automatically skip forward after a Reconnect.
int	getDelay() Delay between retries (in seconds)
int	getFailbackAfter()
String	getFailoverConnectorName()
boolean	getFailoverOption()
boolean	getInitReconnect()
ContainerConfig	getReconnectRules()
int	getRetries() Number of retries
ReconnectRuleConfig	newReconnectRule() Create a new reconnect rule and add it to the internal container.
void	removeParameterValues() Remove all parameter values, to prepare for inheritance
void	setAutoSkipForwardUnlessAlreadySet(Object value) Set the value of autoSkipForward, unless it is already set to a value.

Methods inherited from interface com.ibm.di.config.interfaces.BaseConfiguration

addListener, detachFromParent, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getClone, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getMetamergeConfig, getModified, getModTS, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterRaw, getParent, getPath, getReferences, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, init, isExpression, isParameterLocal, nameForChild, notifyChange, notifyChange, notifyChange, reattachToParent, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setModTS, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten

Method Detail

getAutoReconnect

boolean getAutoReconnect()

getInitReconnect

boolean getInitReconnect()

getRetries

int getRetries()

Number of retries

getDelay

int getDelay()

Delay between retries (in seconds)

getAutoSkipForward

boolean getAutoSkipForward()

Should we automatically skip forward after a Reconnect. This is only meaningful for Iterators.

setAutoSkipForwardUnlessAlreadySet

void setAutoSkipForwardUnlessAlreadySet(Object value)

Set the value of autoSkipForward, unless it is already set to a value. For internal use.

Parameters:

value - The new value

removeParameterValues

void removeParameterValues()

Remove all parameter values, to prepare for inheritance

getReconnectRules

ContainerConfig getReconnectRules()

Returns:

The container with the reconnect rules of this configuration object.

Since:

7.0

newReconnectRule

ReconnectRuleConfig newReconnectRule()
                                     throws Exception

Create a new reconnect rule and add it to the internal container.

Returns:

The new reconnect rule.

Throws:

Exception - A problem while creating the rule.

Since:

7.0

getFailoverOption

boolean getFailoverOption()

Returns:

true if Failover is enabled for this Connector.

Since:

7.2

getFailoverConnectorName

String getFailoverConnectorName()

Returns:

the name of the Connector used for Failover.

Since:

7.2

getFailbackAfter

int getFailbackAfter()

Returns:

seconds to wait before attempting an automatic Failback.

Since:

7.2