com.ibm.di.config.base
Class ExternalPropertiesImpl

java.lang.Object
  extended by com.ibm.di.config.base.BaseConfigurationImpl
      extended by com.ibm.di.config.base.ExternalPropertiesImpl
All Implemented Interfaces:
BaseConfiguration, ExternalPropertiesConfig, MetamergeConfigChangeListener, Serializable

Deprecated.

public class ExternalPropertiesImpl
extends BaseConfigurationImpl
implements ExternalPropertiesConfig

Implements the old External Properties used when running Tivoli Directory Integrator.

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
ExternalPropertiesImpl()
          Deprecated.  
ExternalPropertiesImpl(Object config)
          Deprecated.  
 
Method Summary
 void configurationChanged(MetamergeConfigChange mcc)
          Deprecated. 
 String getCipher()
          Deprecated. Returns the Cipher algorithm used when reading/writing an encrypted file
 Object getClone()
          Deprecated. 
 boolean getEncrypted()
          Deprecated. Gets the encrypted flag of the ExternalPropertiesConfig object
 String getFilePath()
          Deprecated. Gets the filePath attribute of the ExternalPropertiesConfig object
 List<String> getKeys(int level)
          Deprecated. Returns a list of keys in this object.
 Object getParameter(Object name)
          Deprecated. Returns the value for a given config item.
 String getPassword()
          Deprecated. Returns the password used when opening an encrypted file
 boolean getSaveNeeded()
          Deprecated. Gets the saveNeeded flag of the ExternalPropertiesConfig object
 void init()
          Deprecated. Called after internal data structure is set.
 boolean isDebugMode()
          Deprecated.  
 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 removeParameter(Object name)
          Deprecated. Removes a local parameter from this object.
 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 setParameter(Object name, Object value)
          Deprecated. Sets the value for a given config item
 void setPassword(String password)
          Deprecated. Sets the password used when opening an encrypted file
 void setupInheritanceChain()
          Deprecated. Established the inheritance chain for this object.
 
Methods inherited from class com.ibm.di.config.base.BaseConfigurationImpl
addListener, deepClone, detachFromParent, expandPropertyValue, expandPropertyValue, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getLogEnabled, getLongName, getMetamergeConfig, getModified, getModTS, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, 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, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setModTS, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, 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.BaseConfiguration
addListener, detachFromParent, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getLogEnabled, getMetamergeConfig, getModified, getModTS, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameterPropertySource, getParameterRaw, getParent, getPath, getReferences, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, isExpression, isParameterLocal, nameForChild, notifyChange, notifyChange, notifyChange, reattachToParent, removeListener, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setModTS, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten
 

Constructor Detail

ExternalPropertiesImpl

public ExternalPropertiesImpl()
Deprecated. 

ExternalPropertiesImpl

public ExternalPropertiesImpl(Object config)
Deprecated. 
Method Detail

isDebugMode

public boolean isDebugMode()
Deprecated. 

init

public void init()
          throws Exception
Deprecated. 
Description copied from class: BaseConfigurationImpl
Called after internal data structure is set.

Specified by:
init in interface BaseConfiguration
Overrides:
init in class BaseConfigurationImpl
Throws:
Exception - if the initialization fails.

configurationChanged

public void configurationChanged(MetamergeConfigChange mcc)
Deprecated. 
Description copied from class: BaseConfigurationImpl

Specified by:
configurationChanged in interface MetamergeConfigChangeListener
Overrides:
configurationChanged in class BaseConfigurationImpl

loadData

public void loadData()
              throws Exception
Deprecated. 
Description copied from interface: ExternalPropertiesConfig
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

mergeData

public void mergeData(String path)
               throws Exception
Deprecated. 
Description copied from interface: ExternalPropertiesConfig
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 - if the operation does not succeed

saveData

public void saveData()
              throws Exception
Deprecated. 
Description copied from interface: ExternalPropertiesConfig
This method writes back the data to the external file.

Specified by:
saveData in interface ExternalPropertiesConfig
Throws:
Exception - if the operation does not succeed

getSaveNeeded

public boolean getSaveNeeded()
Deprecated. 
Description copied from interface: ExternalPropertiesConfig
Gets the saveNeeded flag of the ExternalPropertiesConfig object

Specified by:
getSaveNeeded in interface ExternalPropertiesConfig
Returns:
The saveNeeded value

setupInheritanceChain

public void setupInheritanceChain()
Deprecated. 
Description copied from class: BaseConfigurationImpl
Established the inheritance chain for this object.

Specified by:
setupInheritanceChain in interface BaseConfiguration
Overrides:
setupInheritanceChain in class BaseConfigurationImpl

getFilePath

public String getFilePath()
Deprecated. 
Description copied from interface: ExternalPropertiesConfig
Gets the filePath attribute of the ExternalPropertiesConfig object

Specified by:
getFilePath in interface ExternalPropertiesConfig
Returns:
The filePath value

setFilePath

public void setFilePath(String path)
Deprecated. 
Description copied from interface: ExternalPropertiesConfig
Sets the filePath attribute of the ExternalPropertiesConfig object

Specified by:
setFilePath in interface ExternalPropertiesConfig
Parameters:
path - The new filePath value

getPassword

public String getPassword()
Deprecated. 
Description copied from interface: ExternalPropertiesConfig
Returns the password used when opening an encrypted file

Specified by:
getPassword in interface ExternalPropertiesConfig

setPassword

public void setPassword(String password)
Deprecated. 
Description copied from interface: ExternalPropertiesConfig
Sets the password used when opening an encrypted file

Specified by:
setPassword in interface ExternalPropertiesConfig

getEncrypted

public boolean getEncrypted()
Deprecated. 
Description copied from interface: ExternalPropertiesConfig
Gets the encrypted flag of the ExternalPropertiesConfig object

Specified by:
getEncrypted in interface ExternalPropertiesConfig
Returns:
The encrypted value

setEncrypted

public void setEncrypted(boolean encrypted)
Deprecated. 
Description copied from interface: ExternalPropertiesConfig
Sets the encrypted flag of the ExternalPropertiesConfig object

Specified by:
setEncrypted in interface ExternalPropertiesConfig
Parameters:
encrypted - The new encrypted value

getCipher

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

Specified by:
getCipher in interface ExternalPropertiesConfig

setCipher

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

Specified by:
setCipher in interface ExternalPropertiesConfig

getKeys

public List<String> getKeys(int level)
Deprecated. 
Description copied from class: BaseConfigurationImpl
Returns a list of keys in this object.

Specified by:
getKeys in interface BaseConfiguration
Overrides:
getKeys in class BaseConfigurationImpl
Parameters:
level - can have these values:
  • ONE_LEVEL - only simple key/value items are returned.
  • SUBTREE - all keys are returned regardless of whether they are complex (TreeMap) or simple (String, Boolean, Integer, Vector ).
  • RECURSIVE - inherited keys are returned as well.
  • Returns:
    The list of keys.

    getParameter

    public Object getParameter(Object name)
    Deprecated. 
    Description copied from class: BaseConfigurationImpl
    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

    setParameter

    public void setParameter(Object name,
                             Object value)
    Deprecated. 
    Description copied from class: BaseConfigurationImpl
    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)
    Deprecated. 
    Description copied from class: BaseConfigurationImpl
    Removes a local parameter from this object.

    Specified by:
    removeParameter in interface BaseConfiguration
    Overrides:
    removeParameter in class BaseConfigurationImpl
    Parameters:
    name - Parameter name

    getClone

    public Object getClone()
                    throws Exception
    Deprecated. 
    Description copied from class: BaseConfigurationImpl

    Specified by:
    getClone in interface BaseConfiguration
    Overrides:
    getClone in class BaseConfigurationImpl
    Returns:
    a cloned version of this object.
    Throws:
    Exception