com.ibm.di.config.xml
Class MetamergeConfigXML

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

All Implemented Interfaces:

BaseConfiguration, MetamergeConfig, MetamergeConfigChangeListener, MetamergeFolder, Serializable

Direct Known Subclasses:

MetamergeConfigFS

public class MetamergeConfigXML
extends MetamergeConfigImpl

MetamergeConfigXML is a class that provides support for TDI XML configuration files. It can create new configurations, load and store existing ones. This class provides access to the structure of a TDI configuration as well to its current status.

See Also:

Serialized Form

Field Summary

static String	IDI_CREATED
static String	IDI_VERSION
static String	METAMERGE_CONFIG_TAG
static String	METAMERGE_CREATED_TAG
static String	METAMERGE_CREATEDBY_TAG
static String	METAMERGE_MODIFIED_TAG
static String	METAMERGE_MODIFIEDBY_TAG
static String	METAMERGE_VERSION_ID
static String	METAMERGE_VERSION_TAG
static String	SERVER_ENCRYPTED_SIGNATURE

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

classMap, DEFAULT_FOLDER_IMPL, DEFAULT_FOLDER_NAMES, env, externalPropertiesDelegator, 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

MetamergeConfigXML()

MetamergeConfigXML(Hashtable<String,Object> env)

Method Summary

void	bind(Object name, Object obj) Adds a new object to the configuration at the location specified by name
void	commitChanges(Object output, boolean isSave) Save XML tree to output stream.
MetamergeFolder	createFolder(Object name) This method creates a folder
void	debug(String msg)
Element	findByName(Element root, Object name) This method traverses the document tree searching for an element with an attribute (name) equal to name.
Element	findOneByName(Element root, String name) This method searches the children of an element for an element with an attribute (name) equal to name.
protected ConfigCache	getCache()
String	getConfigVersion()
String	getDirectory() Returns the directory this config is placed in.
Document	getDocument() Returns the XML document object.
boolean	getModified() XML Doc needs to be saved if we have dirty objects in our cache or if there has been any successful bind/rebind/unbind calls.
OutputStream	getOutputStream(Object out) Returns the output stream to which the XML document is written.
Element	getRootElement() Returns the root element of the XML document.
String	getShortName() Gets the shortName attribute of the BaseConfiguration object.
void	initializeConfig() Initializes the XML configuration, including the reading and parsing of the XML file.
protected Object	internalLookup(Object namex) Called by super's lookup
boolean	isCommittable() Returns true if the configuration driver implements the commitChanges method and the current value for PROVIDER_URL is writable.
boolean	isDebugMode()
boolean	isOldVersion()
boolean	isReadOnly() Returns true if this configuration cannot be modified.
boolean	isRemote()
Enumeration<Binding>	list() This method returns an enumeration with the names in the given folder.
Enumeration<Binding>	list(Object name) Returns an enumeration of the immediate children of this node
void	logmsg(String msg)
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.
protected void	removeElement(Object name)
void	rename(Object name, Object newname) Renames an object.
void	setOutput(Object output) Changes the output to wich the configuration driver writes its configuration.
void	unbind(Object name) Removes a named object from this configuration.

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

addDefaultFolders, addNameComponent, closeConfig, commitChanges, copy, getAssemblyLine, getConnector, getDefaultFolder, getDriverParameter, getDriverParameters, getExternalProperties, getExternalProperties, getFileConfig, getFunction, getNames, getNamespace, getParser, getPassword, getScript, getSolutionInterface, getTDIProperties, getTreeMap, getVector, hasPassword, initializeClassMap, instantiateAllObjects, instantiateAllObjects, lookup, lookupInFolder, newInstanceOf, setDriverParameter, setDriverParameters, setFileConfig, toString, 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, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterPropertySourceFromValue, getParameterRaw, getParent, getParentName, getPath, getReferences, getResHash, getScript, getScriptEngine, 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, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterRaw, getParent, getPath, getReferences, getScript, getScriptEngine, 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

SERVER_ENCRYPTED_SIGNATURE

public static final String SERVER_ENCRYPTED_SIGNATURE

See Also:

Constant Field Values

METAMERGE_CONFIG_TAG

public static final String METAMERGE_CONFIG_TAG

See Also:

Constant Field Values

METAMERGE_VERSION_TAG

public static final String METAMERGE_VERSION_TAG

See Also:

Constant Field Values

METAMERGE_CREATED_TAG

public static final String METAMERGE_CREATED_TAG

See Also:

Constant Field Values

METAMERGE_CREATEDBY_TAG

public static final String METAMERGE_CREATEDBY_TAG

See Also:

Constant Field Values

METAMERGE_MODIFIED_TAG

public static final String METAMERGE_MODIFIED_TAG

See Also:

Constant Field Values

METAMERGE_MODIFIEDBY_TAG

public static final String METAMERGE_MODIFIEDBY_TAG

See Also:

Constant Field Values

METAMERGE_VERSION_ID

public static final String METAMERGE_VERSION_ID

See Also:

Constant Field Values

IDI_VERSION

public static final String IDI_VERSION

See Also:

Constant Field Values

IDI_CREATED

public static final String IDI_CREATED

See Also:

Constant Field Values

Constructor Detail

MetamergeConfigXML

public MetamergeConfigXML()

MetamergeConfigXML

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

Throws:

Exception

Method Detail

getConfigVersion

public String getConfigVersion()

Specified by:

getConfigVersion in interface MetamergeConfig

Overrides:

getConfigVersion in class MetamergeConfigImpl

Returns:

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

isOldVersion

public boolean isOldVersion()

logmsg

public void logmsg(String msg)

Overrides:

logmsg in class MetamergeConfigImpl

debug

public void debug(String msg)

isDebugMode

public boolean isDebugMode()

Returns:

true if debug is enabled. Otherwise, false is returned.

initializeConfig

public void initializeConfig()
                      throws Exception

Initializes the XML configuration, including the reading and parsing of the XML file.

Specified by:

initializeConfig in interface MetamergeConfig

Overrides:

initializeConfig in class MetamergeConfigImpl

Throws:

Exception

internalLookup

protected Object internalLookup(Object namex)
                         throws Exception

Called by super's lookup

Overrides:

internalLookup in class MetamergeConfigImpl

Throws:

Exception

list

public Enumeration<Binding> list()
                          throws Exception

This method returns an enumeration with the names in the given folder. If the name does does not name a folder an exception is thrown.

Specified by:

list in interface MetamergeFolder

Overrides:

list in class MetamergeConfigImpl

Returns:

Enumeration of Binding objects

Throws:

Exception

list

public Enumeration<Binding> 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

Overrides:

list in class MetamergeConfigImpl

Parameters:

name - The folder name to list

Returns:

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

Throws:

Exception

createFolder

public MetamergeFolder createFolder(Object name)
                             throws Exception

This method creates a folder

Specified by:

createFolder in interface MetamergeFolder

Overrides:

createFolder in class MetamergeConfigImpl

Parameters:

name - Name of sub-folder

Returns:

The MetamergeFolder object representing the new sub-folder

Throws:

Exception

findByName

public Element findByName(Element root,
                          Object name)
                   throws Exception

This method traverses the document tree searching for an element with an attribute (name) equal to name.

Throws:

Exception

findOneByName

public Element findOneByName(Element root,
                             String name)

This method searches the children of an element for an element with an attribute (name) equal to name.

getRootElement

public Element getRootElement()

Returns the root element of the XML document.

getDocument

public Document getDocument()

Returns the XML document object.

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

Overrides:

bind in class MetamergeConfigImpl

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

Overrides:

rebind in class MetamergeConfigImpl

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

Overrides:

rename in class MetamergeConfigImpl

Parameters:

name - Current Name

newname - New name

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

Overrides:

unbind in class MetamergeConfigImpl

Parameters:

name - The object name to remove

Throws:

Exception

removeElement

protected void removeElement(Object name)
                      throws Exception

Throws:

Exception

commitChanges

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

Save XML tree to output stream.

Specified by:

commitChanges in interface MetamergeConfig

Overrides:

commitChanges in class MetamergeConfigImpl

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

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

Overrides:

setOutput in class MetamergeConfigImpl

Parameters:

output - The new output value

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

Overrides:

isCommittable in class MetamergeConfigImpl

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

Overrides:

isReadOnly in class MetamergeConfigImpl

Returns:

The readOnly value

getModified

public boolean getModified()

XML Doc needs to be saved if we have dirty objects in our cache or if there has been any successful bind/rebind/unbind calls.

Specified by:

getModified in interface BaseConfiguration

Overrides:

getModified in class BaseConfigurationImpl

Returns:

the modified state.

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

Overrides:

newInstanceOf in class MetamergeConfigImpl

Parameters:

typeName - The object type to create.

Returns:

The newly created object.

Throws:

Exception

getOutputStream

public OutputStream getOutputStream(Object out)
                             throws Exception

Returns the output stream to which the XML document is written. Called by commitChanges.

Throws:

Exception

isRemote

public boolean isRemote()

Specified by:

isRemote in interface MetamergeConfig

Overrides:

isRemote in class MetamergeConfigImpl

getShortName

public String getShortName()

Description copied from class: BaseConfigurationImpl

Gets the shortName attribute of the BaseConfiguration object. The short name is the last component in a multi component name. E.g.: AssemblyLines/MyName --> "MyName"

Specified by:

getShortName in interface BaseConfiguration

Overrides:

getShortName in class BaseConfigurationImpl

Returns:

The shortName value

getCache

protected ConfigCache getCache()

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

Overrides:

getDirectory in class MetamergeConfigImpl

Returns:

The directory this config is placed in.