com.ibm.di.server
Interface RSInterface

All Known Implementing Classes:

RS, RSInterfaceProxy

public interface RSInterface

The top level Thread is an instance of this class, called the main object. It has methods for manipulating AssemblyLines.

Method Summary

void	dump(Object o) Dumps the class and contents of an object to the log file.
void	dumpEntry(Entry e) Dumps the contents of an Entry to the log file.
AttributeMapConfig	getAttributeMap(String name) Returns the the "Attribute Map" for a named connector
String	getConfigPath() This method returns the current configuration file path
Object	getConfiguration(String name) Returns the entire table or a sub-section of the configuration file.
ConnectorConfig	getConnector(String name) Returns the the "Connector" entry for name
FunctionConfig	getFunction(String name) Returns the "FunctionConfig" entry for name
LibraryConfig	getLibraries() Returns all "Libraries"
Object	getLibrary(String name) Returns the the "Java Library" entry for name
MetamergeConfig	getMetamergeConfig() Returns the config object for this instance.
String	getNullBehavior() Return the null behavior value from the System.props
String	getNullBehaviorValue()
String	getNullDefinition() Return the null definition value from the System.props
String	getNullDefinitionValue()
ParserConfig	getParser(String name) Returns the the "Parser" entry for name
ScriptConfig	getScript(String name) Returns the the "Script Library" entry for name
String	getSysProp(String name) Returns the value of a system property.
AssemblyLineConfig	getTask(String name) Returns the "AssemblyLine" entry
EventHandlerConfig	getTrigger(String name) Returns the "EventHandler" entry
void	logmsg(String msg) Writes a message to the system log file.
void	logmsg(String level, String msg) This method logs a message with the specified level to the log.
void	persistConfiguration() This method saves the current configuration to disk.
void	reload() This method reloads the configuration file.
AssemblyLine	restartAL(String assemblyLine, String checkpointID) Restart the AssemblyLine given by the parameter.
void	setConfigPath(String path) This method sets the current configuration file path.
void	setMetamergeConfig(MetamergeConfig config) Sets the given configuration to this instance.
void	shutdownServer() Set the shutdown request flag
void	shutdownServer(int aExitCode) Set the shutdown request flag and specify an exit code.
AssemblyLine	startAL(String assemblyLine) Start the AssemblyLine given by the parameter.
AssemblyLine	startAL(String assemblyLine, Connector connector, Entry work) Start the AssemblyLine given by the parameter.
AssemblyLine	startAL(String assemblyLine, Object io) Start the AssemblyLine given by the parameter.
Object	startEventTrigger(String name, boolean checkEnabled) This method starts an EventHandler.

Method Detail

getConfiguration

Object getConfiguration(String name)

Returns the entire table or a sub-section of the configuration file.

Parameters:

name - Name of subsection or null

Returns:

The entire table (key == null) or section in table

getMetamergeConfig

MetamergeConfig getMetamergeConfig()

Returns the config object for this instance.

Returns:

the configuration object of this instance.

setMetamergeConfig

void setMetamergeConfig(MetamergeConfig config)

Sets the given configuration to this instance.

Parameters:

config - The configuration object to assign to the instance.

getTask

AssemblyLineConfig getTask(String name)

Returns the "AssemblyLine" entry

Parameters:

name - The AssemblyLine name

Returns:

The configuration for the AssemblyLine

getConnector

ConnectorConfig getConnector(String name)

Returns the the "Connector" entry for name

Parameters:

name - The connector name

Returns:

The section from either the file configuration or the templates configuration

getTrigger

EventHandlerConfig getTrigger(String name)

Returns the "EventHandler" entry

Parameters:

name - The EventHandler name

Returns:

The EventHandler section

getLibrary

Object getLibrary(String name)

Returns the the "Java Library" entry for name

Parameters:

name - The java library name

Returns:

The section for name

getLibraries

LibraryConfig getLibraries()

Returns all "Libraries"

Returns:

The entire list of Libraries

getParser

ParserConfig getParser(String name)

Returns the the "Parser" entry for name

Parameters:

name - The parser name

Returns:

The section either the file configuration or the templates configuration

getScript

ScriptConfig getScript(String name)

Returns the the "Script Library" entry for name

Parameters:

name - The script library name

Returns:

The section for name

getAttributeMap

AttributeMapConfig getAttributeMap(String name)

Returns the the "Attribute Map" for a named connector

Parameters:

name - The connector name

Returns:

The attribute map section

getFunction

FunctionConfig getFunction(String name)
                           throws Exception

Returns the "FunctionConfig" entry for name

Parameters:

name - The name of the function

Returns:

The function config object

Throws:

Exception

getSysProp

String getSysProp(String name)

Returns the value of a system property. The system properties include all Java system properties as well as IDI's own properties.

Parameters:

name - The system property name

Returns:

The value for the property

persistConfiguration

void persistConfiguration()
                          throws Exception

This method saves the current configuration to disk.

Throws:

Exception

logmsg

void logmsg(String msg)

Writes a message to the system log file.

Parameters:

msg - The message to log

logmsg

void logmsg(String level,
            String msg)

This method logs a message with the specified level to the log.

Parameters:

level - Loglevel. Legal values are FATAL, ERROR, WARN, INFO, DEBUG. Unrecognized keyword means DEBUG.

msg - The message

dump

void dump(Object o)

Dumps the class and contents of an object to the log file. If this is an Entry, calls the dumpEntry method.

Parameters:

o - The object to dump

See Also:

dumpEntry(com.ibm.di.entry.Entry)

dumpEntry

void dumpEntry(Entry e)

Dumps the contents of an Entry to the log file.

Parameters:

e - The Entry object to dump

See Also:

Entry

startAL

AssemblyLine startAL(String assemblyLine)
                     throws Exception

Start the AssemblyLine given by the parameter. See also the introduction to AssemblyLines.

Parameters:

assemblyLine - The name identifying the AssemblyLine to start

Throws:

Exception

startAL

AssemblyLine startAL(String assemblyLine,
                     Object io)
                     throws Exception

Start the AssemblyLine given by the parameter. See also the introduction to AssemblyLines.

Parameters:

assemblyLine - The name identifying the AssemblyLine to start

io - This Object could either be
1. an Entry, providing the initial work entry
2. a Connector, providing a runtime-provided Connector
3. a Vector 4. a TCB

Throws:

Exception

startAL

AssemblyLine startAL(String assemblyLine,
                     Connector connector,
                     Entry work)
                     throws Exception

Start the AssemblyLine given by the parameter. See also the introduction to AssemblyLines.

Parameters:

assemblyLine - The name identifying the AssemblyLine to start

connector - The runtime-provided Connector

work - The initial work entry

Throws:

Exception

restartAL

AssemblyLine restartAL(String assemblyLine,
                       String checkpointID)
                       throws Exception

Restart the AssemblyLine given by the parameter. See also the introduction to AssemblyLines.

Parameters:

assemblyLine - The name identifying the AssemblyLine to start

checkpointID - The checkpoint identifier

Throws:

Exception

startEventTrigger

Object startEventTrigger(String name,
                         boolean checkEnabled)
                         throws Exception

This method starts an EventHandler.

Parameters:

name - The EventHandler name

checkEnabled - If false, the autoStart flag is overridden

Returns:

The EventHandler thread object

Throws:

Exception

reload

void reload()
            throws Exception

This method reloads the configuration file.

Throws:

Exception

getConfigPath

String getConfigPath()

This method returns the current configuration file path

Returns:

The configuration file path as a string

setConfigPath

void setConfigPath(String path)

This method sets the current configuration file path. This will be used when a persistConfiguration is requested.

Parameters:

path - The new configuration path

shutdownServer

void shutdownServer()

Set the shutdown request flag

shutdownServer

void shutdownServer(int aExitCode)

Set the shutdown request flag and specify an exit code.

getNullBehavior

String getNullBehavior()

Return the null behavior value from the System.props

getNullBehaviorValue

String getNullBehaviorValue()

getNullDefinition

String getNullDefinition()

Return the null definition value from the System.props

getNullDefinitionValue

String getNullDefinitionValue()