|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Thread
com.ibm.di.server.Monitor
com.ibm.di.server.AssemblyLine
public final class AssemblyLine
This class represents a IBM Tivoli Directory Integrator AssemblyLine. When an AssemblyLine needs to be started the com.ibm.di.server.RS object creates an instance of the AssemblyLine class and then calls the start() method on this instance. Since AssemblyLine inherits (indirectly) from java.lang.Thread this causes the run() method of the AssemblyLine to be called. An alternative method of running AssemblyLines is running them manually. This means that only a single cycle of the AssemblyLine is executed at a time, returning the work Entry result at the end of the cycle. An AssemblyLine can be run in manual mode by using the AssemblyLine constructor which is passed a com.ibm.di.server.TaskCallBlock object. This TaskCallBlock object must have had its AssemblyLine.TCB_RUNMODE_PROPNAME property set to the value of AssemblyLine.RUNMODE_MANUAL. Then a cycle can be executed by invoking the Entry executeCycle(Entry workEntry) AssemblyLine method.
Nested Class Summary | |
---|---|
static interface |
AssemblyLine.AssemblyLineListener
This interface is for internal use only. |
Nested classes/interfaces inherited from class java.lang.Thread |
---|
Thread.State, Thread.UncaughtExceptionHandler |
Field Summary | |
---|---|
static String |
AUTODEBUG_PREFIX
The key name of the java system property used for the AutoDebug |
static String |
OPENTRY_OPERATION
The name of the attribute in the op-entry which value tells the operation the called AL is running in. |
static String |
PROPERTIES_FILE
The name of the properties file from which this component will read its localized message strings. |
static int |
RUNMODE_I_MANUAL
This is the position of the RUNMODE_MANUAL String in the
RUNMODES array |
static int |
RUNMODE_I_NODEBUG
This is the position of the RUNMODE_MANUAL String in the
RUNMODES array |
static int |
RUNMODE_I_NORMAL
This is the position of the RUNMODE_NORMAL String in the
RUNMODES array |
static int |
RUNMODE_I_PLAYBACK
This is the position of the RUNMODE_PLAYBACK String in the
RUNMODES array |
static int |
RUNMODE_I_RECORD
This is the position of the RUNMODE_RECORD String in the
RUNMODES array |
static String |
RUNMODE_MANUAL
This constant is used when passing parameters to the AL using the TCB object. |
static String |
RUNMODE_NODEBUG
This constant is used when autodebug has been configured for the config instance. |
static String |
RUNMODE_NORMAL
This constant is used when passing parameters to the AL using the TCB object. |
static String |
RUNMODE_PLAYBACK
This constant is used when passing parameters to the AL using the TCB object. |
static String |
RUNMODE_RECORD
This constant is used when passing parameters to the AL using the TCB object. |
static String[] |
RUNMODES
This array contains all the run modes as strings. |
static String |
TCB_CP_CHECKPOINTID
Deprecated. CheckPoint/Restart is deprecated |
static String |
TCB_CP_CHECKPOINTOBJECT
Deprecated. CheckPoint/Restart is deprecated |
static String |
TCB_CP_DISCARD_IWE
Discard IWE? Typically used when IWE contains params but should not be used in the cycle. |
static String |
TCB_CP_FORCECLEAN
Deprecated. CheckPoint/Restart is deprecated |
static String |
TCB_DEBUG_HOST
The host of the remote debugger client. |
static String |
TCB_DEBUG_JAVASCRIPT
Used to prepare the Javascript engine for debugging. |
static String |
TCB_DEBUG_ONERROR
Used to set the onerror flag. |
static String |
TCB_DEBUG_PORT
The TCP port number of the remote debugger client. |
static String |
TCB_FORCE_REPLYCHANNEL
Force replay channel. |
static String |
TCB_RUNMODE_PROPNAME
Deprecated. This kind of usage is deprecated, use the TaskCallBlock.setRunMode(String) method instead. |
static String |
TCB_SIMULATE_MODE
When this flag is set in the TaskCallBlock object, and then the
TCB is passed to the AssemblyLine , the AL will not make any
changes to external systems (e.g. |
Fields inherited from class java.lang.Thread |
---|
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY |
Constructor Summary | |
---|---|
AssemblyLine()
Constructor for the AssemblyLine object that is available in JavaScript via the pre-registered variable task. |
|
AssemblyLine(RSInterface parent,
String taskName,
Object param,
Log log)
Constructor for the AssemblyLine object that is available in JavaScript via the pre-registered variable task. |
|
AssemblyLine(RSInterface parent,
String taskName,
Object param,
Log log,
AssemblyLineConfig alc)
Constructor for the AssemblyLine object that is available in JavaScript via the pre-registered variable task. |
Method Summary | |
---|---|
void |
addListener(AssemblyLine.AssemblyLineListener listener)
This method is for internal use only. |
void |
addRuntimeConnector(String name,
ConnectorConfig config,
boolean executeProlog)
This method creates an ALComponent from the provided connector config. |
void |
addRuntimeIterator(String name,
ConnectorInterface conn,
boolean executeProlog)
This method inserts a connector interface as an Iterator in the current AL. |
boolean |
autoActivateDebugger()
This method will activate the AL debugger based on java system properties. |
void |
bailout(Throwable error)
This method is used for handling thrown during the AL's work-flow errors. |
void |
debug(Object msg)
Logs a message to the AssemblyLine log file |
void |
debugBreak(Object obj)
This method sends an object for display to the debug panel and waits for a continue/stop message. |
void |
debugBreakError(Object obj)
This method forces the debugger to stop if it runs in OnError mode. |
boolean |
debuggerEnabled()
Returns status of the debugger session |
void |
debugMsg(Object obj)
This method sends an object for display to the debug panel. |
void |
disableDebug()
Remove the current debugger. |
void |
disableDebug(Object msg)
This method sends a message to the remote UI and closes the debugger connection if it is open. |
void |
disableDebug(Object msg,
boolean async)
This method sends a message to the remote UI and closes the debugger connection if it is open. |
void |
dump(Object o)
This method dumps an object to whatever Log Appenders have been defined for this AssemblyLine. |
void |
dumpAssemblyLineState(String file,
boolean append)
Dumps the state of the AssemblyLine to the log or the output file specified. |
void |
dumpEntry(Entry entry)
Prints the contents of an entry to whatever Log Appenders have been defined for this AssemblyLine. |
void |
enableDebug(int port,
String host,
boolean onerror)
This method establishes a debugging session between this AL and a remote debugger client (e.g. |
void |
enableDebug(int port,
String host,
boolean onerror,
boolean async)
This method establishes a debugging session between this AL and a remote debugger client (e.g. |
boolean |
equals(Object o)
|
Entry |
executeCycle()
This method call executeCycle with a null initial work and processTCB set to true. |
Entry |
executeCycle(Entry workEntry)
This method call executeCycle with the provided work entry and processTCB set to true. |
Entry |
executeCycle(Entry workEntry,
boolean processTCB)
This method is called by scripts and other classes that run the assemblyline in its own context. |
void |
executeInitializeAL()
Internal method used by AssemblyLinePool. |
void |
executeMainLoop()
This method is automatically called by the AL when it is started in mode different than RUNMODE_MANUAL |
void |
executeMainLoop(int untilState)
This method runs the AL and continue running until the specific state is reached. |
void |
executeTerminateAL()
Call this method when you want to terminate the AL that was started in Cycle mode. |
void |
executeWithALPool()
Used if there is a Server Mode Connector. |
boolean |
getComponentDebugMode(String componentName)
Query the debug mode of a component from this AssemblyLine. |
Object |
getConfig(String name)
getConfig returns a named value from the AssemblyLine's configuration. |
AssemblyLineConfig |
getConfigClone()
Gets a cone of the configuration object of this AssemblyLine |
String |
getConfigStr(String name)
getConfigStr returns a named string value from the AssemblyLine's configuration. |
AssemblyLineComponent |
getConnector(String name)
Returns the AssemblyLineComponent with the given name. |
int |
getConnectorIndex(String name)
Returns a connectors index |
int |
getConnectorIndex2(String name)
Returns a connectors index |
List<AssemblyLineComponent> |
getConnectors()
Gets the list of AssemblyLineComponent objects this AssemblyLine hosts. |
String |
getCurrentState()
Returns the current AssemblyLine step position. |
int |
getCurrentStep()
|
Entry |
getCurrentWork()
This method returns the current work Entry object. |
String |
getDatabase()
Returns the database path/url where obj is recorded/played back. |
Log |
getLog()
Gets the log attribute of the AssemblyLine object |
String |
getLogCategory()
Retrieves log4j category name. |
String |
getLogFilePath()
Returns the logfile path relative to the working directory. |
String |
getNullBehavior()
Gets the nullBehavior attribute of the AssemblyLine object |
String |
getNullBehaviorValue()
Gets the nullBehaviorValue attribute of the AssemblyLine object |
String |
getNullDefinition()
Gets the nullDefinition attribute of the AssemblyLine object |
String |
getNullDefinitionValue()
Gets the nullDefinitionValue attribute of the AssemblyLine object |
Entry |
getOpEntry()
Retrieves operational entry. |
Object |
getParam(String name)
getParam returns the value for a user-defined parameter. |
RSInterface |
getParent()
This method returns the RSInterface (main) object. |
AssemblyLine |
getParentAL()
Returns the AssemblyLine Thread that started this AssemblyLine. |
String |
getPerfStats(String component)
Gets the performance statistics for a component. |
boolean |
getResetCheckpoint()
Deprecated. |
Entry |
getResult()
This method returns the result Entry object. |
int |
getRunMode()
Returns the runMode for the AL. |
ScriptEngine |
getScriptEngine()
getScriptEngine returns the ScriptEngine object for the AssemblyLine. |
String |
getShortName()
This method returns the short name of this AL. |
SimulationConfig |
getSimulationConfig()
|
TaskStatistics |
getStats()
This method returns the TaskStatistics object for this AssemblyLine. |
TaskCallBlock |
getTCB()
Returns the TaskCallBlock for this AssemblyLine. |
boolean |
getTerminationRequested()
|
String |
getTombstoneUserMessage()
Retrieves À custom user message, used when storing TombStones. |
Entry |
getUserCheckpoint()
Deprecated. |
Entry |
getWork()
This method returns the initial work Entry object. |
int |
hashCode()
|
void |
initExecuteProlog()
This method is automatically called for AssemblyLines running in manual mode by the startAL() method. |
void |
initScriptEngine()
This method creates the script engine instance. |
boolean |
isPlaying()
Checks if the runmode is playback mode; |
boolean |
isPlaying(Object obj)
Returns true if the object obj should be played back from server store. |
boolean |
isRecording()
Checks if the runmode is record mode. |
boolean |
isRecording(Object obj)
Returns true if the object obj should be recorded. |
boolean |
isRestarting()
Deprecated. |
boolean |
isSimulating()
Retrieves flag for AL's simulation. |
AssemblyLineComponent |
loadConnector(BaseConfiguration config)
This method enables the user to load an AssemblyLine component given a configuration. |
void |
logmonitor(String msg)
Logs a message to the monitor. |
void |
logmsg(Object msg)
This method sends the specified message (msg) to whatever Log Appenders have been defined for this AssemblyLine. |
void |
logmsg(String level,
String msg)
This method sends the specified message (msg) to whatever Log Appenders have been defined for this AssemblyLine. |
void |
logPerfStats()
Dumps a formatted message to the log file the contents of a performance entry. |
void |
removeListener(AssemblyLine.AssemblyLineListener listener)
This method is for internal use only. |
void |
removeRuntimeConnector(String name)
This method removes a runtime connector from the AL. |
void |
resetIterators()
Resets each of the Iterator Connectors. |
void |
run()
The run method kicks off the thread and starts AssemblyLine execution. |
void |
saveParams()
This method saves the current AL params to the file configured in the AL settings |
void |
setComponentDebugMode(String componentName,
boolean debug)
Modify the debug mode of a component from this AssemblyLine. |
void |
setConfig(String name,
Object value)
setConfig sets a named parameter value in the AssemblyLine's configuration. |
void |
setIgnoreInputComponents(boolean value)
Sets the flag that tells whether the Feed Components should be loaded and used during the AL cycle. |
boolean |
setLogCategory(String categoryName)
Sets the log4j category name used when requesting a logger. |
boolean |
setNextConnector(AssemblyLineComponent alc)
Sets the next connector to execute. |
boolean |
setNextConnector(AssemblyLineComponent alc,
boolean continueAfter)
Deprecated. |
void |
setParam(String name,
Object value)
setParam sets the value for the user-defined parameter. |
void |
setPerfEnabled()
Enable the performance statistics recording. |
void |
setProxyALOperationParam(String paramName,
Object paramValue)
Sets an operation parameter that will be passed as an Attribute to the called Proxy AL in its "op-entry" Entry object on the next execution of the Proxy AL. |
void |
setProxyALOperationParams(Entry opentry)
This method transfers the Attributes from the passed entry object to the op-entry object of the Proxy AL. |
void |
setResetCheckpoint(boolean resetCheckpointStore)
Deprecated. |
void |
setSimulating(boolean mSimulating)
Define the simulation behaviour of the AL. |
void |
setTombstoneUserMessage(String aUserMessage)
Sets a custom user message, used when storing TombStones. |
Exception |
setUserCheckpoint(Entry cp)
Deprecated. |
void |
setWork(Entry entry)
This method sets the initial work entry object. |
void |
shutdown()
Request controlled shutdown of AssemblyLine |
void |
shutdown(boolean async)
Shutdown an AssemblyLine, and wait a while for it to stop. |
void |
startPerfRecording(String component)
Starts Performance Recording |
String |
stopPerfRecording(String component)
Stops Performance Recording |
void |
terminate()
Closes all connectors and releases resources.It is recommended that you use the shutdown() method if you want to halt an AssemblyLine before it's normal completion. |
boolean |
wasRestarted()
Deprecated. |
Methods inherited from class com.ibm.di.server.Monitor |
---|
addActionListener, addThread, allThreadsStopped, fireListener, removeActionListener, removeThread, runningALs, setMonitorMessage, threadStarted, threadStopped |
Methods inherited from class java.lang.Thread |
---|
activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String RUNMODE_NORMAL
public static final String RUNMODE_RECORD
public static final String RUNMODE_PLAYBACK
public static final String RUNMODE_MANUAL
public static final String RUNMODE_NODEBUG
public static final String[] RUNMODES
public static final int RUNMODE_I_NORMAL
RUNMODE_NORMAL
String in the
RUNMODES
array
public static final int RUNMODE_I_RECORD
RUNMODE_RECORD
String in the
RUNMODES
array
public static final int RUNMODE_I_PLAYBACK
RUNMODE_PLAYBACK
String in the
RUNMODES
array
public static final int RUNMODE_I_MANUAL
RUNMODE_MANUAL
String in the
RUNMODES
array
public static final int RUNMODE_I_NODEBUG
RUNMODE_MANUAL
String in the
RUNMODES
array
public static final String TCB_RUNMODE_PROPNAME
TaskCallBlock.setRunMode(String)
method instead.Entry.setProperty(Object, Object)
method.
public static final String TCB_SIMULATE_MODE
TaskCallBlock
object, and then the
TCB is passed to the AssemblyLine
, the AL will not make any
changes to external systems (e.g. Databases, LDAP servers, etc.). This
flag is not used instead of any of the provided run modes. // construct the object used for configurating the AL TaskCallBlock tcb = new TaskCallBlock(); // set the name of the AL to be started tcb.setAssemblyLineName("anALName"); // set the run mode of the AL tcb.setRunMode(AssemblyLine.RUNMODE_NORMAL); // tell the AL to skip the changes in any of the back-end systems used in the AL, just simulate the changes tcb.setProperty(AsseblyLine.TCB_SIMULATE_MODE, Boolean.valueOf(true)); // kick off the AL thread main.startAL(tcb);
public static final String TCB_CP_FORCECLEAN
public static final String TCB_CP_CHECKPOINTID
public static final String TCB_CP_CHECKPOINTOBJECT
public static final String TCB_CP_DISCARD_IWE
tcb.setProperty(TCB_CP_DISCARD_IWE, Boolean.valueOf(true));
public static final String TCB_FORCE_REPLYCHANNEL
public static final String OPENTRY_OPERATION
public static final String TCB_DEBUG_PORT
public static final String TCB_DEBUG_HOST
public static final String TCB_DEBUG_ONERROR
public static final String TCB_DEBUG_JAVASCRIPT
public static final String PROPERTIES_FILE
public static final String AUTODEBUG_PREFIX
Constructor Detail |
---|
public AssemblyLine()
public AssemblyLine(RSInterface parent, String taskName, Object param, Log log) throws Exception
parent
- RSInterface of caller/creatortaskName
- Name of AssemblyLine to runparam
- Optional parameter(s)log
- Optional Log object. Will be used as the parent of the logger
of this AssemblyLine.
Exception
- if taskName is an unknown AssemblyLine or if any of the
connectors cannot be initializedpublic AssemblyLine(RSInterface parent, String taskName, Object param, Log log, AssemblyLineConfig alc) throws Exception
parent
- RSInterface of caller/creatortaskName
- Name of AssemblyLine to runparam
- Optional parameter(s)log
- Optional Log object. Will be used as the parent of the logger
of this AssemblyLine.alc
- Optional AssemblyLine configuration object. This object will
be owned by the AssemblyLine - no private copy will be
created. If null is specified the AssemblyLine will make its
own copy of the master configuration. Note that copying the
configuration object is expensive.
Exception
- if taskName is an unknown AssemblyLine or if any of the
connectors cannot be initializedMethod Detail |
---|
public void setProxyALOperationParam(String paramName, Object paramValue) throws Exception
null
as the paramValue
parameter will
remove the Attribute named with the value of paramName
paramName
- the name of the attribute, if this is null the call will be
ignoredparamValue
- the attribute value, if this is null the attribute found by
the paramName
will be removed
Exception
- if an error occurs.public void setProxyALOperationParams(Entry opentry) throws Exception
opentry
- the entry which Attribute will be merged
Exception
- if an error occurs.public int hashCode()
hashCode
in class Object
public boolean equals(Object o)
equals
in class Object
public void setWork(Entry entry)
task.setWork(null).
entry
- The initial work entrypublic void setParam(String name, Object value)
name
- The user-defined parameter namevalue
- The value associated with namepublic void setConfig(String name, Object value)
name
- The AssemblyLine configuration parameter namevalue
- The value associated with namepublic RSInterface getParent()
getParent
in interface TaskInterface
public Entry getResult()
getResult
in interface TaskInterface
public Entry getWork()
getWork
in interface TaskInterface
public Entry getCurrentWork()
getCurrentWork
in interface TaskInterface
public String getLogFilePath()
public Object getParam(String name)
name
- The user-defined parameter name
public Object getConfig(String name)
getConfig
in interface TaskInterface
name
- The AssemblyLine parameter name
public String getConfigStr(String name)
name
- The AssemblyLine parameter name
getConfig(java.lang.String)
public ScriptEngine getScriptEngine()
getScriptEngine
in interface TaskInterface
public TaskStatistics getStats()
public AssemblyLineComponent getConnector(String name)
Returns the AssemblyLineComponent with the given name. Mostly for internal use, when scripting you already have this object available using the name you gave this component, or the special variable thisConnector that always references the currently scoped component.
May be called by different threads. Although the method is thread-safe,
accessing the returned object is not - see the documentation of
AssemblyLineComponent
for information on the
thread-safety of the returned object.
getConnector
in interface TaskInterface
name
- The connector name as specified in the configuration
public int getConnectorIndex(String name) throws Exception
name
- The connector name as specified in the configuration
Exception
- if the named connector could not be found.public List<AssemblyLineComponent> getConnectors()
public Log getLog()
getLog
in interface TaskInterface
public String getNullBehavior()
getNullBehavior
in interface TaskInterface
public String getNullBehaviorValue()
getNullBehaviorValue
in interface TaskInterface
public String getNullDefinition()
getNullDefinition
in interface TaskInterface
public String getNullDefinitionValue()
getNullDefinitionValue
in interface TaskInterface
public void run()
run
in interface Runnable
run
in class Thread
public void terminate() throws Exception
Exception
- in case an error occurs.public void addRuntimeIterator(String name, ConnectorInterface conn, boolean executeProlog) throws Exception
name
- the name of the ConnectorConfig
object used as a
configuration object for the connectorconn
- the connector to put in Iterator modeexecuteProlog
- tells whether the load/init has completed, if true then the
new AssemblyLineComponent
will be initialized and
added to the iterator list
Exception
- if the ConnectorConfig object could not be found using the
provided name
. If the creation/initialization of
the new AssemblyLineComponent
fails.public void addRuntimeConnector(String name, ConnectorConfig config, boolean executeProlog) throws Exception
name
- used for error messaging only.config
- the connector configuration object used for creating the new
AssemblyLineComponent
executeProlog
- tells whether the load/init has completed, if true then the
new AssemblyLineComponent
will be initialized
Exception
- if the connector is not in Iterator or Server mode. If the
AssemblyLineComponent
creation/initialization fails.public void removeRuntimeConnector(String name) throws Exception
name
- the name of the connector which will be removed
Exception
- if a connector with that name does not existspublic AssemblyLineComponent loadConnector(BaseConfiguration config) throws Exception
config
- The component configuration (e.g. ConnectorConfig,
FunctionConfig etc).
Exception
- if the creation of the new AssemblyLineComponent
fails.public void logmsg(Object msg)
logmsg
in interface TaskInterface
msg
- The messagepublic void logmsg(String level, String msg)
level
- Loglevel. Legal values are FATAL, ERROR, WARN, INFO, DEBUG.
Unrecognized keyword means DEBUG.msg
- The messagepublic void debug(Object msg)
msg
- The messagepublic void logmonitor(String msg)
msg
- The messagepublic void dump(Object o)
o
- The object to dumppublic void dumpEntry(Entry entry)
entry
- The entry object to printpublic void disableDebug()
public void disableDebug(Object msg)
msg
- Message to be sentdisableDebug()
public void disableDebug(Object msg, boolean async)
This method sends a message to the remote UI and closes the debugger connection if it is open.
This method is for internal use only. Do not call it from user code.
msg
- Message to be sentasync
- If true will remove the debugger asynchronously (not right
away but on the next AssemblyLine step). Always set to true if
you call this method from another thread. Always set to false
if you call the method from the AssemblyLine thread.public void enableDebug(int port, String host, boolean onerror) throws Exception
This method establishes a debugging session between this AL and a remote debugger client (e.g. CE).
Must not call this method from other threads, while the AssemblyLine is running.
port
- The TCP port number of the remote debugger clienthost
- The host name of the remote debugger clientonerror
- if true breakpoints are disabled except when there is an
error.
Exception
- If there is already a debugger or if the debugger cannot be
initialized.public void enableDebug(int port, String host, boolean onerror, boolean async) throws Exception
This method establishes a debugging session between this AL and a remote debugger client (e.g. CE).
This method is for internal use only. Do not call it from user code.
port
- The TCP port number of the remote debugger clienthost
- The host name of the remote debugger clientonerror
- if true breakpoints are disabled except when there is an
error.async
- If true will attach the debugger asynchronously - the debugger
will not get attached right away and the AssemblyLine will
pick it up after its current step. Always set to true if you
call this method from another thread. Always set to false if
you call the method from the AssemblyLine thread.
Exception
- If there is already a debugger or if the debugger cannot be
initialized.public boolean debuggerEnabled()
public void debugMsg(Object obj) throws Exception
debugMsg
in interface TaskInterface
obj
- The object to display. This object must be
Serializable
Exception
- Serialization exceptionpublic void debugBreak(Object obj) throws Exception
debugBreak
in interface TaskInterface
obj
- The object to display
Exception
- Serialization exceptionpublic void debugBreakError(Object obj) throws Exception
obj
- The error
Exception
- Serialization exceptionpublic void initScriptEngine() throws Exception
Exception
- Script engine exceptionspublic void saveParams()
@Deprecated public boolean wasRestarted()
@Deprecated public boolean isRestarting()
public void shutdown()
AssemblyLine
public void shutdown(boolean async) throws AbortALException
async
- If true, stop the AssemblyLine in a new Thread.
AbortALException
- if this method stops the AssemblyLine that called it.public boolean getTerminationRequested()
public String getLogCategory()
public boolean setLogCategory(String categoryName)
categoryName
- The logj4 category name
public void executeInitializeAL()
public void executeMainLoop()
RUNMODE_MANUAL
public void executeMainLoop(int untilState)
untilState
- the state until the AL should run.ALState
public void executeTerminateAL() throws Exception
Exception
- if an error occurs.public void resetIterators() throws Throwable
Throwable
- derived from the reseted ALComponentpublic void initExecuteProlog() throws Exception
Exception
- if an error occurspublic Entry executeCycle() throws Throwable
Throwable
- when method is called and AL was not started in "Cycle" mode
or this method is called after having returned a null entry
(e.g. end of iteration)public Entry executeCycle(Entry workEntry) throws Throwable
workEntry
- the work entry to use.
Throwable
- when method is called and AL was not started in "Cycle" mode
or this method is called after having returned a null entry
(e.g. end of iteration)public Entry executeCycle(Entry workEntry, boolean processTCB) throws Throwable
workEntry
- The work entry to use, or null to use an empty work
entry/iterator entryprocessTCB
- If true, the AL's call/return attribute maps are applied to
the provided entry and returned entry
Throwable
- when method is called and AL was not started in "Cycle" mode
or this method is called after having returned a null entry
(e.g. end of iteration)public String getCurrentState()
String
public void bailout(Throwable error)
ALState.MS_EPILOG
and prepares for
closure.
error
- the error which have to be handled.public int getConnectorIndex2(String name) throws Exception
name
- The connector name as specified in the configuration
Exception
- if the connector could not be found by the provided name@Deprecated public Entry getUserCheckpoint() throws Exception
Exception
- never@Deprecated public Exception setUserCheckpoint(Entry cp) throws Exception
cp
- not used
Exception
- neverpublic int getRunMode()
@Deprecated public boolean getResetCheckpoint()
@Deprecated public void setResetCheckpoint(boolean resetCheckpointStore)
resetCheckpointStore
- not usedpublic boolean isRecording()
RUNMODE_I_RECORD
.public boolean isPlaying()
RUNMODE_I_PLAYBACK
.public boolean isRecording(Object obj)
RecordPlaybackInterface
isRecording
in interface RecordPlaybackInterface
obj
- the object to check
obj
should be recorded.public boolean isPlaying(Object obj)
RecordPlaybackInterface
isPlaying
in interface RecordPlaybackInterface
obj
- the object to check
public String getDatabase()
RecordPlaybackInterface
getDatabase
in interface RecordPlaybackInterface
public String getShortName()
public void executeWithALPool()
public void setIgnoreInputComponents(boolean value)
value
- if this is true then the Input Components will be ignored,
otherwise they will be used.public int getCurrentStep()
ALState
public boolean setNextConnector(AssemblyLineComponent alc)
alc
- The connector to execute
public boolean setNextConnector(AssemblyLineComponent alc, boolean continueAfter)
public AssemblyLineConfig getConfigClone() throws Exception
Exception
- if an error occurs while the cloning process.public void setTombstoneUserMessage(String aUserMessage)
aUserMessage
- message to set.public String getTombstoneUserMessage()
public Entry getOpEntry()
public void startPerfRecording(String component)
component
- Unique ComponentIDpublic String stopPerfRecording(String component)
component
- Unique ComponentID
public String getPerfStats(String component)
component
- The name of the component to get the performance statistics
for
public void logPerfStats()
dump(Object)
public void setPerfEnabled()
public TaskCallBlock getTCB()
public void setSimulating(boolean mSimulating)
mSimulating
- public boolean isSimulating()
public SimulationConfig getSimulationConfig() throws Exception
Exception
- if an error occurs.public boolean autoActivateDebugger() throws Exception
"com.ibm.tdi.autodebug" is the prefix. <id> is the configuration id (of the running config instance) <name> is the name of the assembly line (short name) // Match specific assemblyline in specific config instance prefix.<id>.<name> = host,port,break-on-error // Match all assemblylines in specific config instance prefix.<id> = host,port,break-on-error // Match ALL assemblylines in ALL config instances prefix = host,port,break-on-error
Exception
public void addListener(AssemblyLine.AssemblyLineListener listener)
This method is for internal use only. Users must not rely on it.
Register a listener for AssemblyLine events. Can be called by other threads.
addListener
in interface Listenable<AssemblyLine.AssemblyLineListener>
listener
- A listener.public void removeListener(AssemblyLine.AssemblyLineListener listener)
This method is for internal use only. Users must not rely on it.
Unregister a listener for AssemblyLine events. Can be called by other threads.
Beware that the listener may get notified a few times after it was unregistered. The only way to ensure this does not happen is to unregister the listener on the AssemblyLine thread, e.g. in a listener methods.
removeListener
in interface Listenable<AssemblyLine.AssemblyLineListener>
listener
- The listener object.public boolean getComponentDebugMode(String componentName) throws Exception
componentName
- The name of a component as it appears in the configuration.
Exception
- If the component name is invalid.public void setComponentDebugMode(String componentName, boolean debug) throws Exception
componentName
- The name of a component as it appears in the configuration.debug
- The new debug mode of the component.
Exception
- If the component name is invalid.public void dumpAssemblyLineState(String file, boolean append)
output
- Output file name or null. If null the log is used to print out the dump.append
- In case a file is specified setting this to true will append the dump to the filepublic AssemblyLine getParentAL()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |