com.ibm.di.config.interfaces
Interface ExternalPropertiesConfig

All Superinterfaces:

BaseConfiguration, Serializable

All Known Implementing Classes:

ExternalPropertiesDelegator, ExternalPropertiesImpl

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

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

Method Summary

String	getCipher() Returns the Cipher algorithm used when reading/writing an encrypted file
boolean	getEncrypted() Gets the encrypted flag of the ExternalPropertiesConfig object
String	getFilePath() Gets the filePath attribute of the ExternalPropertiesConfig object
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) This method merges the contents of a file into the current list of properties.
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	setPassword(String password) Sets the password used when opening an encrypted file

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

addListener, 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, isParameterLocal, nameForChild, notifyChange, notifyChange, 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

getFilePath

String getFilePath()

Gets the filePath attribute of the ExternalPropertiesConfig object

Returns:

The filePath value

setFilePath

void setFilePath(String path)

Sets the filePath attribute of the ExternalPropertiesConfig object

Parameters:

path - The new filePath value

getPassword

String getPassword()

Returns the password used when opening an encrypted file

setPassword

void setPassword(String password)

Sets the password used when opening an encrypted file

getCipher

String getCipher()

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

setCipher

void setCipher(String cipher)

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

getEncrypted

boolean getEncrypted()

Gets the encrypted flag of the ExternalPropertiesConfig object

Returns:

The encrypted value

setEncrypted

void setEncrypted(boolean encrypted)

Sets the encrypted flag of the ExternalPropertiesConfig object

Parameters:

encrypted - The new encrypted value

getSaveNeeded

boolean getSaveNeeded()

Gets the saveNeeded flag of the ExternalPropertiesConfig object

Returns:

The saveNeeded value

loadData

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.

Throws:

Exception - if the operation does not succeed

mergeData

void mergeData(String path)
               throws Exception

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

This method writes back the data to the external file.

Throws:

Exception - if the operation does not succeed