|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AssemblyLine
Represents an AssemblyLine instance.
Method Summary | |
---|---|
void |
addListener(AssemblyLineListener listener,
boolean getLogs,
boolean getEntryOnEachCycle)
Register a listener for AssemblyLine events. |
void |
attachDebugger(int port,
String host,
boolean onerror)
Attach a debugger to the AssemblyLine. |
void |
detachDebugger(Object msg)
Detach the current debugger from the AssemblyLine. |
boolean |
getComponentDebugMode(String componentName)
Query the debug mode setting of the specified component (Connector or Function Component). |
AssemblyLineConfig |
getConfig()
Returns configuration information about the AssemblyLine. |
ConfigInstance |
getConfigInstance()
Returns the configuration instance of the AssemblyLine. |
String |
getGlobalUniqueID()
Returns AssemblyLine GUID. |
String |
getName()
Returns the name of the AssemblyLine. |
String |
getNullBehavior()
Gets the nullBehavior attribute of the AssemblyLine object |
String |
getNullBehaviorValue()
Gets the nullBehaviorValue attribute of the AssemblyLine object. |
Entry |
getResult()
This method returns the result entry object. |
TaskStatistics |
getStatistics()
This method returns the TaskStatistics object for this AssemblyLine. |
String |
getSystemLog()
Retrieves the current AssemblyLine's system log. |
String |
getSystemLogFileName()
Returns the name of the log file of the AssemblyLine (not prefixed by folders path). |
String |
getSystemLogFilePath()
Returns the fully-qualified path of the log file of the AssemblyLine. |
String |
getSystemLogLastChunk(int aLastKilobytes)
Retrieves the last chunk from the current AssemblyLine's system log. |
int |
getUniqueCode()
Returns the unique code of the AssemblyLine. |
boolean |
isActive()
Checks if the AssemblyLine is active. |
boolean |
isSimulating()
Check weather the AssemblyLine is simulating or not |
void |
removeListener(AssemblyLineListener listener)
Unregister a listener for AssemblyLine events. |
void |
setComponentDebugMode(String componentName,
boolean debug)
Modify the debug mode setting of the specified component (Connector or Function Component). |
void |
setSimulating(boolean simulate)
Changes the way the AssemblyLine treats the target systems it is connectig/interacting to/with. |
void |
stop()
Stops the execution of the AssemblyLine. |
void |
stop(boolean sync)
Stops the execution of the AssemblyLine, and waits for it to stop. |
Method Detail |
---|
ConfigInstance getConfigInstance() throws DIException, RemoteException
Example
var sessionFactory = java.rmi.Naming.lookup("rmi://127.0.0.1:1099/SessionFactory"); var remoteSession = sessionFactory.createSession(); var mAssemblyLine = remoteSession.getAssemblyLines()[0]; if (mAssemblyLine != null) { var mConfigInstance = mAssemblyLine.getConfigInstance(); var configId = mConfigInstance.getConfigId(); var aAssemblyLineName = "AssemblyLine"; var assemblyLine = mConfigInstance.startAssemblyLine(aAssemblyLineName); var objectName = com.ibm.di.api.jmx.mbeans.AssemblyLine.genObjectName(assemblyLine.getName(), assemblyLine.getUniqueCode()); } else { main.logmsg("No Remote Assembly Lines Running"); }
DIException
- if an error occurs while retrieving the configuration
instance information.
RemoteException
- if a communication-related exception occurs.String getName() throws DIException, RemoteException
Example
var sessionFactory = java.rmi.Naming.lookup("rmi://127.0.0.1:1099/SessionFactory"); var remoteSession = sessionFactory.createSession(); var mAssemblyLine = remoteSession.getAssemblyLines()[0]; if (mAssemblyLine != null) { var mConfigInstance = mAssemblyLine.getConfigInstance(); var configId = mConfigInstance.getConfigId(); var aAssemblyLineName = "AssemblyLine"; var assemblyLine = mConfigInstance.startAssemblyLine(aAssemblyLineName); var objectName = com.ibm.di.api.jmx.mbeans.AssemblyLine.genObjectName(assemblyLine.getName(), assemblyLine.getUniqueCode()); } else { main.logmsg("No Remote Assembly Lines Running"); }
DIException
- if an error occurs while retrieving the name of the
AssemblyLine.
RemoteException
- if a communication-related exception occurs.int getUniqueCode() throws DIException, RemoteException
Example
var sessionFactory = java.rmi.Naming.lookup("rmi://127.0.0.1:1099/SessionFactory"); var remoteSession = sessionFactory.createSession(); var remALListener = new com.ibm.di.admin.remote.RemoteALListener(remoteSession, false); var runningAL = session.getAssemblyLines()[0]; remALListener.setCode(runningAL.getUniqueCode());
DIException
- if an error occurs while retrieving the unique code of the
AssemblyLine.
RemoteException
- if a communication-related exception occurs.AssemblyLineConfig getConfig() throws DIException, RemoteException
DIException
- if an error occurs while retrieving the configuration
information of the AssemblyLine.
RemoteException
- if a communication-related exception occurs.String getNullBehavior() throws DIException, RemoteException
DIException
- if an error occurs while getting the nullBehavior attribute.
RemoteException
- if a communication-related exception occurs.String getNullBehaviorValue() throws DIException, RemoteException
DIException
- if an error occurs while getting the nullBehaviorValue
attribute.
RemoteException
- if a communication-related exception occurs.TaskStatistics getStatistics() throws DIException, RemoteException
Example
var runningALs = null; var stats = null; var result = null; var sessionFactory = java.rmi.Naming.lookup("rmi://127.0.0.1:1099/SessionFactory"); var remoteSession = sessionFactory.createSession(); var runningConfigs = remoteSession.getConfigInstances(); if (runningConfigs != null) { for (var i = 0; i < runningConfigs.length; i++) { runningALs = runningConfigs[i].getAssemblyLines(); for (var j = 0; j < runningALs.length; j++) { if (runningALs[j].isActive()) { stats = runningALs[j].getStatistics().toString(); main.logmsg("statistics[" + j + "] = " + stats); result = runningALs[j].getResult(); var attr = new com.ibm.di.entry.Attribute("LogURL", "/log/" + runningALs[j].getGlobalUniqueID()); runningALs[j].stop(); } } } } else { main.logmsg("No remote config instances available"); }
DIException
- if an error occurs while getting the AssemblyLine statistics.
RemoteException
- if a communication-related exception occurs.boolean isActive() throws DIException, RemoteException
Example
var runningALs = null; var stats = null; var result = null; var sessionFactory = java.rmi.Naming.lookup("rmi://127.0.0.1:1099/SessionFactory"); var remoteSession = sessionFactory.createSession(); var runningConfigs = remoteSession.getConfigInstances(); if (runningConfigs != null) { for (var i = 0; i < runningConfigs.length; i++) { runningALs = runningConfigs[i].getAssemblyLines(); for (var j = 0; j < runningALs.length; j++) { if (runningALs[j].isActive()) { stats = runningALs[j].getStatistics().toString(); main.logmsg("statistics[" + j + "] = " + stats); result = runningALs[j].getResult(); var attr = new com.ibm.di.entry.Attribute("LogURL", "/log/" + runningALs[j].getGlobalUniqueID()); runningALs[j].stop(); } } } } else { main.logmsg("No remote config instances available"); }
DIException
- if an error occurs while getting the AssemblyLine state.
RemoteException
- if a communication-related exception occurs.Entry getResult() throws DIException, RemoteException
Example
var runningALs = null; var stats = null; var result = null; var sessionFactory = java.rmi.Naming.lookup("rmi://127.0.0.1:1099/SessionFactory"); var remoteSession = sessionFactory.createSession(); var runningConfigs = remoteSession.getConfigInstances(); if (runningConfigs != null) { for (var i = 0; i < runningConfigs.length; i++) { runningALs = runningConfigs[i].getAssemblyLines(); for (var j = 0; j < runningALs.length; j++) { if (runningALs[j].isActive()) { stats = runningALs[j].getStatistics().toString(); main.logmsg("statistics[" + j + "] = " + stats); result = runningALs[j].getResult(); var attr = new com.ibm.di.entry.Attribute("LogURL", "/log/" + runningALs[j].getGlobalUniqueID()); runningALs[j].stop(); } } } } else { main.logmsg("No remote config instances available"); }
DIException
- if an error occurs while getting the result Entry.
RemoteException
- if a communication-related exception occurs.void stop() throws DIException, RemoteException
Example
var runningALs = null; var stats = null; var result = null; var sessionFactory = java.rmi.Naming.lookup("rmi://127.0.0.1:1099/SessionFactory"); var remoteSession = sessionFactory.createSession(); var runningConfigs = remoteSession.getConfigInstances(); if (runningConfigs != null) { for (var i = 0; i < runningConfigs.length; i++) { runningALs = runningConfigs[i].getAssemblyLines(); for (var j = 0; j < runningALs.length; j++) { if (runningALs[j].isActive()) { stats = runningALs[j].getStatistics().toString(); main.logmsg("statistics[" + j + "] = " + stats); result = runningALs[j].getResult(); var attr = new com.ibm.di.entry.Attribute("LogURL", "/log/" + runningALs[j].getGlobalUniqueID()); runningALs[j].stop(); } } } } else { main.logmsg("No remote config instances available"); }
DIException
- if an error occurs while stopping the AssemblyLine.
RemoteException
- if a communication-related exception occurs.void stop(boolean sync) throws DIException, RemoteException
Example
var stats = null; var sessionFactory = java.rmi.Naming.lookup("rmi://127.0.0.1:1099/SessionFactory"); var remoteSession = sessionFactory.createSession(); var runningConfigs = remoteSession.getConfigInstances(); for (var i = 0; i < runningConfigs.length; i++) { var runningALs = runningConfigs[i].getAssemblyLines(); for (var j = 0; j < runningALs.length; j++) { if (runningALs[j].isActive()) { main.logmsg("Stopping [" + j + "]: " + runningALs[j].getName()); runningALs[j].stop(false); stats = runningALs[j].getStatistics().toString(); main.logmsg("statistics[" + j + "] = " + stats); } } }
sync
- If true, create a new Thread on the server to do the waiting.
DIException
- if an error occurs while stopping the AssemblyLine.
RemoteException
String getSystemLogFilePath() throws DIException, RemoteException
DIException
- if an error occurs while obtaining AssemblyLine log file
path.
RemoteException
- if a communication-related exception occurs.String getSystemLogFileName() throws DIException, RemoteException
DIException
- if an error occurs while obtaining AssemblyLine log file
name.
RemoteException
- if a communication-related exception occurs.String getSystemLog() throws DIException, RemoteException
DIException
- if an error occurs while obtaining AssemblyLine's log.
RemoteException
- if a communication-related exception occurs.String getSystemLogLastChunk(int aLastKilobytes) throws DIException, RemoteException
aLastKilobytes
- specifies in kilobytes the size of the log's last chunk that
will be read.
DIException
- if an error occurs while obtaining AssemblyLine's log.
RemoteException
- if a communication-related exception occurs.String getGlobalUniqueID() throws DIException, RemoteException
Example
var runningALs = null; var stats = null; var result = null; var sessionFactory = java.rmi.Naming.lookup("rmi://127.0.0.1:1099/SessionFactory"); var remoteSession = sessionFactory.createSession(); var runningConfigs = remoteSession.getConfigInstances(); if (runningConfigs != null) { for (var i = 0; i < runningConfigs.length; i++) { runningALs = runningConfigs[i].getAssemblyLines(); for (var j = 0; j < runningALs.length; j++) { if (runningALs[j].isActive()) { stats = runningALs[j].getStatistics().toString(); main.logmsg("statistics[" + j + "] = " + stats); result = runningALs[j].getResult(); var attr = new com.ibm.di.entry.Attribute("LogURL", "/log/" + runningALs[j].getGlobalUniqueID()); runningALs[j].stop(); } } } } else { main.logmsg("No remote config instances available"); }
DIException
- if an error occurs while obtaining the AssemblyLine GUID
value.
RemoteException
- if a communication-related exception occurs.boolean isSimulating() throws DIException, RemoteException
DIException
- if an error occurs while obtaining the simulation state
RemoteException
- if connection error occurs.void setSimulating(boolean simulate) throws DIException, RemoteException
simulate
- true switches the simulation on, false switches it off
DIException
- if an error occurs while changing the simulation state
RemoteException
- if connection error occurs.void addListener(AssemblyLineListener listener, boolean getLogs, boolean getEntryOnEachCycle) throws DIException, RemoteException
listener
- Listener for AssemblyLine events.getLogs
- If true, the listener will receive logged messages.getEntryOnEachCycle
- If true the listener will receive the current entry at each
AssemblyLine cycle's end.
DIException
- if the listener cannot be registered.
RemoteException
- if connection error occurs.removeListener(AssemblyLineListener)
void removeListener(AssemblyLineListener listener) throws DIException, RemoteException
Unregister a listener for AssemblyLine events. You must be admin to
execute this method. Listeners are associated with the API object, not
with the AssemblyLine in the Server, so you can remove only listeners
added with the #addListener(AssemblyLineListener, boolean)
method
on the same object.
Beware that the listener may get notified one more time after it was unregistered. The only way to ensure this does not happen is to unregister the listener in one of its callback methods.
listener
- The listener that needs to be removed.
DIException
- if the listener cannot be unregistered.
RemoteException
- if connection error occurs.#addListener(AssemblyLineListener, boolean)
void attachDebugger(int port, String host, boolean onerror) throws DIException, RemoteException
port
- Port of the debugger.host
- Host of the debugger.onerror
- If true breakpoints are disabled except when there is an
error.
DIException
- If the AssemblyLine is already being debugged or the
AssemblyLine cannot connect to the debugger.
RemoteException
- If connection error occurs.void detachDebugger(Object msg) throws DIException, RemoteException
msg
- This object will be sent to the debugger before the detaching
occurs. Must be serializable. If null, nothing will be sent.
DIException
- If an error occurs while detaching the debugger.
RemoteException
- If connection error occurs.boolean getComponentDebugMode(String componentName) throws DIException, RemoteException
getConfig()
.
componentName
- The name of a Connector or a Function Component from this
AssemblyLine. Must be spelled exactly as it appears in the
configuration.
DIException
- If an error occurs while querying the debug mode.
RemoteException
- If connection error occurs.void setComponentDebugMode(String componentName, boolean debug) throws DIException, RemoteException
getConfig()
. If you run the same AssemblyLine
again it will use the settings from the configuration.
componentName
- The name of a Connector or a Function Component from this
AssemblyLine.debug
- The new debug mode of the component.
DIException
- If an error occurs while setting the debug mode.
RemoteException
- If connection error occurs.getComponentDebugMode(String)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |