com.ibm.di.config.interfaces
Interface HooksConfig

All Superinterfaces:

AttributeMapConfig, BaseConfiguration, Serializable

All Known Implementing Classes:

HooksConfigImpl

public interface HooksConfig
extends AttributeMapConfig

The configuration for all the Hooks e.g. in 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	couldInherit(String name) Could this hook inherit data, if it did not have local data?
ArrayList<HookConfig>	getActiveHooks() Returns a list of defined hooks for this configuration.
HookConfig	getHook(Object name)
HookConfig	getHook(Object name, boolean create) Returns null if hook is undefined and create=false.
void	removeHook(Object name)
void	setHook(HookConfig hook)

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

getAttributeMapItem, getAttributeNames, hasAttributeMapItem, newAttributeMapItem, removeAttributeMapItem, renameAttributeMapItem, setAttributeMapItem

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

getHook

HookConfig getHook(Object name)

removeHook

void removeHook(Object name)

setHook

void setHook(HookConfig hook)

couldInherit

boolean couldInherit(String name)

Could this hook inherit data, if it did not have local data?

Parameters:

name - Name of Hook

Returns:

true if there is data that could be inherited

getActiveHooks

ArrayList<HookConfig> getActiveHooks()

Returns a list of defined hooks for this configuration.

Since:

7.0

getHook

HookConfig getHook(Object name,
                   boolean create)

Returns null if hook is undefined and create=false.

Since:

7.0