com.ibm.di.function
Class SystemFunctions

java.lang.Object
  com.ibm.di.function.SystemFunctions

public class SystemFunctions
extends Object

Method Summary

static ConnectorConfig	createRuntimeConnector()
static void	declareUserFunctions(ScriptEngine se)
static void	declareUserFunctions(ScriptEngine se, RSInterface main)
static void	doNothing() Do nothing.
static Object	getClassInstance(String className)
static RSInterface	getServer() Returns the RS instance associated with the current ThreadGroup, or the dummy RSInterface object defined by the Config Editor.
static AssemblyLineConfig	loadAssemblyLine(String name)
static AssemblyLineConfig	loadAssemblyLine(String name, RSInterface server)
static ConnectorInterface	loadConnector(ConnectorConfig config)
static ConnectorInterface	loadConnector(ConnectorConfig config, Object parentConfig)
static ConnectorInterface	loadConnector(ConnectorConfig config, Object parentConfig, RSInterface server)
static ConnectorInterface	loadConnector(PropertyStoreConfig psc)
static ConnectorInterface	loadConnector(String name)
static ConnectorInterface	loadConnector(String name, RSInterface server)
static SearchCriteria	loadCriteria(Vector<String> m)
static FunctionInterface	loadFunction(FunctionConfig config)
static FunctionInterface	loadFunction(FunctionConfig config, Log log)
static FunctionInterface	loadFunction(String name)
static FunctionInterface	loadFunction(String name, RSInterface server)
static ParserInterface	loadParser(ParserConfig config)
static ParserInterface	loadParser(String name)
static ParserInterface	loadParser(String name, RSInterface server)
static ScriptConfig	loadScript(String name)
static ScriptConfig	loadScript(String name, RSInterface server)
static void	rotatelog(RSInterface parent, String logfile) This method renames old logs to be one version older and add current log with version '1'.
static void	setServer(RSInterface server)
static void	setSystemProperties(MetamergeConfig mc)
static void	setSystemProperties(MetamergeConfig config, boolean recursive) Set system properties from properties object in config.
static void	setupSystemConnectorInheritance() Set up inheritance for system Connectors.
static ArrayList<String>	split(String str, String sep)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setServer

public static void setServer(RSInterface server)

getServer

public static RSInterface getServer()

Returns the RS instance associated with the current ThreadGroup, or the dummy RSInterface object defined by the Config Editor. Although this method is public, it is meant for internal use,. The usual way to get the current RS instance would be to use the main object in JavaScript.

Returns:

the RS instance or null if it couldn't be found, e.g. because the current Thread was not created by the TDI framework.

split

public static ArrayList<String> split(String str,
                                      String sep)

loadScript

public static ScriptConfig loadScript(String name)

loadScript

public static ScriptConfig loadScript(String name,
                                      RSInterface server)

loadAssemblyLine

public static AssemblyLineConfig loadAssemblyLine(String name)

loadAssemblyLine

public static AssemblyLineConfig loadAssemblyLine(String name,
                                                  RSInterface server)

loadParser

public static ParserInterface loadParser(String name)
                                  throws Exception

Throws:

Exception

loadParser

public static ParserInterface loadParser(String name,
                                         RSInterface server)
                                  throws Exception

Throws:

Exception

loadParser

public static ParserInterface loadParser(ParserConfig config)
                                  throws Exception

Throws:

Exception

loadConnector

public static ConnectorInterface loadConnector(String name)
                                        throws Exception

Throws:

Exception

loadConnector

public static ConnectorInterface loadConnector(String name,
                                               RSInterface server)
                                        throws Exception

Throws:

Exception

loadConnector

public static ConnectorInterface loadConnector(PropertyStoreConfig psc)
                                        throws Exception

Throws:

Exception

loadConnector

public static ConnectorInterface loadConnector(ConnectorConfig config)
                                        throws Exception

Throws:

Exception

loadConnector

public static ConnectorInterface loadConnector(ConnectorConfig config,
                                               Object parentConfig)
                                        throws Exception

Throws:

Exception

loadConnector

public static ConnectorInterface loadConnector(ConnectorConfig config,
                                               Object parentConfig,
                                               RSInterface server)
                                        throws Exception

Throws:

Exception

loadFunction

public static FunctionInterface loadFunction(String name)
                                      throws Exception

Throws:

Exception

loadFunction

public static FunctionInterface loadFunction(String name,
                                             RSInterface server)
                                      throws Exception

Throws:

Exception

loadFunction

public static FunctionInterface loadFunction(FunctionConfig config)
                                      throws Exception

Throws:

Exception

loadFunction

public static FunctionInterface loadFunction(FunctionConfig config,
                                             Log log)
                                      throws Exception

Throws:

Exception

loadCriteria

public static SearchCriteria loadCriteria(Vector<String> m)
                                   throws Exception

Throws:

Exception

getClassInstance

public static Object getClassInstance(String className)
                               throws Exception

Throws:

Exception

declareUserFunctions

public static void declareUserFunctions(ScriptEngine se)
                                 throws Exception

Throws:

Exception

declareUserFunctions

public static void declareUserFunctions(ScriptEngine se,
                                        RSInterface main)
                                 throws Exception

Throws:

Exception

rotatelog

public static void rotatelog(RSInterface parent,
                             String logfile)
                      throws Exception

This method renames old logs to be one version older and add current log with version '1'. The total number of the kept log files is specified by the system property com.ibm.di.server.rotatelogs.

Note: If this property is not set, this method will not do anything.

See Also:
Online documentation for help about setting com.ibm.di.server.rotatelogs property.

Parameters:

parent - object used for getting the system property - com.ibm.di.server.rotatelogs.

logfile - current log file

Throws:

Exception

createRuntimeConnector

public static ConnectorConfig createRuntimeConnector()
                                              throws Exception

Throws:

Exception

setSystemProperties

public static void setSystemProperties(MetamergeConfig config,
                                       boolean recursive)
                                throws Exception

Set system properties from properties object in config. If recursive, run through included configs as well.

Throws:

Exception

setSystemProperties

public static void setSystemProperties(MetamergeConfig mc)
                                throws Exception

Throws:

Exception

doNothing

public static void doNothing()

Do nothing. This method intentionally does nothing.

Since:

7.0

setupSystemConnectorInheritance

public static void setupSystemConnectorInheritance()

Set up inheritance for system Connectors.

Since:

7.1