com.ibm.di.config.base
Class HooksConfigImpl

java.lang.Object
  extended by com.ibm.di.config.base.BaseConfigurationImpl
      extended by com.ibm.di.config.base.AttributeMapConfigImpl
          extended by com.ibm.di.config.base.HooksConfigImpl
All Implemented Interfaces:
AttributeMapConfig, BaseConfiguration, HooksConfig, MetamergeConfigChangeListener, Serializable

public class HooksConfigImpl
extends AttributeMapConfigImpl
implements HooksConfig

Implements the configuration for all the Hooks e.g. in a Connector or AssemblyLine.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ibm.di.config.base.BaseConfigurationImpl
NAME
 
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
 
Constructor Summary
HooksConfigImpl()
           
HooksConfigImpl(Object config)
           
 
Method Summary
 boolean couldInherit(String name)
          Could this hook inherit data, if it did not have local data?
 boolean flatten(List<String> excludedNS)
          flatten - combines all values from this object and its inherited objects into one single config object.
 ArrayList<HookConfig> getActiveHooks()
          Returns a list of enabled hooks for this configuration.
 BaseConfiguration getChild(Object name)
          
 HookConfig getHook(Object o)
           
 HookConfig getHook(Object name, boolean create)
          Returns a hook or optionally creates it
 void removeHook(Object name)
           
 List<Binding> search(String text, int options, int sizelimit, List<Binding> results)
          Searches a configuration object and optionally its children for a specific key or value.
 void setHook(HookConfig hook)
           
 void setInheritsFrom(BaseConfiguration inheritFrom)
          We override this method to change the inherited object if we inherit from a connector.
 
Methods inherited from class com.ibm.di.config.base.AttributeMapConfigImpl
configurationChanged, getAttributeMapItem, getAttributeNames, getChildNames, hasAttributeMapItem, init, newAttributeMapItem, removeAttributeMapItem, renameAttributeMapItem, setAttributeMapItem, setupInheritanceChain
 
Methods inherited from class com.ibm.di.config.base.BaseConfigurationImpl
addListener, deepClone, detachFromParent, expandPropertyValue, expandPropertyValue, fromEntry, getBooleanParameter, getChildForPath, getClone, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getLongName, getMetamergeConfig, getModified, getModTS, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterPropertySourceFromValue, getParameterRaw, getParent, getParentName, getPath, getReferences, getResHash, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseConfigListeners, getUseListeners, getUserComment, hasParameter, isExpression, isParameterLocal, nameForChild, notifyChange, notifyChange, notifyChange, performNotifyChange, reattachToParent, removeListener, removeParameter, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setModTS, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setUseConfigListeners, setUseListeners, setUserComment, size, toEntry, toString, updateInheritsFrom, willExpandProps, willFlatten, willUseInherited
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
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, fromEntry, getBooleanParameter, 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, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, 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
 

Constructor Detail

HooksConfigImpl

public HooksConfigImpl()

HooksConfigImpl

public HooksConfigImpl(Object config)
Method Detail

setInheritsFrom

public void setInheritsFrom(BaseConfiguration inheritFrom)
We override this method to change the inherited object if we inherit from a connector.

Specified by:
setInheritsFrom in interface BaseConfiguration
Overrides:
setInheritsFrom in class AttributeMapConfigImpl
Parameters:
inheritFrom - if this is ConnectorConfig object we take his AttributeMap to inherit from else standard behavior.

getHook

public HookConfig getHook(Object o)
Specified by:
getHook in interface HooksConfig

setHook

public void setHook(HookConfig hook)
Specified by:
setHook in interface HooksConfig

removeHook

public void removeHook(Object name)
Specified by:
removeHook in interface HooksConfig

couldInherit

public boolean couldInherit(String name)
Description copied from interface: HooksConfig
Could this hook inherit data, if it did not have local data?

Specified by:
couldInherit in interface HooksConfig
Parameters:
name - Name of Hook
Returns:
true if there is data that could be inherited

flatten

public boolean flatten(List<String> excludedNS)
                throws Exception
flatten - combines all values from this object and its inherited objects into one single config object. After flattening, the object is a complete object with no inherited values except those from the excludedNS list.

Specified by:
flatten in interface BaseConfiguration
Overrides:
flatten in class AttributeMapConfigImpl
Parameters:
excludedNS - List of namespaces to exclude from flattening
Returns:
true if object attempted flattening, FALSE is this object inherits from an excluded namespace or has no inheritance
Throws:
Exception

search

public List<Binding> search(String text,
                            int options,
                            int sizelimit,
                            List<Binding> results)
Description copied from class: BaseConfigurationImpl
Searches a configuration object and optionally its children for a specific key or value.

Specified by:
search in interface BaseConfiguration
Overrides:
search in class BaseConfigurationImpl
Parameters:
text - The search text
options - Search options (oneLevel=1, exactCase=2, regExp=4, paramName=8)
sizelimit - Max number of hits returned
results - A list of results.
Returns:
the results from the performed search added into the provided results parameter.

getActiveHooks

public ArrayList<HookConfig> getActiveHooks()
Returns a list of enabled hooks for this configuration.

Specified by:
getActiveHooks in interface HooksConfig
Since:
7.0

getHook

public HookConfig getHook(Object name,
                          boolean create)
Returns a hook or optionally creates it

Specified by:
getHook in interface HooksConfig
Since:
7.0

getChild

public BaseConfiguration getChild(Object name)

Specified by:
getChild in interface BaseConfiguration
Overrides:
getChild in class AttributeMapConfigImpl
Parameters:
name - The name of the configuration object
Returns:
the configuration object named name.