|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MetamergeConfig
The MetamergeConfig interface specifies the methods used by the IBM Security 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 java.lang.String |
DEFAULT_ASSEMBLYLINE_FOLDER
|
static java.lang.String |
DEFAULT_ATTRIBUTEMAP_FOLDER
|
static java.lang.String |
DEFAULT_CONFIG_FOLDER
|
static java.lang.String |
DEFAULT_CONNECTOR_FOLDER
|
static java.lang.String |
DEFAULT_EXTPROP_FOLDER
|
static java.lang.String |
DEFAULT_EXTPROP_NAME
the following constants name the reserved names in various folders. |
static java.lang.String |
DEFAULT_FORM_FOLDER
|
static java.lang.String |
DEFAULT_FUNCTION_FOLDER
|
static java.lang.String |
DEFAULT_LIBRARY_FOLDER
|
static java.lang.String |
DEFAULT_LIBS_FOLDER
The following String constants can be used to lookup or create default folders using lookup or newInstanceOf(String). |
static java.lang.String |
DEFAULT_LOGGER_FOLDER
|
static java.lang.String |
DEFAULT_NAMESPACE_FOLDER
|
static java.lang.String |
DEFAULT_PARSER_FOLDER
|
static java.lang.String |
DEFAULT_PROPERTY_FOLDER
|
static java.lang.String |
DEFAULT_PROPSTORE_FOLDER
|
static java.lang.String |
DEFAULT_SCHEDULER_FOLDER
|
static java.lang.String |
DEFAULT_SCRIPT_FOLDER
|
static java.lang.String |
DEFAULT_SEQUENCE_FOLDER
|
static java.lang.String |
DEFAULT_SERVER_AUTOSTART
|
static java.lang.String |
DEFAULT_SERVER_FOLDER
|
static java.lang.String |
DEFAULT_SERVER_INSTANCE_PROPERTIES
|
static java.lang.String |
DEFAULT_SERVER_LOG
|
static java.lang.String |
DEFAULT_SERVER_TOMBSTONES
|
static java.lang.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 |
SCHEDULER_FOLDER
|
static int |
SCRIPT_FOLDER
|
static int |
SEQUENCE_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 | ||
---|---|---|
java.lang.Object |
addNameComponent(java.lang.Object name,
java.lang.String component,
boolean prefix)
Adds a name component to the NameComponent attribute of the MetamergeConfig object |
|
void |
bind(java.lang.Object name,
java.lang.Object obj)
Adds a new object to the configuration at the location specified by name |
|
void |
closeConfig()
Close the driver |
|
void |
commitChanges(java.lang.Object output)
Tells the configuration driver to save all modified objects. |
|
void |
commitChanges(java.lang.Object output,
boolean isSave)
Tells the configuration driver to save all modified objects. |
|
void |
commitChangesNoEncryption(java.lang.Object output)
Writes the configuration to output without server encryption of protected parameters. |
|
void |
copy(BaseConfiguration input,
java.lang.Object destination,
boolean copyRefs)
Copies a configuration object into this configuration. |
|
AssemblyLineConfig |
getAssemblyLine(java.lang.Object name)
Returns the AssemblyLineConfig object for the named assemblyline. |
|
AttributeMapConfig |
getAttributeMap(java.lang.Object name)
Returns the AttributeMapConfig object for the named map. |
|
java.lang.String |
getConfigVersion()
|
|
ConnectorConfig |
getConnector(java.lang.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. |
|
java.lang.String |
getDirectory()
Returns the directory this config is placed in. |
|
java.lang.Object |
getDriverParameter(java.lang.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(java.lang.Object name)
Deprecated. use getTDIProperties() instead |
|
FunctionConfig |
getFunction(java.lang.Object name)
Returns the FunctionConfig object for the named function. |
|
NamespaceConfig |
getNamespace(java.lang.Object name)
Returns the NamespaceConfig object for the named namespace. |
|
ParserConfig |
getParser(java.lang.Object name)
Returns the ParserConfig object for the named parser. |
|
ScriptConfig |
getScript(java.lang.Object name)
Returns the ScriptConfig object for the named script. |
|
SequenceConfig |
getSequence(java.lang.Object name)
Returns the SequenceConfig object for the named sequence. |
|
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 |
isModTSEnabled()
Returns the value of modTSEnabled For internal use. |
|
boolean |
isReadOnly()
Returns true if this configuration cannot be modified. |
|
boolean |
isRemote()
|
|
java.util.Enumeration |
list(java.lang.Object name)
Returns an enumeration of the immediate children of this node |
|
java.lang.Object |
lookup(java.lang.Object name)
Searches this configuration for a named node. |
|
|
newInstanceOf(java.lang.Class<T> cls)
This method returns a new instance of the object type. |
|
BaseConfiguration |
newInstanceOf(int type)
This method returns a new instance of the object type specified by type. |
|
BaseConfiguration |
newInstanceOf(java.lang.Object typeName)
This method returns a new instance of the object type specified by typeName. |
|
void |
rebind(java.lang.Object name,
java.lang.Object obj)
Adds or replaces a new object to the configuration. |
|
void |
rename(java.lang.Object name,
java.lang.Object newName)
Renames an object. |
|
void |
setDriverParameter(java.lang.Object name,
java.lang.Object value)
This method sets a driver parameter. |
|
void |
setDriverParameters(BaseConfiguration driverParams)
This method sets the driver parameters from a BaseConfiguration object. |
|
void |
setModTSEnabled(boolean value)
Sets the value of modTSEnabled For internal use. |
|
void |
setOutput(java.lang.Object output)
Changes the output to wich the configuration driver writes its configuration. |
|
boolean |
shouldEncryptProtected()
Return true if protected parameters should be encrypted with server key. |
|
void |
unbind(java.lang.Object name)
Removes a named object from this configuration. |
Methods inherited from interface com.ibm.di.config.interfaces.MetamergeFolder |
---|
createFolder, getNames, list |
Field Detail |
---|
static final java.lang.String DEFAULT_LIBS_FOLDER
static final java.lang.String DEFAULT_ASSEMBLYLINE_FOLDER
static final java.lang.String DEFAULT_CONNECTOR_FOLDER
static final java.lang.String DEFAULT_PARSER_FOLDER
static final java.lang.String DEFAULT_SCRIPT_FOLDER
static final java.lang.String DEFAULT_LIBRARY_FOLDER
static final java.lang.String DEFAULT_PROPERTY_FOLDER
static final java.lang.String DEFAULT_NAMESPACE_FOLDER
static final java.lang.String DEFAULT_FORM_FOLDER
static final java.lang.String DEFAULT_EXTPROP_FOLDER
static final java.lang.String DEFAULT_SERVER_FOLDER
static final java.lang.String DEFAULT_CONFIG_FOLDER
static final java.lang.String DEFAULT_FUNCTION_FOLDER
static final java.lang.String DEFAULT_ATTRIBUTEMAP_FOLDER
static final java.lang.String DEFAULT_PROPSTORE_FOLDER
static final java.lang.String DEFAULT_LOGGER_FOLDER
static final java.lang.String DEFAULT_SCHEDULER_FOLDER
static final java.lang.String DEFAULT_SEQUENCE_FOLDER
static final java.lang.String DEFAULT_SOLUTION_INTERFACE
static final java.lang.String DEFAULT_EXTPROP_NAME
static final java.lang.String DEFAULT_SERVER_LOG
static final java.lang.String DEFAULT_SERVER_AUTOSTART
static final java.lang.String DEFAULT_SERVER_TOMBSTONES
static final java.lang.String DEFAULT_SERVER_INSTANCE_PROPERTIES
static final int LIBS_FOLDER
static final int ASSEMBLYLINE_FOLDER
static final int CONNECTOR_FOLDER
static final int PARSER_FOLDER
static final int SCRIPT_FOLDER
static final int LIBRARY_FOLDER
static final int PROPERTY_FOLDER
static final int NAMESPACE_FOLDER
static final int FORM_FOLDER
static final int EXTPROP_FOLDER
static final int CONFIG_FOLDER
static final int LOGGING_FOLDER
static final int FUNCTION_FOLDER
static final int ATTRIBUTEMAP_FOLDER
static final int PROPSTORE_FOLDER
static final int LOGGER_FOLDER
static final int SCHEDULER_FOLDER
static final int SEQUENCE_FOLDER
Method Detail |
---|
java.util.Enumeration list(java.lang.Object name) throws java.lang.Exception
name
- The folder name to list
java.lang.Exception
java.lang.Object lookup(java.lang.Object name) throws java.lang.Exception
name
- The name to lookup
java.lang.Exception
void unbind(java.lang.Object name) throws java.lang.Exception
name
- The object name to remove
java.lang.Exception
void bind(java.lang.Object name, java.lang.Object obj) throws java.lang.Exception
name
- Nameobj
- Configuration Object
java.lang.Exception
void rebind(java.lang.Object name, java.lang.Object obj) throws java.lang.Exception
name
- Nameobj
- Configuration Object
java.lang.Exception
void rename(java.lang.Object name, java.lang.Object newName) throws java.lang.Exception
name
- Current NamenewName
- New name
java.lang.Exception
void commitChanges(java.lang.Object output, boolean isSave) throws java.lang.Exception
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.
java.lang.Exception
void commitChanges(java.lang.Object output) throws java.lang.Exception
output
- Null or any object supported by the underlying driver.
java.lang.Exception
boolean isCommittable()
boolean isReadOnly()
void setOutput(java.lang.Object output) throws java.lang.Exception
output
- The new output value
java.lang.Exception
void initializeConfig() throws java.lang.Exception
java.lang.Exception
void closeConfig() throws java.lang.Exception
java.lang.Exception
void copy(BaseConfiguration input, java.lang.Object destination, boolean copyRefs) throws java.lang.Exception
input
- Configuration object to be copieddestination
- The name of the destination object (javax.naming.Name or
String)copyRefs
- If true, copy referenced objects as well (e.g. all inherited
objects)
java.lang.Exception
@Deprecated ExternalPropertiesConfig getExternalProperties() throws java.lang.Exception
getTDIProperties()
instead
java.lang.Exception
@Deprecated ExternalPropertiesConfig getExternalProperties(java.lang.Object name) throws java.lang.Exception
getTDIProperties()
instead
name
- The external property object name
java.lang.Exception
java.lang.Object addNameComponent(java.lang.Object name, java.lang.String component, boolean prefix) throws java.lang.Exception
name
- Null or existing javax.naming.Name objectcomponent
- The component to add to nameprefix
- If true, component is inserted at beginning of name
java.lang.Exception
AssemblyLineConfig getAssemblyLine(java.lang.Object name) throws java.lang.Exception
name
- Name
java.lang.Exception
SequenceConfig getSequence(java.lang.Object name) throws java.lang.Exception
name
- The name of the sequence
java.lang.Exception
ConnectorConfig getConnector(java.lang.Object name) throws java.lang.Exception
name
- Name
java.lang.Exception
ParserConfig getParser(java.lang.Object name) throws java.lang.Exception
name
- Name
java.lang.Exception
ScriptConfig getScript(java.lang.Object name) throws java.lang.Exception
name
- Name
java.lang.Exception
FunctionConfig getFunction(java.lang.Object name) throws java.lang.Exception
name
- Name
java.lang.Exception
AttributeMapConfig getAttributeMap(java.lang.Object name) throws java.lang.Exception
name
- Name
java.lang.Exception
NamespaceConfig getNamespace(java.lang.Object name) throws java.lang.Exception
name
- Name
java.lang.Exception
MetamergeFolder getDefaultFolder(int folder) throws java.lang.Exception
folder
- The default folder constant
java.lang.Exception
BaseConfiguration newInstanceOf(java.lang.Object typeName) throws java.lang.Exception
typeName
- The object type to create.
java.lang.Exception
BaseConfiguration newInstanceOf(int type) throws java.lang.Exception
type
- The object type to create
java.lang.Exception
<T extends BaseConfiguration> T newInstanceOf(java.lang.Class<T> cls) throws java.lang.Exception
type
- The object type to create
java.lang.Exception
BaseConfiguration getDriverParameters() throws java.lang.Exception
java.lang.Exception
void setDriverParameters(BaseConfiguration driverParams) throws java.lang.Exception
driverParams
- The driver parameters
java.lang.Exception
java.lang.Object getDriverParameter(java.lang.Object name) throws java.lang.Exception
name
- The name of the driver parameter ot get.
java.lang.Exception
void setDriverParameter(java.lang.Object name, java.lang.Object value) throws java.lang.Exception
name
- The driver parameter namevalue
- The driver parameter value
java.lang.Exception
boolean isRemote()
void instantiateAllObjects() throws java.lang.Exception
java.lang.Exception
TDIProperties getTDIProperties() throws java.lang.Exception
java.lang.Exception
SolutionInterface getSolutionInterface()
java.lang.String getConfigVersion()
java.lang.String getDirectory()
void setModTSEnabled(boolean value)
value
- - If true, allows time stamps to be automatically modifiedboolean isModTSEnabled()
boolean shouldEncryptProtected()
void commitChangesNoEncryption(java.lang.Object output) throws java.lang.Exception
output
- Any object supported by the underlying driver.
java.lang.Exception
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |