com.ibm.di.config.interfaces
Interface ExternalPropertiesConfig

All Superinterfaces:
BaseConfiguration, Serializable
All Known Implementing Classes:
ExternalPropertiesDelegator, ExternalPropertiesImpl

Deprecated. use TDIProperties instead

@Deprecated
public interface ExternalPropertiesConfig
extends BaseConfiguration

This interface gives access to a configuration's external properties. External properties are special in that the data is stored in an external file rather than by the MetamergeConfig object's storage. Use the BaseConfiguration's getXXX/setXXX methods to read and write properties.


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 getCipher()
          Deprecated. Returns the Cipher algorithm used when reading/writing an encrypted file
 boolean getEncrypted()
          Deprecated. Gets the encrypted flag of the ExternalPropertiesConfig object
 String getFilePath()
          Deprecated. Gets the filePath attribute of the ExternalPropertiesConfig object
 String getPassword()
          Deprecated. Returns the password used when opening an encrypted file
 boolean getSaveNeeded()
          Deprecated. Gets the saveNeeded flag of the ExternalPropertiesConfig object
 void loadData()
          Deprecated. This method reads the external properties into memory for subseqent use.
 void mergeData(String path)
          Deprecated. This method merges the contents of a file into the current list of properties.
 void saveData()
          Deprecated. This method writes back the data to the external file.
 void setCipher(String cipher)
          Deprecated. Sets the Cipher algorithm used when reading/writing an encrypted file
 void setEncrypted(boolean encrypted)
          Deprecated. Sets the encrypted flag of the ExternalPropertiesConfig object
 void setFilePath(String path)
          Deprecated. Sets the filePath attribute of the ExternalPropertiesConfig object
 void setPassword(String password)
          Deprecated. Sets the password used when opening an encrypted file
 
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

getFilePath

String getFilePath()
Deprecated. 
Gets the filePath attribute of the ExternalPropertiesConfig object

Returns:
The filePath value

setFilePath

void setFilePath(String path)
Deprecated. 
Sets the filePath attribute of the ExternalPropertiesConfig object

Parameters:
path - The new filePath value

getPassword

String getPassword()
Deprecated. 
Returns the password used when opening an encrypted file


setPassword

void setPassword(String password)
Deprecated. 
Sets the password used when opening an encrypted file


getCipher

String getCipher()
Deprecated. 
Returns the Cipher algorithm used when reading/writing an encrypted file


setCipher

void setCipher(String cipher)
Deprecated. 
Sets the Cipher algorithm used when reading/writing an encrypted file


getEncrypted

boolean getEncrypted()
Deprecated. 
Gets the encrypted flag of the ExternalPropertiesConfig object

Returns:
The encrypted value

setEncrypted

void setEncrypted(boolean encrypted)
Deprecated. 
Sets the encrypted flag of the ExternalPropertiesConfig object

Parameters:
encrypted - The new encrypted value

getSaveNeeded

boolean getSaveNeeded()
Deprecated. 
Gets the saveNeeded flag of the ExternalPropertiesConfig object

Returns:
The saveNeeded value

loadData

void loadData()
              throws Exception
Deprecated. 
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.

Throws:
Exception - if the operation does not succeed

mergeData

void mergeData(String path)
               throws Exception
Deprecated. 
This method merges the contents of a file into the current list of properties.

Parameters:
path - The file path to load properties from
Throws:
Exception - if the operation does not succeed

saveData

void saveData()
              throws Exception
Deprecated. 
This method writes back the data to the external file.

Throws:
Exception - if the operation does not succeed