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

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

All Implemented Interfaces:

AssemblyLineHandlerMBean, BaseAdminMBean, BaseMBean

public class AssemblyLineHandler
extends BaseAdmin
implements AssemblyLineHandlerMBean

This class implements several methods to handle an AssemblyLine.

Field Summary

static java.lang.String

MBEAN_TYPE Type of the MBean.

Constructor Summary

AssemblyLineHandler(AssemblyLineHandler aALHandler)
Class constructor

Method Summary

void	close() Closes the Assembly LineHandler MBean.
Entry	executeCycle() Executes an AssemblyLine cycle with null work Entry attribute.
Entry	executeCycle(Entry aEntry) Executes an AssemblyLine cycle.
Entry	executeCycle(Entry aEntry, java.lang.Boolean aProcessTCB) Executes an AssemblyLine cycle.
static javax.management.ObjectName	genObjectName(java.lang.String aName, int aUniqueCode) Generates object name for specified assembly line handler.
javax.management.ObjectName	getAssemblyLine() Returns an ObjectName generated from the AssemblyLine’s name and AssemblyLine’s unique code.
java.lang.String	getId() Reads attribute "Id".
java.lang.String	getType() Reads attribute "Type".

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 java.lang.String MBEAN_TYPE

Type of the MBean.

See Also:

Constant Field Values

Constructor Detail

AssemblyLineHandler

public AssemblyLineHandler(AssemblyLineHandler aALHandler)
                    throws DIException

Class constructor

Parameters:

aALHandler - com.ibm.di.api.local.AssemblyLineHandler

Throws:

DIException

Method Detail

getType

public java.lang.String getType()

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 java.lang.String getId()

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.

getAssemblyLine

public javax.management.ObjectName getAssemblyLine()
                                            throws DIException

Returns an ObjectName generated from the AssemblyLine’s name and AssemblyLine’s unique code.

Specified by:

getAssemblyLine in interface AssemblyLineHandlerMBean

Returns:

the ObjectName of the AssemblyLine’s.

Throws:

DIException - if an error occurs while getting the AssemblyLine’s ObjectName.

executeCycle

public Entry executeCycle(Entry aEntry,
                          java.lang.Boolean aProcessTCB)
                   throws DIException

Executes an AssemblyLine cycle. If an Entry is provided then it becomes the work entry.

Specified by:

executeCycle in interface AssemblyLineHandlerMBean

Parameters:

aEntry - the work entry to use, or null to use an empty work entry/iterator entry.

aProcessTCB - if true, the AL's call/return attribute maps are applied to the provided entry and returned entry.

Returns:

the work entry at the end of the cycle.

Throws:

DIException - if an error occurs while executing the AssemblyLine.

executeCycle

public Entry executeCycle(Entry aEntry)
                   throws DIException

Executes an AssemblyLine cycle. If an Entry is provided then it becomes the work entry.

Specified by:

executeCycle in interface AssemblyLineHandlerMBean

Parameters:

aEntry - the work entry to use, or null to use an empty work entry/iterator entry.

Returns:

the work entry at the end of the cycle.

Throws:

DIException - if an error occurs while executing the AssemblyLine.

executeCycle

public Entry executeCycle()
                   throws DIException

Executes an AssemblyLine cycle with null work Entry attribute.

Specified by:

executeCycle in interface AssemblyLineHandlerMBean

Returns:

the work entry at the end of the cycle

Throws:

DIException - if an error occurs while executing the AssemblyLine.

close

public void close()
           throws DIException

Closes the Assembly LineHandler MBean.

Specified by:

close in interface AssemblyLineHandlerMBean

Throws:

DIException - if error occurs while closing the MBean.

genObjectName

public static javax.management.ObjectName genObjectName(java.lang.String aName,
                                                        int aUniqueCode)
                                                 throws DIException

Generates object name for specified assembly line handler.

Parameters:

aName - the name of the assembly line handler.

aUniqueCode - unique code used for building the AssemblyLineHandler MBean id.

Returns:

the generated object name

Throws:

DIException - if error occurs while creating AssemblyLineHandler JMX object name.