com.ibm.di.config.interfaces
Class ExternalPropertiesDelegator

java.lang.Object
  com.ibm.di.config.base.BaseConfigurationImpl
      com.ibm.di.config.interfaces.ExternalPropertiesDelegator

All Implemented Interfaces:

BaseConfiguration, ExternalPropertiesConfig, MetamergeConfigChangeListener, Serializable, Comparator

public class ExternalPropertiesDelegator
extends BaseConfigurationImpl
implements ExternalPropertiesConfig, MetamergeConfigChangeListener, Comparator

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

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, SUBTREE

Constructor Summary

ExternalPropertiesDelegator(MetamergeConfig mc)

Method Summary

int	compare(Object o1, Object o2)
void	configurationChanged(MetamergeConfigChange changeEvent) When folder changes we must add/remove it from our internal list
String	getCipher() Returns the Cipher algorithm used when reading/writing an encrypted file
Object	getClone() Returns a cloned version of this object.
ExternalPropertiesConfig	getContainerForKey(Object name) Returns the ExternalPropertiesConfig object that contains the property named name
ExternalPropertiesConfig	getDefaultExternalPropertyObject() Returns the default ExternalPropertiesConfig object.
boolean	getEncrypted() Gets the encrypted flag of the ExternalPropertiesConfig object
TDIProperties	getEPObjects()
String	getFilePath() Gets the filePath attribute of the ExternalPropertiesConfig object
List	getKeys(int level) This method returns the combined set of property names in all extprop objects
TDIPropertyStore	getNamedXP(String name) Returns the extern property config named name
Object	getParameter(Object name) Returns the value for a given config item.
String	getPassword() Returns the password used when opening an encrypted file.
boolean	getSaveNeeded() Gets the saveNeeded flag of the ExternalPropertiesConfig object
void	loadData() This method reads the external properties into memory for subseqent use.
void	mergeData(String path) Deprecated. Use a named ExternalProperties object instead of this call
void	removeParameter(Object name) Get/Set parameter variants.
void	saveData() This method writes back the data to the external file.
void	setCipher(String cipher) Sets the Cipher algorithm used when reading/writing an encrypted file
void	setEncrypted(boolean encrypted) Sets the encrypted flag of the ExternalPropertiesConfig object
void	setFilePath(String path) Sets the filePath attribute of the ExternalPropertiesConfig object
void	setParameter(Object name, Object value) Sets the value for a given config item
void	setPassword(String password) Sets the password used when opening an encrypted file

Methods inherited from class com.ibm.di.config.base.BaseConfigurationImpl

addListener, deepClone, expandPropertyValue, expandPropertyValue, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getLogEnabled, getMetamergeConfig, getModified, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameterPropertySource, getParameterPropertySourceFromValue, getParameterRaw, getParent, getParentName, getPath, getReferences, getResHash, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, init, isParameterLocal, nameForChild, notifyChange, notifyChange, performNotifyChange, removeListener, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, 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.BaseConfiguration

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

Methods inherited from interface java.util.Comparator

equals

Constructor Detail

ExternalPropertiesDelegator

public ExternalPropertiesDelegator(MetamergeConfig mc)

Method Detail

configurationChanged

public void configurationChanged(MetamergeConfigChange changeEvent)

When folder changes we must add/remove it from our internal list

Specified by:

configurationChanged in interface MetamergeConfigChangeListener

Overrides:

configurationChanged in class BaseConfigurationImpl

getSaveNeeded

public boolean getSaveNeeded()

Gets the saveNeeded flag of the ExternalPropertiesConfig object

Specified by:

getSaveNeeded in interface ExternalPropertiesConfig

Returns:

The saveNeeded value

loadData

public void loadData()
              throws Exception

This method reads the external properties into memory for subseqent use. This is typically done automatically by the hosting MetamergeConfig object when this object is requested.

Specified by:

loadData in interface ExternalPropertiesConfig

Throws:

Exception - if the operation does not succeed

saveData

public void saveData()
              throws Exception

This method writes back the data to the external file.

Specified by:

saveData in interface ExternalPropertiesConfig

Throws:

Exception - if the operation does not succeed

getKeys

public List getKeys(int level)

This method returns the combined set of property names in all extprop objects

Specified by:

getKeys in interface BaseConfiguration

Overrides:

getKeys in class BaseConfigurationImpl

Parameters:

level - The level of keys returned.

Returns:

The list of keys

Throws:

Exception - if the operation does not succeed

getParameter

public Object getParameter(Object name)

Description copied from interface: BaseConfiguration

Returns the value for a given config item. This method will call inherited object's getParameter if this object does not contain the named value. In case of returning an inherited value, the value from the inherited object will be cloned. It is up to the user to create a key/value local to this object by calling one of the setParameter methods.

Specified by:

getParameter in interface BaseConfiguration

Overrides:

getParameter in class BaseConfigurationImpl

Parameters:

name - The parameter name

Returns:

The parameter value

getContainerForKey

public ExternalPropertiesConfig getContainerForKey(Object name)

Returns the ExternalPropertiesConfig object that contains the property named name

getDefaultExternalPropertyObject

public ExternalPropertiesConfig getDefaultExternalPropertyObject()

Returns the default ExternalPropertiesConfig object.

setParameter

public void setParameter(Object name,
                         Object value)

Description copied from interface: BaseConfiguration

Sets the value for a given config item

Specified by:

setParameter in interface BaseConfiguration

Overrides:

setParameter in class BaseConfigurationImpl

Parameters:

name - Parameter name

value - Parameter value

removeParameter

public void removeParameter(Object name)

Description copied from class: BaseConfigurationImpl

Get/Set parameter variants.

Specified by:

removeParameter in interface BaseConfiguration

Overrides:

removeParameter in class BaseConfigurationImpl

Parameters:

name - Parameter name

getNamedXP

public TDIPropertyStore getNamedXP(String name)

Returns the extern property config named name

getEPObjects

public TDIProperties getEPObjects()

compare

public int compare(Object o1,
                   Object o2)

Specified by:

compare in interface Comparator

getClone

public Object getClone()

Description copied from interface: BaseConfiguration

Returns a cloned version of this object.

Specified by:

getClone in interface BaseConfiguration

Overrides:

getClone in class BaseConfigurationImpl

getFilePath

public String getFilePath()

Gets the filePath attribute of the ExternalPropertiesConfig object

Specified by:

getFilePath in interface ExternalPropertiesConfig

Returns:

The filePath value

setFilePath

public void setFilePath(String path)

Sets the filePath attribute of the ExternalPropertiesConfig object

Specified by:

setFilePath in interface ExternalPropertiesConfig

Parameters:

path - The new filePath value

getPassword

public String getPassword()

Returns the password used when opening an encrypted file. This method always returns null for security reasons.

Specified by:

getPassword in interface ExternalPropertiesConfig

setPassword

public void setPassword(String password)

Sets the password used when opening an encrypted file

Specified by:

setPassword in interface ExternalPropertiesConfig

getCipher

public String getCipher()

Returns the Cipher algorithm used when reading/writing an encrypted file

Specified by:

getCipher in interface ExternalPropertiesConfig

setCipher

public void setCipher(String cipher)

Sets the Cipher algorithm used when reading/writing an encrypted file

Specified by:

setCipher in interface ExternalPropertiesConfig

getEncrypted

public boolean getEncrypted()

Gets the encrypted flag of the ExternalPropertiesConfig object

Specified by:

getEncrypted in interface ExternalPropertiesConfig

Returns:

The encrypted value

setEncrypted

public void setEncrypted(boolean encrypted)

Sets the encrypted flag of the ExternalPropertiesConfig object

Specified by:

setEncrypted in interface ExternalPropertiesConfig

Parameters:

encrypted - The new encrypted value

mergeData

public void mergeData(String path)
               throws Exception

Deprecated. Use a named ExternalProperties object instead of this call

This method merges the contents of a file into the current list of properties.

Specified by:

mergeData in interface ExternalPropertiesConfig

Parameters:

path - The file path to load properties from

Throws:

Exception - Always, use a named ExternalProperties object instead of this call