com.ibm.di.api.jmx.mbeans
Class AssemblyLine

java.lang.Object
  com.ibm.di.api.jmx.mbeans.BaseAdmin
      com.ibm.di.api.jmx.mbeans.AssemblyLine

All Implemented Interfaces:

AssemblyLineMBean, BaseAdminMBean, BaseMBean

public class AssemblyLine
extends BaseAdmin
implements AssemblyLineMBean

Field Summary

static String

MBEAN_TYPE

Constructor Summary

AssemblyLine(AssemblyLine aAssemblyLine)

Method Summary

static javax.management.ObjectName	genObjectName(String aAssemblyLineName, int aUniqueCode)
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.
String	getGlobalUniqueID() Returns AssemblyLine GUID.
String	getId() Reads attribute "Id".
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(Integer aLastKilobytes) Retrieves the last chunk from the current AssemblyLine's system log.
String	getType() Reads attribute "Type".
Integer	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 com.ibm.di.api.jmx.mbeans.BaseAdmin

getCurrentUserId, getKeyPropertyList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MBEAN_TYPE

public static final String MBEAN_TYPE

See Also:

Constant Field Values

Constructor Detail

AssemblyLine

public AssemblyLine(AssemblyLine aAssemblyLine)
             throws DIException

Throws:

DIException

Method Detail

getType

public String getType()

Description copied from interface: BaseMBean

Reads attribute "Type".

getType() and getId() are used in a common schema for object names for all MBeans in the management package. The key properties part of the object name of each MBean is defined as "type=" + getType() + ",id=" + getId(), for example "type=AssemblyLine,id=Hello".

Specified by:

getType in interface BaseMBean

Returns:

the type of this MBean.

getId

public String getId()

Description copied from interface: BaseMBean

Reads attribute "Id". The "Id" value should be different for different MBeans of the same type.

getType() and getId() are used in a common schema for object names for all MBeans in the management package. The key properties part of the object name of each MBean is defined as "type=" + getType() + ",id=" + getId(), for example "type=AssemblyLine,id=Hello".

Specified by:

getId in interface BaseMBean

Returns:

the Id of this MBean.

getConfigInstance

public javax.management.ObjectName getConfigInstance()
                                              throws DIException

Description copied from interface: AssemblyLineMBean

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

Specified by:

getConfigInstance in interface AssemblyLineMBean

Returns:

ObjectName object generated from the AssemblyLine’s configuration ID.

Throws:

DIException - if an error occurs while generating the ObjectName.

getName

public String getName()
               throws DIException

Description copied from interface: AssemblyLineMBean

Returns the name of the AssemblyLine.

Specified by:

getName in interface AssemblyLineMBean

Returns:

String object representing the AssemblyLine’s name.

Throws:

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

getUniqueCode

public Integer getUniqueCode()
                      throws DIException

Description copied from interface: AssemblyLineMBean

Returns the unique code of the AssemblyLine.

Specified by:

getUniqueCode in interface AssemblyLineMBean

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

public AssemblyLineConfig getConfig()
                             throws DIException

Description copied from interface: AssemblyLineMBean

Returns configuration information about the AssemblyLine.

Specified by:

getConfig in interface AssemblyLineMBean

Returns:

AssemblyLineConfig representing the configuration information of the AssemblyLine.

Throws:

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

getNullBehavior

public String getNullBehavior()
                       throws DIException

Description copied from interface: AssemblyLineMBean

Gets the nullBehavior attribute of the AssemblyLine object

Specified by:

getNullBehavior in interface AssemblyLineMBean

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

public String getNullBehaviorValue()
                            throws DIException

Description copied from interface: AssemblyLineMBean

Gets the nullBehaviorValue attribute of the AssemblyLine object.

Specified by:

getNullBehaviorValue in interface AssemblyLineMBean

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

public TaskStatistics getStatistics()
                             throws DIException

Description copied from interface: AssemblyLineMBean

This method returns the TaskStatistics object for this AssemblyLine.

Specified by:

getStatistics in interface AssemblyLineMBean

Returns:

The accumulated TaskStatistics object.

Throws:

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

isActive

public Boolean isActive()
                 throws DIException

Description copied from interface: AssemblyLineMBean

Checks if the AssemblyLine is active.

Specified by:

isActive in interface AssemblyLineMBean

Returns:

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

Throws:

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

getResult

public Entry getResult()
                throws DIException

Description copied from interface: AssemblyLineMBean

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 AssemblyLineMBean

Returns:

The last "work" entry object.

Throws:

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

stop

public void stop()
          throws DIException

Description copied from interface: AssemblyLineMBean

Stops the execution of the AssemblyLine.

Specified by:

stop in interface AssemblyLineMBean

Throws:

DIException - if an error occurs while stopping the AssemblyLine.

getSystemLogFilePath

public String getSystemLogFilePath()
                            throws DIException

Description copied from interface: AssemblyLineMBean

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

Specified by:

getSystemLogFilePath in interface AssemblyLineMBean

Returns:

the fully-qualified log file path.

Throws:

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

getSystemLogFileName

public String getSystemLogFileName()
                            throws DIException

Description copied from interface: AssemblyLineMBean

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

Specified by:

getSystemLogFileName in interface AssemblyLineMBean

Returns:

the log file name.

Throws:

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

getSystemLog

public String getSystemLog()
                    throws DIException

Description copied from interface: AssemblyLineMBean

Retrieves the current AssemblyLine's system log.

Specified by:

getSystemLog in interface AssemblyLineMBean

Returns:

the log generated by the AssemblyLine so far.

Throws:

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

getSystemLogLastChunk

public String getSystemLogLastChunk(Integer aLastKilobytes)
                             throws DIException

Description copied from interface: AssemblyLineMBean

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

Specified by:

getSystemLogLastChunk in interface AssemblyLineMBean

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.

genObjectName

public static javax.management.ObjectName genObjectName(String aAssemblyLineName,
                                                        int aUniqueCode)
                                                 throws DIException

Throws:

DIException

getGlobalUniqueID

public String getGlobalUniqueID()
                         throws DIException

Description copied from interface: AssemblyLineMBean

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 AssemblyLineMBean

Returns:

The AssemblyLine GUID value.

Throws:

DIException - if an error occurs while obtaining the GUID.