com.ibm.di.api.remote.impl
Class AssemblyLineImpl

java.lang.Object
  java.rmi.server.RemoteObject
      java.rmi.server.RemoteServer
          java.rmi.server.UnicastRemoteObject
              com.ibm.di.api.remote.impl.AssemblyLineImpl

All Implemented Interfaces:

AssemblyLine, Serializable, Remote

public class AssemblyLineImpl
extends UnicastRemoteObject
implements AssemblyLine

See Also:

Serialized Form

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

ref

Method Summary

static AssemblyLineImpl	createInstance(AssemblyLine aLocalAssemblyLine, SessionImpl aSession)
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.
void	stop() Stops the execution of the AssemblyLine.

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getConfigInstance

public ConfigInstance getConfigInstance()
                                 throws DIException,
                                        RemoteException

Description copied from interface: AssemblyLine

Returns the configuration instance of the AssemblyLine.

Specified by:

getConfigInstance in interface AssemblyLine

Returns:

Returns ConfigInstance object representing the configuration instance of the AssemblyLine.

Throws:

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

RemoteException - if a communication-related exception occurs.

getName

public String getName()
               throws DIException,
                      RemoteException

Description copied from interface: AssemblyLine

Returns the name of the AssemblyLine.

Specified by:

getName in interface AssemblyLine

Returns:

String object representing the AssemblyLine’s name.

Throws:

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

RemoteException - if a communication-related exception occurs.

getUniqueCode

public int getUniqueCode()
                  throws DIException,
                         RemoteException

Description copied from interface: AssemblyLine

Returns the unique code of the AssemblyLine.

Specified by:

getUniqueCode in interface AssemblyLine

Returns:

int value representing the unique code of the AssemblyLine.

Throws:

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

RemoteException - if a communication-related exception occurs.

getConfig

public AssemblyLineConfig getConfig()
                             throws DIException,
                                    RemoteException

Description copied from interface: AssemblyLine

Returns configuration information about the AssemblyLine.

Specified by:

getConfig in interface AssemblyLine

Returns:

AssemblyLineConfig representing the configuration information of the AssemblyLine.

Throws:

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

RemoteException - if a communication-related exception occurs.

getNullBehavior

public String getNullBehavior()
                       throws DIException,
                              RemoteException

Description copied from interface: AssemblyLine

Gets the nullBehavior attribute of the AssemblyLine object

Specified by:

getNullBehavior in interface AssemblyLine

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.

RemoteException - if a communication-related exception occurs.

getNullBehaviorValue

public String getNullBehaviorValue()
                            throws DIException,
                                   RemoteException

Description copied from interface: AssemblyLine

Gets the nullBehaviorValue attribute of the AssemblyLine object.

Specified by:

getNullBehaviorValue in interface AssemblyLine

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.

RemoteException - if a communication-related exception occurs.

getStatistics

public TaskStatistics getStatistics()
                             throws DIException,
                                    RemoteException

Description copied from interface: AssemblyLine

This method returns the TaskStatistics object for this AssemblyLine.

Specified by:

getStatistics in interface AssemblyLine

Returns:

The accumulated TaskStatistics object.

Throws:

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

RemoteException - if a communication-related exception occurs.

isActive

public boolean isActive()
                 throws DIException,
                        RemoteException

Description copied from interface: AssemblyLine

Checks if the AssemblyLine is active.

Specified by:

isActive in interface AssemblyLine

Returns:

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

Throws:

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

RemoteException - if a communication-related exception occurs.

getResult

public Entry getResult()
                throws DIException,
                       RemoteException

Description copied from interface: AssemblyLine

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.

Specified by:

getResult in interface AssemblyLine

Returns:

The last "work" entry object.

Throws:

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

RemoteException - if a communication-related exception occurs.

stop

public void stop()
          throws DIException,
                 RemoteException

Description copied from interface: AssemblyLine

Stops the execution of the AssemblyLine.

Specified by:

stop in interface AssemblyLine

Throws:

DIException - if an error occurs while stopping the AssemblyLine.

RemoteException - if a communication-related exception occurs.

getSystemLogFilePath

public String getSystemLogFilePath()
                            throws DIException,
                                   RemoteException

Description copied from interface: AssemblyLine

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

Specified by:

getSystemLogFilePath in interface AssemblyLine

Returns:

the fully-qualified log file path.

Throws:

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

RemoteException - if a communication-related exception occurs.

getSystemLogFileName

public String getSystemLogFileName()
                            throws DIException,
                                   RemoteException

Description copied from interface: AssemblyLine

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

Specified by:

getSystemLogFileName in interface AssemblyLine

Returns:

the log file name.

Throws:

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

RemoteException - if a communication-related exception occurs.

getSystemLog

public String getSystemLog()
                    throws DIException,
                           RemoteException

Description copied from interface: AssemblyLine

Retrieves the current AssemblyLine's system log.

Specified by:

getSystemLog in interface AssemblyLine

Returns:

the log generated by the AssemblyLine so far.

Throws:

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

RemoteException - if a communication-related exception occurs.

getSystemLogLastChunk

public String getSystemLogLastChunk(int aLastKilobytes)
                             throws DIException,
                                    RemoteException

Description copied from interface: AssemblyLine

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

Specified by:

getSystemLogLastChunk in interface AssemblyLine

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.

RemoteException - if a communication-related exception occurs.

createInstance

public static AssemblyLineImpl createInstance(AssemblyLine aLocalAssemblyLine,
                                              SessionImpl aSession)
                                       throws DIException,
                                              RemoteException

Throws:

DIException

RemoteException

getGlobalUniqueID

public String getGlobalUniqueID()
                         throws DIException,
                                RemoteException

Description copied from interface: AssemblyLine

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

Specified by:

getGlobalUniqueID in interface AssemblyLine

Returns:

The AssemblyLine GUID value.

Throws:

DIException - if an error occurs while obtaining the AssemblyLine GUID value.

RemoteException - if a communication-related exception occurs.