com.ibm.di.config.interfaces
Interface SimulationConfig

All Superinterfaces:
BaseConfiguration, Serializable
All Known Implementing Classes:
SimulationConfigImpl

public interface SimulationConfig
extends BaseConfiguration

This class is used to configure the AssemblyLine's simulation mode.


Field Summary
static String AL_SIMULATE_PROXY_CONFIG
           
static String AL_SIMULATE_PROXY_DEBUG
           
static String AL_SIMULATE_PROXY_MODE
           
static String AL_SIMULATE_PROXY_NAME
           
static String AL_SIMULATE_PROXY_SERVER
           
static String[] METHODS_CON_ADDONLY
           
static String[] METHODS_CON_CALL_REPLY
           
static String[] METHODS_CON_DELETE
           
static String[] METHODS_CON_DELTA
           
static String[] METHODS_CON_ITERATOR
           
static String[] METHODS_CON_LOOKUP
           
static String[] METHODS_CON_REPLY
           
static String[] METHODS_CON_SERVER
           
static String[] METHODS_CON_UPDATE
           
static String[] METHODS_FC_PERFORM
           
static String SIM_DISABLED_STATE
           
static String SIM_ENABLED_STATE
           
static String[] SIM_OP_AS_STRING
           
static int SIM_OP_DELETE_ENTRY
           
static int SIM_OP_FIND_ENTRY
           
static int SIM_OP_GET_NEXT_CLIENT
           
static int SIM_OP_GET_NEXT_ENTRY
           
static int SIM_OP_MOD_ENTRY
           
static int SIM_OP_PERFORM
           
static int SIM_OP_PUT_ENTRY
           
static int SIM_OP_QUERY_REPLY
           
static int SIM_OP_REPLY_ENTRY
           
static int SIM_OP_SELECT_ENTRIES
           
static String SIM_PROXY_STATE
           
static String SIM_SCRIPTED_STATE
           
static String SIM_SIMULATED_STATE
           
static String SIMULATE_HOOK_NAME
           
 
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
 AssemblyLineConfig createOrUpdateProxyAL()
          This method checks the current simulation config settings and uses the ProxyAL setting to lookup the ProxyAL's AssibmlyLineConfig object.
 String getComponentSimState(String name)
          Returns the state of the specified by the name parameter Component
 HookConfig getHook(String name)
          Return the simulation hook config object for the specified by name component
 String getProxyALConfigInstance()
          Returns the configInstance ID
 boolean getProxyALDebug()
          Gets the debug flag state
 int getProxyALMode()
          Gets the mode the proxy AL will run in 0 - Run and wait for result 1 - Run in background 2 - Run in Manual mode
 String getProxyALName()
          Returns the name of the AL set as a proxy.
 String getProxyALServer()
          Returns the name of the remote server.
 BaseConfiguration getProxySettings()
          Gets the proxySettings Config holder
 void setComponentSimState(String name, String state)
          Set the state of the Component specified by the name parameter
 void setProxyALConfigInstance(String config)
          Sets the ID of the configInstance to use
 void setProxyALDebug(boolean debug)
          Sets proxy AL debug flag on/off
 void setProxyALMode(int mode)
          Sets the mode the proxy AL will run in 0 - Run and wait for result 1 - Run in background 2 - Run in Manual mode
 void setProxyALName(String name)
          Sets the name of the AL to use as proxy.
 void setProxyALServer(String server)
          Sets the remote server host name.
 
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, getModTS, 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, setModTS, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten
 

Field Detail

SIM_ENABLED_STATE

static final String SIM_ENABLED_STATE
See Also:
Constant Field Values

SIM_DISABLED_STATE

static final String SIM_DISABLED_STATE
See Also:
Constant Field Values

SIM_SIMULATED_STATE

static final String SIM_SIMULATED_STATE
See Also:
Constant Field Values

SIM_PROXY_STATE

static final String SIM_PROXY_STATE
See Also:
Constant Field Values

SIM_SCRIPTED_STATE

static final String SIM_SCRIPTED_STATE
See Also:
Constant Field Values

AL_SIMULATE_PROXY_NAME

static final String AL_SIMULATE_PROXY_NAME
See Also:
Constant Field Values

AL_SIMULATE_PROXY_SERVER

static final String AL_SIMULATE_PROXY_SERVER
See Also:
Constant Field Values

AL_SIMULATE_PROXY_CONFIG

static final String AL_SIMULATE_PROXY_CONFIG
See Also:
Constant Field Values

AL_SIMULATE_PROXY_MODE

static final String AL_SIMULATE_PROXY_MODE
See Also:
Constant Field Values

AL_SIMULATE_PROXY_DEBUG

static final String AL_SIMULATE_PROXY_DEBUG
See Also:
Constant Field Values

SIM_OP_GET_NEXT_CLIENT

static final int SIM_OP_GET_NEXT_CLIENT
See Also:
Constant Field Values

SIM_OP_GET_NEXT_ENTRY

static final int SIM_OP_GET_NEXT_ENTRY
See Also:
Constant Field Values

SIM_OP_FIND_ENTRY

static final int SIM_OP_FIND_ENTRY
See Also:
Constant Field Values

SIM_OP_SELECT_ENTRIES

static final int SIM_OP_SELECT_ENTRIES
See Also:
Constant Field Values

SIM_OP_REPLY_ENTRY

static final int SIM_OP_REPLY_ENTRY
See Also:
Constant Field Values

SIM_OP_QUERY_REPLY

static final int SIM_OP_QUERY_REPLY
See Also:
Constant Field Values

SIM_OP_PERFORM

static final int SIM_OP_PERFORM
See Also:
Constant Field Values

SIM_OP_PUT_ENTRY

static final int SIM_OP_PUT_ENTRY
See Also:
Constant Field Values

SIM_OP_MOD_ENTRY

static final int SIM_OP_MOD_ENTRY
See Also:
Constant Field Values

SIM_OP_DELETE_ENTRY

static final int SIM_OP_DELETE_ENTRY
See Also:
Constant Field Values

SIM_OP_AS_STRING

static final String[] SIM_OP_AS_STRING

METHODS_FC_PERFORM

static final String[] METHODS_FC_PERFORM

METHODS_CON_UPDATE

static final String[] METHODS_CON_UPDATE

METHODS_CON_DELETE

static final String[] METHODS_CON_DELETE

METHODS_CON_DELTA

static final String[] METHODS_CON_DELTA

METHODS_CON_ITERATOR

static final String[] METHODS_CON_ITERATOR

METHODS_CON_REPLY

static final String[] METHODS_CON_REPLY

METHODS_CON_CALL_REPLY

static final String[] METHODS_CON_CALL_REPLY

METHODS_CON_SERVER

static final String[] METHODS_CON_SERVER

METHODS_CON_LOOKUP

static final String[] METHODS_CON_LOOKUP

METHODS_CON_ADDONLY

static final String[] METHODS_CON_ADDONLY

SIMULATE_HOOK_NAME

static final String SIMULATE_HOOK_NAME
See Also:
Constant Field Values
Method Detail

setProxyALName

void setProxyALName(String name)
Sets the name of the AL to use as proxy.

Parameters:
name - The name of the AL

getProxyALName

String getProxyALName()
Returns the name of the AL set as a proxy.

Returns:
The name of the AL used as proxy or null if nothing was set.

setProxyALServer

void setProxyALServer(String server)
Sets the remote server host name.

Parameters:
server - The name of the server

getProxyALServer

String getProxyALServer()
Returns the name of the remote server.

Returns:
The name of the server

setProxyALConfigInstance

void setProxyALConfigInstance(String config)
Sets the ID of the configInstance to use

Parameters:
config - The ID of the ConfigInstance

getProxyALConfigInstance

String getProxyALConfigInstance()
Returns the configInstance ID

Returns:
The ID of the configInstance

setProxyALMode

void setProxyALMode(int mode)
Sets the mode the proxy AL will run in

Parameters:
mode - The mode the AL will run in

getProxyALMode

int getProxyALMode()
Gets the mode the proxy AL will run in

Returns:
The mode the AL will run in

setProxyALDebug

void setProxyALDebug(boolean debug)
Sets proxy AL debug flag on/off

Parameters:
debug - The new value of the debug flag

getProxyALDebug

boolean getProxyALDebug()
Gets the debug flag state

Returns:
The value of the proxy AL debug flag

getProxySettings

BaseConfiguration getProxySettings()
                                   throws Exception
Gets the proxySettings Config holder

Returns:
The proxySettings
Throws:
Exception

createOrUpdateProxyAL

AssemblyLineConfig createOrUpdateProxyAL()
                                         throws Exception
This method checks the current simulation config settings and uses the ProxyAL setting to lookup the ProxyAL's AssibmlyLineConfig object. If that object is found it is updated with the missing BranchingConfig components. Any of the existing component in the AssemblyLineConfig that are user defined are not changed. If that object could not be found during the lookup process it is created.

Returns:
the object that was updated with the necessary branching components
Throws:
Exception

getHook

HookConfig getHook(String name)
Return the simulation hook config object for the specified by name component

Parameters:
name - The name of the component which hook configuration to get
Returns:
The simulation hook specified by the name parameter or null if the component is not found. If it is found but the requested HookConfig does not exist then it is created and returned.

getComponentSimState

String getComponentSimState(String name)
Returns the state of the specified by the name parameter Component

Parameters:
name - The name of the component
Returns:
the simulation state of the component as String or null if undefined

setComponentSimState

void setComponentSimState(String name,
                          String state)
Set the state of the Component specified by the name parameter

Parameters:
name - The name of the Component
state - The new state of the Component