com.ibm.di.api.jmx.mbeans
Interface AssemblyLineMBean

All Superinterfaces:

BaseAdminMBean, BaseMBean

All Known Implementing Classes:

AssemblyLine

public interface AssemblyLineMBean
extends BaseAdminMBean

Represents an AssemblyLine instance.

Method Summary

void	attachDebugger(int port, java.lang.String host, boolean onerror) Attach a debugger to the AssemblyLine.
void	detachDebugger(java.lang.Object msg) Detach the current debugger from the AssemblyLine.
AssemblyLineConfig	getConfig() Returns configuration information about the AssemblyLine.
javax.management.ObjectName	getConfigInstance() Returns ObjectName generated from the AssemblyLine’s configuration ID, gotten from the AssemblyLine’s configuration instance.
java.lang.String	getGlobalUniqueID() Returns AssemblyLine GUID.
java.lang.String	getName() Returns the name of the AssemblyLine.
java.lang.String	getNullBehavior() Gets the nullBehavior attribute of the AssemblyLine object
java.lang.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.
java.lang.String	getSystemLog() Retrieves the current AssemblyLine's system log.
java.lang.String	getSystemLogFileName() Returns the name of the log file of the AssemblyLine (not prefixed by folders path).
java.lang.String	getSystemLogFilePath() Returns the fully-qualified path of the log file of the AssemblyLine.
java.lang.String	getSystemLogLastChunk(java.lang.Integer aLastKilobytes) Retrieves the last chunk from the current AssemblyLine's system log.
java.lang.Integer	getUniqueCode() Returns the unique code of the AssemblyLine.
java.lang.Boolean	isActive() Checks if the AssemblyLine is active.
void	stop() Stops the execution of the AssemblyLine.

Methods inherited from interface com.ibm.di.api.jmx.mbeans.BaseMBean

getId, getType

Method Detail

getConfigInstance

javax.management.ObjectName getConfigInstance()
                                              throws DIException

Returns ObjectName generated from the AssemblyLine’s configuration ID, gotten from the AssemblyLine’s configuration instance.

Returns:

ObjectName object generated from the AssemblyLine’s configuration ID.

Throws:

DIException - if an error occurs while generating the ObjectName.

getName

java.lang.String getName()
                         throws DIException

Returns the name of the AssemblyLine.

Returns:

String object representing the AssemblyLine’s name.

Throws:

DIException - if an error occurs while retrieving the name of the AssemblyLine.

getUniqueCode

java.lang.Integer getUniqueCode()
                                throws DIException

Returns the unique code of the AssemblyLine.

Returns:

Integer object representing the unique code of the AssemblyLine.

Throws:

DIException - if an error occurs while retrieving the unique code of the AssemblyLine.

getConfig

AssemblyLineConfig getConfig()
                             throws DIException

Returns configuration information about the AssemblyLine.

Returns:

AssemblyLineConfig representing the configuration information of the AssemblyLine.

Throws:

DIException - if an error occurs while retrieving the configuration information of the AssemblyLine.

getNullBehavior

java.lang.String getNullBehavior()
                                 throws DIException

Gets the nullBehavior attribute of the AssemblyLine object

Returns:

String object representing the nullBehavior attribute value or null if no setting values are available for the AssemblyLine.

Throws:

DIException - if an error occurs while getting the nullBehavior attribute.

getNullBehaviorValue

java.lang.String getNullBehaviorValue()
                                      throws DIException

Gets the nullBehaviorValue attribute of the AssemblyLine object.

Returns:

String object representing the nullBehaviorValue attribute value or null if no setting values are available for the AssemblyLine.

Throws:

DIException - if an error occurs while getting the nullBehaviorValue attribute.

getStatistics

TaskStatistics getStatistics()
                             throws DIException

This method returns the TaskStatistics object for this AssemblyLine.

Returns:

The accumulated TaskStatistics object.

Throws:

DIException - if an error occurs while getting the AssemblyLine statistics.

isActive

java.lang.Boolean isActive()
                           throws DIException

Checks if the AssemblyLine is active.

Returns:

true if the AssemblyLine’s thread is alive, false otherwise.

Throws:

DIException - if an error occurs while getting the AssemblyLine state.

getResult

Entry getResult()
                throws DIException

This method returns the result entry object. This object is a copy of the working entry as it were when the AssemblyLine finished processing the connectors.

Returns:

The last "work" entry object.

Throws:

DIException - if an error occurs while getting the result Entry.

stop

void stop()
          throws DIException

Stops the execution of the AssemblyLine.

Throws:

DIException - if an error occurs while stopping the AssemblyLine.

getSystemLogFilePath

java.lang.String getSystemLogFilePath()
                                      throws DIException

Returns the fully-qualified path of the log file of the AssemblyLine.

Returns:

the fully-qualified log file path.

Throws:

DIException - if an error occurs while obtaining AssemblyLine log file path.

getSystemLogFileName

java.lang.String getSystemLogFileName()
                                      throws DIException

Returns the name of the log file of the AssemblyLine (not prefixed by folders path).

Returns:

the log file name.

Throws:

DIException - if an error occurs while obtaining AssemblyLine log file name.

getSystemLog

java.lang.String getSystemLog()
                              throws DIException

Retrieves the current AssemblyLine's system log.

Returns:

the log generated by the AssemblyLine so far.

Throws:

DIException - if an error occurs while obtaining AssemblyLine's log.

getSystemLogLastChunk

java.lang.String getSystemLogLastChunk(java.lang.Integer aLastKilobytes)
                                       throws DIException

Retrieves the last chunk from the current AssemblyLine's system log.

Parameters:

aLastKilobytes - specifies in kilobytes the size of the log's last chunk that will be read.

Returns:

The last chunk of the AssemblyLine's log, generated so far.

Throws:

DIException - if an error occurs while obtaining AssemblyLine's log.

getGlobalUniqueID

java.lang.String getGlobalUniqueID()
                                   throws DIException

Returns AssemblyLine GUID. The GUID is a string value that is unique for each component ever created by a particular TDI Server.

Returns:

The AssemblyLine GUID value.

Throws:

DIException - if an error occurs while obtaining the GUID.

attachDebugger

void attachDebugger(int port,
                    java.lang.String host,
                    boolean onerror)
                    throws DIException

Attach a debugger to the AssemblyLine. You must be admin to execute this method.

Parameters:

port - Port of the debugger.

host - Host of the debugger.

onerror - If true breakpoints are disabled except when there is an error.

Throws:

DIException - If the AssemblyLine is already being debugged or the AssemblyLine cannot connect to the debugger.

Since:

7.0

detachDebugger

void detachDebugger(java.lang.Object msg)
                    throws DIException

Detach the current debugger from the AssemblyLine. You must be admin to execute this method.

Parameters:

msg - This object will be sent to the debugger before the detaching occurs. Must be serializable. If null, nothing will be sent.

Throws:

DIException - If an error occurs while detaching the debugger.

Since:

7.0