com.ibm.di.config.interfaces
Interface ReconnectRuleConfig

All Superinterfaces:

BaseConfiguration, Serializable

All Known Implementing Classes:

ReconnectRuleConfigImpl

public interface ReconnectRuleConfig
extends BaseConfiguration

A configuration object that describes a single reconnect rule.

Since:

7.0

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

String	getAction()
String	getExceptionClass()
String	getExceptionMessageRegExp()
void	validate() Validate the contents of this reconnect rule.

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, 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, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten

Method Detail

getAction

String getAction()

Returns:

What action should be taken if an error occurs and that error matches the rule. Will either be null, empty string or one of 'reconnect' or 'error'. If null or empty, the engine that interprets the rule should use its default action.

getExceptionClass

String getExceptionClass()

Returns:

The Java class of exceptions to which this rule applies. If null or empty, the rule applies to all classes of exceptions.

getExceptionMessageRegExp

String getExceptionMessageRegExp()

Returns:

A regular expression that matches the messages of exceptions to which this rule applies. If null or empty, the rule applies to all exception messages.

validate

void validate()
              throws Exception

Validate the contents of this reconnect rule.

Throws:

Exception - If the reconnect action is neither null, an empty string, 'error' nor 'reconnect'. If the class definition of the exception class is not available to the JVM.