com.ibm.di.config.base
Class MetamergeConfigImpl

java.lang.Object
  com.ibm.di.config.base.BaseConfigurationImpl
      com.ibm.di.config.base.MetamergeConfigImpl

All Implemented Interfaces:

BaseConfiguration, MetamergeConfig, MetamergeConfigChangeListener, MetamergeFolder, Serializable

Direct Known Subclasses:

FileNamespace, MetamergeConfigXML

public class MetamergeConfigImpl
extends BaseConfigurationImpl
implements MetamergeConfig

Implements MetamergeConfig. This implementation stores the configuration objects in a file using a private format.

See Also:

MetamergeConfig, Serialized Form

Field Summary

protected Hashtable<String,String>	classMap
static String	DEFAULT_FOLDER_IMPL
static String[]	DEFAULT_FOLDER_NAMES
protected Hashtable	env
protected ExternalPropertiesDelegator	externalPropertiesDelegator
static Log	logger

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

NAME

Fields inherited from interface com.ibm.di.config.interfaces.MetamergeConfig

ASSEMBLYLINE_FOLDER, ATTRIBUTEMAP_FOLDER, CONFIG_FOLDER, CONNECTOR_FOLDER, DEFAULT_ASSEMBLYLINE_FOLDER, DEFAULT_ATTRIBUTEMAP_FOLDER, DEFAULT_CONFIG_FOLDER, DEFAULT_CONNECTOR_FOLDER, DEFAULT_EXTPROP_FOLDER, DEFAULT_EXTPROP_NAME, DEFAULT_FORM_FOLDER, DEFAULT_FUNCTION_FOLDER, DEFAULT_LIBRARY_FOLDER, DEFAULT_LIBS_FOLDER, DEFAULT_LOGGER_FOLDER, DEFAULT_NAMESPACE_FOLDER, DEFAULT_PARSER_FOLDER, DEFAULT_PROPERTY_FOLDER, DEFAULT_PROPSTORE_FOLDER, DEFAULT_SCRIPT_FOLDER, DEFAULT_SERVER_AUTOSTART, DEFAULT_SERVER_FOLDER, DEFAULT_SERVER_INSTANCE_PROPERTIES, DEFAULT_SERVER_LOG, DEFAULT_SERVER_TOMBSTONES, DEFAULT_SOLUTION_INTERFACE, EXTPROP_FOLDER, FORM_FOLDER, FUNCTION_FOLDER, LIBRARY_FOLDER, LIBS_FOLDER, LOGGER_FOLDER, LOGGING_FOLDER, NAMESPACE_FOLDER, PARSER_FOLDER, PROPERTY_FOLDER, PROPSTORE_FOLDER, SCRIPT_FOLDER

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

MetamergeConfigImpl()

MetamergeConfigImpl(Hashtable<String,Object> env)

Method Summary

void	addDefaultFolders()
Object	addNameComponent(Object name, String component, boolean prefix) Adds a name component to the NameComponent attribute of the MetamergeConfig object
void	bind(Object name, Object obj) Adds a new object to the configuration at the location specified by name
void	closeConfig() Close the driver
void	commitChanges(Object output) Tells the configuration driver to save all modified objects.
void	commitChanges(Object output, boolean isSave) Tells the configuration driver to save all modified objects.
void	copy(BaseConfiguration input, Object destination, boolean copyRefs) Copies a configuration object into this configuration.
MetamergeFolder	createFolder(Object name) This method creates a sub-folder in this folder with the given name.
AssemblyLineConfig	getAssemblyLine(Object name) Returns the AssemblyLineConfig object for the named assemblyline.
String	getConfigVersion()
ConnectorConfig	getConnector(Object name) Returns the ConnectorConfig object for the named connector.
MetamergeFolder	getDefaultFolder(int folder) Returns the MetamergeFolder object for the default folder named by folder.
String	getDirectory() Returns the directory this config is placed in.
Object	getDriverParameter(Object name) This method returns the value for a given driver parameter.
BaseConfiguration	getDriverParameters() This method returns the driver parameters as a BaseConfiguration object.
ExternalPropertiesConfig	getExternalProperties() Returns the external properties delegator object for this configuration.
ExternalPropertiesConfig	getExternalProperties(Object name) Returns the ExternalPropertiesConfig object for the named external properties object.
FileConfig	getFileConfig()
FunctionConfig	getFunction(Object name) Returns the FunctionConfig object for the named function.
String[]	getNames() This method returns an array of names contained in this folder.
NamespaceConfig	getNamespace(Object name) Returns the NamespaceConfig object for the named namespace.
ParserConfig	getParser(Object name) Returns the ParserConfig object for the named parser.
protected String	getPassword()
ScriptConfig	getScript(Object name) Returns the ScriptConfig object for the named script.
SolutionInterface	getSolutionInterface() This method returns the SolutionInterface object for this configuration.
TDIProperties	getTDIProperties() This method returns the associated TDIProperties object
static TreeMap	getTreeMap(BaseConfiguration base, Object key)
static Vector	getVector(BaseConfiguration base, Object key)
boolean	hasPassword()
protected void	initializeClassMap()
void	initializeConfig() Initialize the driver
void	instantiateAllObjects() This method iterates the entire configuration to create java objects from the config drivers underlying store.
void	instantiateAllObjects(MetamergeFolder folder)
protected Object	internalLookup(Object name)
boolean	isCommittable() Returns true if the configuration driver implements the commitChanges method and the current value for PROVIDER_URL is writable.
boolean	isReadOnly() Returns true if this configuration cannot be modified.
boolean	isRemote()
Enumeration	list() Returns a list of javax.naming.Binding objects for each of this folders child entries.
Enumeration	list(Object name) Returns an enumeration of the immediate children of this node
void	logmsg(String msg)
Object	lookup(Object name) Searches this configuration for a named node.
Object	lookupInFolder(String folder, Object name)
BaseConfiguration	newInstanceOf(int type) Create new instance of object
BaseConfiguration	newInstanceOf(Object typeName) This method returns a new instance of the object type specified by typeName.
void	rebind(Object name, Object obj) Adds or replaces a new object to the configuration.
void	rename(Object name, Object newname) Renames an object.
void	setDriverParameter(Object name, Object value) This method sets a driver parameter.
void	setDriverParameters(BaseConfiguration driverParams) This method sets the driver parameters from a BaseConfiguration object.
void	setFileConfig(FileConfig aFileConfig)
void	setOutput(Object output) Changes the output to wich the configuration driver writes its configuration.
String	toString() Answers a string containing the name of the config.
void	unbind(Object name) Removes a named object from this configuration.
boolean	useEncryption()

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

addListener, configurationChanged, deepClone, detachFromParent, expandPropertyValue, expandPropertyValue, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getClone, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getLongName, getMetamergeConfig, getModified, 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, init, isExpression, isParameterLocal, nameForChild, notifyChange, notifyChange, notifyChange, performNotifyChange, reattachToParent, 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, setUseConfigListeners, setUseListeners, setUserComment, size, toEntry, 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, 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, isExpression, isParameterLocal, nameForChild, notifyChange, notifyChange, notifyChange, reattachToParent, 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

Field Detail

logger

public static final Log logger

env

protected Hashtable env

classMap

protected Hashtable<String,String> classMap

externalPropertiesDelegator

protected ExternalPropertiesDelegator externalPropertiesDelegator

DEFAULT_FOLDER_NAMES

public static final String[] DEFAULT_FOLDER_NAMES

DEFAULT_FOLDER_IMPL

public static final String DEFAULT_FOLDER_IMPL

See Also:

Constant Field Values

Constructor Detail

MetamergeConfigImpl

public MetamergeConfigImpl()

MetamergeConfigImpl

public MetamergeConfigImpl(Hashtable<String,Object> env)
                    throws Exception

Throws:

Exception

Method Detail

useEncryption

public boolean useEncryption()

hasPassword

public boolean hasPassword()

getPassword

protected String getPassword()

initializeConfig

public void initializeConfig()
                      throws Exception

Description copied from interface: MetamergeConfig

Initialize the driver

Specified by:

initializeConfig in interface MetamergeConfig

Throws:

Exception

addDefaultFolders

public void addDefaultFolders()
                       throws Exception

Throws:

Exception

closeConfig

public void closeConfig()
                 throws Exception

Description copied from interface: MetamergeConfig

Close the driver

Specified by:

closeConfig in interface MetamergeConfig

Throws:

Exception

initializeClassMap

protected void initializeClassMap()

internalLookup

protected Object internalLookup(Object name)
                         throws Exception

Throws:

Exception

commitChanges

public void commitChanges(Object output)
                   throws Exception

Description copied from interface: MetamergeConfig

Tells the configuration driver to save all modified objects. This has the same effect as commitChanges( output, true)

Specified by:

commitChanges in interface MetamergeConfig

Parameters:

output - Null or any object supported by the underlying driver.

Throws:

Exception

commitChanges

public void commitChanges(Object output,
                          boolean isSave)
                   throws Exception

Description copied from interface: MetamergeConfig

Tells the configuration driver to save all modified objects. Not all config drivers support this method. Typically drivers that work with streams (e.g. files) will implement this method to flush its cache to disk. The output parameter may be any object understood by the driver and serves as a temporary output destination. Use the setOutput() to permanently change the output URL for the driver.

Specified by:

commitChanges in interface MetamergeConfig

Parameters:

output - Null or any object supported by the underlying driver.

isSave - true if this is a permanent save, false if this just saves to e.g. a command window.

Throws:

Exception

isCommittable

public boolean isCommittable()

Description copied from interface: MetamergeConfig

Returns true if the configuration driver implements the commitChanges method and the current value for PROVIDER_URL is writable.

Specified by:

isCommittable in interface MetamergeConfig

Returns:

The committable state

isReadOnly

public boolean isReadOnly()

Description copied from interface: MetamergeConfig

Returns true if this configuration cannot be modified.

Specified by:

isReadOnly in interface MetamergeConfig

Returns:

The readOnly value

copy

public void copy(BaseConfiguration input,
                 Object destination,
                 boolean copyRefs)
          throws Exception

Description copied from interface: MetamergeConfig

Copies a configuration object into this configuration. This differs from the bind/rebind method in that all copied objects are stored in a different branch than the original objects. Also, the copied objects' referenced objects may be copied in as well.

Specified by:

copy in interface MetamergeConfig

Parameters:

input - Configuration object to be copied

destination - The name of the destination object (javax.naming.Name or String)

copyRefs - If true, copy referenced objects as well (e.g. all inherited objects)

Throws:

Exception

createFolder

public MetamergeFolder createFolder(Object name)
                             throws Exception

Description copied from interface: MetamergeFolder

This method creates a sub-folder in this folder with the given name.

Specified by:

createFolder in interface MetamergeFolder

Parameters:

name - Name of sub-folder

Returns:

The MetamergeFolder object representing the new sub-folder

Throws:

Exception

setOutput

public void setOutput(Object output)
               throws Exception

Description copied from interface: MetamergeConfig

Changes the output to wich the configuration driver writes its configuration. This is different from calling commitChanges(output, false) where the output parameter is temporary (e.g. SaveCopyAs).

Specified by:

setOutput in interface MetamergeConfig

Parameters:

output - The new output value

Throws:

Exception

getDefaultFolder

public MetamergeFolder getDefaultFolder(int folder)
                                 throws Exception

Description copied from interface: MetamergeConfig

Returns the MetamergeFolder object for the default folder named by folder.

Specified by:

getDefaultFolder in interface MetamergeConfig

Parameters:

folder - The default folder constant

Returns:

The Folder object

Throws:

Exception

lookupInFolder

public Object lookupInFolder(String folder,
                             Object name)
                      throws Exception

Throws:

Exception

lookup

public Object lookup(Object name)
              throws Exception

Description copied from interface: MetamergeConfig

Searches this configuration for a named node.

Specified by:

lookup in interface MetamergeConfig

Parameters:

name - The name to lookup

Returns:

The configuration object found

Throws:

Exception

list

public Enumeration list(Object name)
                 throws Exception

Description copied from interface: MetamergeConfig

Returns an enumeration of the immediate children of this node

Specified by:

list in interface MetamergeConfig

Parameters:

name - The folder name to list

Returns:

Enumeration object of javax.naming.Binding objects with names and objects.

Throws:

Exception

list

public Enumeration list()
                 throws Exception

Description copied from interface: MetamergeFolder

Returns a list of javax.naming.Binding objects for each of this folders child entries. The Binding object contains the name of the object as well as the object itself.

Specified by:

list in interface MetamergeFolder

Returns:

Enumeration of Binding objects

Throws:

Exception

getNames

public String[] getNames()
                  throws Exception

Description copied from interface: MetamergeFolder

This method returns an array of names contained in this folder.

Specified by:

getNames in interface MetamergeFolder

Returns:

The names value

Throws:

Exception

unbind

public void unbind(Object name)
            throws Exception

Description copied from interface: MetamergeConfig

Removes a named object from this configuration.

Specified by:

unbind in interface MetamergeConfig

Parameters:

name - The object name to remove

Throws:

Exception

bind

public void bind(Object name,
                 Object obj)
          throws Exception

Description copied from interface: MetamergeConfig

Adds a new object to the configuration at the location specified by name

Specified by:

bind in interface MetamergeConfig

Parameters:

name - Name

obj - Configuration Object

Throws:

Exception

rebind

public void rebind(Object name,
                   Object obj)
            throws Exception

Description copied from interface: MetamergeConfig

Adds or replaces a new object to the configuration.

Specified by:

rebind in interface MetamergeConfig

Parameters:

name - Name

obj - Configuration Object

Throws:

Exception

rename

public void rename(Object name,
                   Object newname)
            throws Exception

Description copied from interface: MetamergeConfig

Renames an object. If new name is a simple name then location is unchanged, otherwise the object is moved.

Specified by:

rename in interface MetamergeConfig

Parameters:

name - Current Name

newname - New name

Throws:

Exception

addNameComponent

public Object addNameComponent(Object name,
                               String component,
                               boolean prefix)

Description copied from interface: MetamergeConfig

Adds a name component to the NameComponent attribute of the MetamergeConfig object

Specified by:

addNameComponent in interface MetamergeConfig

Parameters:

name - Null or existing javax.naming.Name object

component - The component to add to name

prefix - If true, component is inserted at beginning of name

Returns:

The provided name or a new instance of javax.naming.Name

getVector

public static Vector getVector(BaseConfiguration base,
                               Object key)

getTreeMap

public static TreeMap getTreeMap(BaseConfiguration base,
                                 Object key)

getAssemblyLine

public AssemblyLineConfig getAssemblyLine(Object name)
                                   throws Exception

Description copied from interface: MetamergeConfig

Returns the AssemblyLineConfig object for the named assemblyline. Name can either be a simple name or a fully qualified name. For simple names, the config driver will lookup the assemblyline in its default folder for assemblylines.

Specified by:

getAssemblyLine in interface MetamergeConfig

Parameters:

name - Name

Returns:

The configuration object

Throws:

Exception

getConnector

public ConnectorConfig getConnector(Object name)
                             throws Exception

Description copied from interface: MetamergeConfig

Returns the ConnectorConfig object for the named connector. Name can either be a simple name or a fully qualified name. For simple names, the config driver will lookup the connector in its default folder for connectors.

Specified by:

getConnector in interface MetamergeConfig

Parameters:

name - Name

Returns:

The configuration object

Throws:

Exception

getParser

public ParserConfig getParser(Object name)
                       throws Exception

Description copied from interface: MetamergeConfig

Returns the ParserConfig object for the named parser. Name can either be a simple name or a fully qualified name. For simple names, the config driver will lookup the parser in its default folder for parsers.

Specified by:

getParser in interface MetamergeConfig

Parameters:

name - Name

Returns:

The configuration object

Throws:

Exception

getScript

public ScriptConfig getScript(Object name)
                       throws Exception

Description copied from interface: MetamergeConfig

Returns the ScriptConfig object for the named script. Name can either be a simple name or a fully qualified name. For simple names, the config driver will lookup the script in its default folder for scripts.

Specified by:

getScript in interface MetamergeConfig

Parameters:

name - Name

Returns:

The configuration object

Throws:

Exception

getFunction

public FunctionConfig getFunction(Object name)
                           throws Exception

Description copied from interface: MetamergeConfig

Returns the FunctionConfig object for the named function. Name can either be a simple name or a fully qualified name. For simple names, the config driver will lookup the script in its default folder for functions.

Specified by:

getFunction in interface MetamergeConfig

Parameters:

name - Name

Returns:

The configuration object

Throws:

Exception

getNamespace

public NamespaceConfig getNamespace(Object name)
                             throws Exception

Description copied from interface: MetamergeConfig

Returns the NamespaceConfig object for the named namespace. Name can either be a simple name or a fully qualified name. For simple names, the config driver will lookup the namespace in its default folder for namespaces.

Specified by:

getNamespace in interface MetamergeConfig

Parameters:

name - Name

Returns:

The configuration object

Throws:

Exception

newInstanceOf

public BaseConfiguration newInstanceOf(int type)
                                throws Exception

Create new instance of object

Specified by:

newInstanceOf in interface MetamergeConfig

Parameters:

type - The object type to create

Returns:

The newly created object.

Throws:

Exception

newInstanceOf

public BaseConfiguration newInstanceOf(Object typeName)
                                throws Exception

Description copied from interface: MetamergeConfig

This method returns a new instance of the object type specified by typeName. Use the default folder names constants to denote the type. The new object is not added to the configuration.

Specified by:

newInstanceOf in interface MetamergeConfig

Parameters:

typeName - The object type to create.

Returns:

The newly created object.

Throws:

Exception

toString

public String toString()

Description copied from class: BaseConfigurationImpl

Answers a string containing the name of the config.

Overrides:

toString in class BaseConfigurationImpl

Returns:

a printable representation of the name

getExternalProperties

public ExternalPropertiesConfig getExternalProperties()
                                               throws Exception

Returns the external properties delegator object for this configuration.

Specified by:

getExternalProperties in interface MetamergeConfig

Returns:

The ExternalPropertiesConfig value

Throws:

Exception

getExternalProperties

public ExternalPropertiesConfig getExternalProperties(Object name)
                                               throws Exception

Returns the ExternalPropertiesConfig object for the named external properties object. Name can either be a simple name or a fully qualified name. For simple names, the config driver will lookup the object in the default folder for external properties.

Specified by:

getExternalProperties in interface MetamergeConfig

Parameters:

name - The external property object name

Returns:

The ExternalPropertiesConfig object

Throws:

Exception

logmsg

public void logmsg(String msg)

getDriverParameters

public BaseConfiguration getDriverParameters()
                                      throws Exception

This method returns the driver parameters as a BaseConfiguration object.

Specified by:

getDriverParameters in interface MetamergeConfig

Returns:

The newly created object.

Throws:

Exception

setDriverParameters

public void setDriverParameters(BaseConfiguration driverParams)
                         throws Exception

This method sets the driver parameters from a BaseConfiguration object.

Specified by:

setDriverParameters in interface MetamergeConfig

Parameters:

driverParams - The driver parameters

Throws:

Exception

getDriverParameter

public Object getDriverParameter(Object name)
                          throws Exception

This method returns the value for a given driver parameter.

Specified by:

getDriverParameter in interface MetamergeConfig

Parameters:

name - The name of the driver parameter to retrieve.

Returns:

The driver parameter value

Throws:

Exception

setDriverParameter

public void setDriverParameter(Object name,
                               Object value)
                        throws Exception

This method sets a driver parameter.

Specified by:

setDriverParameter in interface MetamergeConfig

Parameters:

name - The driver parameter name

value - The driver parameter value

Throws:

Exception

setFileConfig

public void setFileConfig(FileConfig aFileConfig)

getFileConfig

public FileConfig getFileConfig()

isRemote

public boolean isRemote()

Specified by:

isRemote in interface MetamergeConfig

instantiateAllObjects

public void instantiateAllObjects()
                           throws Exception

This method iterates the entire configuration to create java objects from the config drivers underlying store. This is needed when all references to other namespaces must be resolved (system and others).

Specified by:

instantiateAllObjects in interface MetamergeConfig

Throws:

Exception

instantiateAllObjects

public void instantiateAllObjects(MetamergeFolder folder)
                           throws Exception

Throws:

Exception

getTDIProperties

public TDIProperties getTDIProperties()
                               throws Exception

This method returns the associated TDIProperties object

Specified by:

getTDIProperties in interface MetamergeConfig

Throws:

Exception

getSolutionInterface

public SolutionInterface getSolutionInterface()

Description copied from interface: MetamergeConfig

This method returns the SolutionInterface object for this configuration.

Specified by:

getSolutionInterface in interface MetamergeConfig

getConfigVersion

public String getConfigVersion()

Specified by:

getConfigVersion in interface MetamergeConfig

Returns:

The version of the configuration. e.g. "6.1.1", "7.0", "7.1", etc.

getDirectory

public String getDirectory()

Description copied from interface: MetamergeConfig

Returns the directory this config is placed in. If nothing can be determined, returns "."

Specified by:

getDirectory in interface MetamergeConfig

Returns:

The directory this config is placed in.