com.ibm.di.config.interfaces
Interface MetamergeConfig

All Superinterfaces:

BaseConfiguration, MetamergeFolder, Serializable

All Known Implementing Classes:

FileNamespace, MetamergeConfigFS, MetamergeConfigImpl, MetamergeConfigXML

public interface MetamergeConfig
extends MetamergeFolder

The MetamergeConfig interface specifies the methods used by the IBM Tivoli Directory Integrator to obtain configuration information. The configuration interface is a hierarchical tree of objects and each object's unique name is composed of a number of strings separated by a slash (see MetamergeConfigFactory). If the implementor chooses another naming schema it should perform a name mapping between the slash separated naming and its own local naming schema. Instantiation of a MetamergeConfig object should always performed by the MetamergeConfigFactory. The latter builds a Hashtable of parameters which is passed to the implementation of this interface.

Field Summary

static int	ASSEMBLYLINE_FOLDER
static int	ATTRIBUTEMAP_FOLDER
static int	CONFIG_FOLDER
static int	CONNECTOR_FOLDER
static String	DEFAULT_ASSEMBLYLINE_FOLDER
static String	DEFAULT_ATTRIBUTEMAP_FOLDER
static String	DEFAULT_CONFIG_FOLDER
static String	DEFAULT_CONNECTOR_FOLDER
static String	DEFAULT_EXTPROP_FOLDER
static String	DEFAULT_EXTPROP_NAME the following constants name the reserved names in various folders.
static String	DEFAULT_FORM_FOLDER
static String	DEFAULT_FUNCTION_FOLDER
static String	DEFAULT_LIBRARY_FOLDER
static String	DEFAULT_LIBS_FOLDER The following String constants can be used to lookup or create default folders using lookup or newInstanceOf(String).
static String	DEFAULT_LOGGER_FOLDER
static String	DEFAULT_NAMESPACE_FOLDER
static String	DEFAULT_PARSER_FOLDER
static String	DEFAULT_PROPERTY_FOLDER
static String	DEFAULT_PROPSTORE_FOLDER
static String	DEFAULT_SCRIPT_FOLDER
static String	DEFAULT_SERVER_AUTOSTART
static String	DEFAULT_SERVER_FOLDER
static String	DEFAULT_SERVER_INSTANCE_PROPERTIES
static String	DEFAULT_SERVER_LOG
static String	DEFAULT_SERVER_TOMBSTONES
static String	DEFAULT_SOLUTION_INTERFACE
static int	EXTPROP_FOLDER
static int	FORM_FOLDER
static int	FUNCTION_FOLDER
static int	LIBRARY_FOLDER
static int	LIBS_FOLDER The following constants are used to lookup or create folders using lookup or newInstanceOf(int)
static int	LOGGER_FOLDER
static int	LOGGING_FOLDER
static int	NAMESPACE_FOLDER
static int	PARSER_FOLDER
static int	PROPERTY_FOLDER
static int	PROPSTORE_FOLDER
static int	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

Method Summary

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.
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() Deprecated. use getTDIProperties() instead
ExternalPropertiesConfig	getExternalProperties(Object name) Deprecated. use getTDIProperties() instead
FunctionConfig	getFunction(Object name) Returns the FunctionConfig object for the named function.
NamespaceConfig	getNamespace(Object name) Returns the NamespaceConfig object for the named namespace.
ParserConfig	getParser(Object name) Returns the ParserConfig object for the named parser.
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
void	initializeConfig() Initialize the driver
void	instantiateAllObjects() This method iterates the entire configuration to create java objects from the config drivers underlying store.
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(Object name) Returns an enumeration of the immediate children of this node
Object	lookup(Object name) Searches this configuration for a named node.
BaseConfiguration	newInstanceOf(int type) This method returns a new instance of the object type specified by type.
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	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 interface com.ibm.di.config.interfaces.MetamergeFolder

createFolder, getNames, list

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

DEFAULT_LIBS_FOLDER

static final String DEFAULT_LIBS_FOLDER

The following String constants can be used to lookup or create default folders using lookup or newInstanceOf(String).

See Also:

Constant Field Values

DEFAULT_ASSEMBLYLINE_FOLDER

static final String DEFAULT_ASSEMBLYLINE_FOLDER

See Also:

Constant Field Values

DEFAULT_CONNECTOR_FOLDER

static final String DEFAULT_CONNECTOR_FOLDER

See Also:

Constant Field Values

DEFAULT_PARSER_FOLDER

static final String DEFAULT_PARSER_FOLDER

See Also:

Constant Field Values

DEFAULT_SCRIPT_FOLDER

static final String DEFAULT_SCRIPT_FOLDER

See Also:

Constant Field Values

DEFAULT_LIBRARY_FOLDER

static final String DEFAULT_LIBRARY_FOLDER

See Also:

Constant Field Values

DEFAULT_PROPERTY_FOLDER

static final String DEFAULT_PROPERTY_FOLDER

See Also:

Constant Field Values

DEFAULT_NAMESPACE_FOLDER

static final String DEFAULT_NAMESPACE_FOLDER

See Also:

Constant Field Values

DEFAULT_FORM_FOLDER

static final String DEFAULT_FORM_FOLDER

See Also:

Constant Field Values

DEFAULT_EXTPROP_FOLDER

static final String DEFAULT_EXTPROP_FOLDER

See Also:

Constant Field Values

DEFAULT_SERVER_FOLDER

static final String DEFAULT_SERVER_FOLDER

See Also:

Constant Field Values

DEFAULT_CONFIG_FOLDER

static final String DEFAULT_CONFIG_FOLDER

See Also:

Constant Field Values

DEFAULT_FUNCTION_FOLDER

static final String DEFAULT_FUNCTION_FOLDER

See Also:

Constant Field Values

DEFAULT_ATTRIBUTEMAP_FOLDER

static final String DEFAULT_ATTRIBUTEMAP_FOLDER

See Also:

Constant Field Values

DEFAULT_PROPSTORE_FOLDER

static final String DEFAULT_PROPSTORE_FOLDER

See Also:

Constant Field Values

DEFAULT_LOGGER_FOLDER

static final String DEFAULT_LOGGER_FOLDER

See Also:

Constant Field Values

DEFAULT_SOLUTION_INTERFACE

static final String DEFAULT_SOLUTION_INTERFACE

See Also:

Constant Field Values

DEFAULT_EXTPROP_NAME

static final String DEFAULT_EXTPROP_NAME

the following constants name the reserved names in various folders.

See Also:

Constant Field Values

DEFAULT_SERVER_LOG

static final String DEFAULT_SERVER_LOG

See Also:

Constant Field Values

DEFAULT_SERVER_AUTOSTART

static final String DEFAULT_SERVER_AUTOSTART

See Also:

Constant Field Values

DEFAULT_SERVER_TOMBSTONES

static final String DEFAULT_SERVER_TOMBSTONES

See Also:

Constant Field Values

DEFAULT_SERVER_INSTANCE_PROPERTIES

static final String DEFAULT_SERVER_INSTANCE_PROPERTIES

See Also:

Constant Field Values

LIBS_FOLDER

static final int LIBS_FOLDER

The following constants are used to lookup or create folders using lookup or newInstanceOf(int)

See Also:

Constant Field Values

ASSEMBLYLINE_FOLDER

static final int ASSEMBLYLINE_FOLDER

See Also:

Constant Field Values

CONNECTOR_FOLDER

static final int CONNECTOR_FOLDER

See Also:

Constant Field Values

PARSER_FOLDER

static final int PARSER_FOLDER

See Also:

Constant Field Values

SCRIPT_FOLDER

static final int SCRIPT_FOLDER

See Also:

Constant Field Values

LIBRARY_FOLDER

static final int LIBRARY_FOLDER

See Also:

Constant Field Values

PROPERTY_FOLDER

static final int PROPERTY_FOLDER

See Also:

Constant Field Values

NAMESPACE_FOLDER

static final int NAMESPACE_FOLDER

See Also:

Constant Field Values

FORM_FOLDER

static final int FORM_FOLDER

See Also:

Constant Field Values

EXTPROP_FOLDER

static final int EXTPROP_FOLDER

See Also:

Constant Field Values

CONFIG_FOLDER

static final int CONFIG_FOLDER

See Also:

Constant Field Values

LOGGING_FOLDER

static final int LOGGING_FOLDER

See Also:

Constant Field Values

FUNCTION_FOLDER

static final int FUNCTION_FOLDER

See Also:

Constant Field Values

ATTRIBUTEMAP_FOLDER

static final int ATTRIBUTEMAP_FOLDER

See Also:

Constant Field Values

PROPSTORE_FOLDER

static final int PROPSTORE_FOLDER

See Also:

Constant Field Values

LOGGER_FOLDER

static final int LOGGER_FOLDER

See Also:

Constant Field Values

Method Detail

list

Enumeration list(Object name)
                 throws Exception

Returns an enumeration of the immediate children of this node

Parameters:

name - The folder name to list

Returns:

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

Throws:

Exception

lookup

Object lookup(Object name)
              throws Exception

Searches this configuration for a named node.

Parameters:

name - The name to lookup

Returns:

The configuration object found

Throws:

Exception

unbind

void unbind(Object name)
            throws Exception

Removes a named object from this configuration.

Parameters:

name - The object name to remove

Throws:

Exception

bind

void bind(Object name,
          Object obj)
          throws Exception

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

Parameters:

name - Name

obj - Configuration Object

Throws:

Exception

rebind

void rebind(Object name,
            Object obj)
            throws Exception

Adds or replaces a new object to the configuration.

Parameters:

name - Name

obj - Configuration Object

Throws:

Exception

rename

void rename(Object name,
            Object newName)
            throws Exception

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

Parameters:

name - Current Name

newName - New name

Throws:

Exception

commitChanges

void commitChanges(Object output,
                   boolean isSave)
                   throws Exception

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.

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

commitChanges

void commitChanges(Object output)
                   throws Exception

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

Parameters:

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

Throws:

Exception

isCommittable

boolean isCommittable()

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

Returns:

The committable state

isReadOnly

boolean isReadOnly()

Returns true if this configuration cannot be modified.

Returns:

The readOnly value

setOutput

void setOutput(Object output)
               throws Exception

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).

Parameters:

output - The new output value

Throws:

Exception

initializeConfig

void initializeConfig()
                      throws Exception

Initialize the driver

Throws:

Exception

closeConfig

void closeConfig()
                 throws Exception

Close the driver

Throws:

Exception

copy

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

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.

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

getExternalProperties

@Deprecated
ExternalPropertiesConfig getExternalProperties()
                                               throws Exception

Deprecated. use getTDIProperties() instead

Returns the external properties delegator object for this configuration.

Returns:

The ExternalPropertiesConfig value

Throws:

Exception

getExternalProperties

@Deprecated
ExternalPropertiesConfig getExternalProperties(Object name)
                                               throws Exception

Deprecated. use getTDIProperties() instead

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.

Parameters:

name - The external property object name

Returns:

The ExternalPropertiesConfig object

Throws:

Exception

addNameComponent

Object addNameComponent(Object name,
                        String component,
                        boolean prefix)
                        throws Exception

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

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

Throws:

Exception

getAssemblyLine

AssemblyLineConfig getAssemblyLine(Object name)
                                   throws Exception

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.

Parameters:

name - Name

Returns:

The configuration object

Throws:

Exception

getConnector

ConnectorConfig getConnector(Object name)
                             throws Exception

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.

Parameters:

name - Name

Returns:

The configuration object

Throws:

Exception

getParser

ParserConfig getParser(Object name)
                       throws Exception

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.

Parameters:

name - Name

Returns:

The configuration object

Throws:

Exception

getScript

ScriptConfig getScript(Object name)
                       throws Exception

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.

Parameters:

name - Name

Returns:

The configuration object

Throws:

Exception

getFunction

FunctionConfig getFunction(Object name)
                           throws Exception

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.

Parameters:

name - Name

Returns:

The configuration object

Throws:

Exception

getNamespace

NamespaceConfig getNamespace(Object name)
                             throws Exception

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.

Parameters:

name - Name

Returns:

The configuration object

Throws:

Exception

getDefaultFolder

MetamergeFolder getDefaultFolder(int folder)
                                 throws Exception

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

Parameters:

folder - The default folder constant

Returns:

The Folder object

Throws:

Exception

newInstanceOf

BaseConfiguration newInstanceOf(Object typeName)
                                throws Exception

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.

Parameters:

typeName - The object type to create.

Returns:

The newly created object.

Throws:

Exception

newInstanceOf

BaseConfiguration newInstanceOf(int type)
                                throws Exception

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

Parameters:

type - The object type to create

Returns:

The newly created object.

Throws:

Exception

getDriverParameters

BaseConfiguration getDriverParameters()
                                      throws Exception

This method returns the driver parameters as a BaseConfiguration object.

Returns:

The newly created object.

Throws:

Exception

setDriverParameters

void setDriverParameters(BaseConfiguration driverParams)
                         throws Exception

This method sets the driver parameters from a BaseConfiguration object.

Parameters:

driverParams - The driver parameters

Throws:

Exception

getDriverParameter

Object getDriverParameter(Object name)
                          throws Exception

This method returns the value for a given driver parameter.

Parameters:

name - The name of the driver parameter ot get.

Returns:

The driver parameter value

Throws:

Exception

setDriverParameter

void setDriverParameter(Object name,
                        Object value)
                        throws Exception

This method sets a driver parameter.

Parameters:

name - The driver parameter name

value - The driver parameter value

Throws:

Exception

isRemote

boolean isRemote()

instantiateAllObjects

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).

Throws:

Exception

getTDIProperties

TDIProperties getTDIProperties()
                               throws Exception

This method returns the associated TDIProperties object

Throws:

Exception

getSolutionInterface

SolutionInterface getSolutionInterface()

This method returns the SolutionInterface object for this configuration.

getConfigVersion

String getConfigVersion()

Returns:

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

Since:

7.0

getDirectory

String getDirectory()

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

Returns:

The directory this config is placed in.

Since:

7.0