com.ibm.di.server
Class TaskCallBlock

java.lang.Object
  com.ibm.di.entry.DocImpl
      com.ibm.di.entry.Entry
          com.ibm.di.server.TaskCallBlock

All Implemented Interfaces:

Serializable, Cloneable, Document, Node

public class TaskCallBlock
extends Entry

The TaskCallBlock (TCB) is used by a caller to set a number of parameters for an AssemblyLine. The TCB can provide the user with a list of input/output parameters specified by an AssemblyLine and also all the connectors and their parameters the user can set. You can use this feature to discover dynamically what an AssemblyLine is expecting as its initial work entry and also what it will return in its result entry. The TCB consists of the following logical sections:

1. The Initial Work Entry passed to the AssemblyLine
2. The connector parameters
3. The input/output mapping rules for the AssemblyLine
4. An optional user provided accumulator object that receives all work entries from the AL

Calling an AssemblyLine with an initial work entry and setting the input connector's filePath parameter to 'd:/myinput.txt' is accomplished with the following code:

 var tcb = system.newTCB();
 tcb.setInitialWorkEntry(iwe);
 tcb.setConnectorParameter("input", "filePath", "d:/myinput.txt");
 
 var al = main.startAL("MyAssemblyLine", tcb);
 

The TCB is also called by the AssemblyLine for each work entry in the AL. This work entry can be accumulated by the TCB into an object called the accumulator. The accumulator can be one of the following:

• java.util.Collection - All work entries are cloned and added to the collection (e.g. ArrayList, Vector ..)
• ConnectorInterface - The putEntry() method is called
• ParserInterface - The writeEntry() method is called
• AssemblyLineComponent - The add() method is called

If the accumulator is not of the above classes/interfaces an exception is thrown. To accumulate all work entries in an AssemblyLine into an XML file you could do this:

 
 var parser = system.getParser ( "ibmdi.XML" );
 parser.setOutputStream ( new java.io.FileOutputStream ( "d:/accum.xml" );
 parser.initParser();
 tcb.setAccumulator ( parser );
 
 var al = main.startAL ( "MyAssemblyLine", tcb );
 al.join();
 
 parser.closeParser();
 
 

Of course, you could configure a connector instead of programming the parser manually as in:

 
  var connector = system.getConnector ("MypreconfiguredOutputConnectorWithXMLParser");
  tcb.setAccumulator ( connector );
  ...
  connector.terminate();
 
 

The TCB is typically initialized by the user and then used by the assemblyline. If the assemblyline has a call/return specification the TCB will remap input attributes (initial work entry) into what the AL expects internally and likewise for setting the result object. This is done so that the external call interface to an assemblyline can remain the same even though the internal work entry names change in the assemblyline itself. Once the TCB is passed to an assemblyline you should not expect anything more from the TCB. Use the assemblyline's getResult() and getStats() to retrieve the result object and statistics. The TCB result mapping is performed before the Epilog so you can still access the final result before the caller of the AL gets to it.

See Also:

Serialized Form

Field Summary

static String	ACCUMULATOR_OBJECT
static String	AL_OPERATION
static String	AL_OPERATION_INIT
static String	AL_SETTINGS
static String	CONNECTOR_PARAMETERS
static String	INITIAL_WORK_ENTRY
static String	INPUT_PARAMETERS
static String	MAGIC_PROPERTY
static String	OUTPUT_PARAMETERS
static String	RESULT_ENTRY
static String	RUNMODE_PROPNAME
static String	RUNTIME_CONNECTOR
static String	RUNTIME_FUNCTION
static String	TCB_ATTRIBUTE_DEFAULT
static String	TCB_ATTRIBUTE_REQUIRED
static String	TCB_ATTRIBUTE_SYNTAX
static String	TCB_ATTRIBUTE_TARGET
static String	TCB_PERMIT_EMPTY

Fields inherited from class com.ibm.di.entry.Entry

ESCAPE_CHAR, OP_ADD, OP_ADD2, OP_DEL, OP_DEL2, OP_GEN, OP_GEN2, OP_MOD, OP_MOD2, OP_UNCHANGED, OP_UNCHANGED2, PATH_SEPARATOR_CHAR, PATH_SEPARATOR_STR

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

TaskCallBlock()

TaskCallBlock(Entry old, AssemblyLineConfig alc, TaskInterface task)
Constructor - Populate object with saved data and current task context.

TaskCallBlock(String assemblyLine)
Constructor - Populate object with assemblyline input/output parameters and connector parameters.

TaskCallBlock(String assemblyLine, AssemblyLineConfig alc, TaskInterface task)
Constructor - Populate object with assemblyline input/output parameters and connector parameters, and a task context.

TaskCallBlock(String assemblyLine, TaskInterface task)

Method Summary

void	accumulateEntry(Entry work) Adds an entry to the accumulator object (if any configured).
void	applyALSettings(AssemblyLineConfig alc) Applies the user defined AL settings to the AssemblyLineConfig.
Entry	buildInitialWorkEntry() Constructs a new initial work entry if there are an input parameter specification in the assemblyline.
Entry	buildResultEntry() Builds the result object based on AL's result object and the output parameter specification.
Entry	buildTCBEntry(Entry input, boolean inputMap) Constructs a new Entry based on the parameter descriptors in params and source attributes in input entry.
TaskCallBlock	clone() Creates a shallow clone of the receiver.
SchemaConfig	getALInitializationParameters() Returns the SchemaConfig for the Published AssemblyLine Initialization Parameters.
String	getALOperation() Returns the AL operation
OperationConfig	getALOperationConfig() Returns the AssemblyLine's OperationConfig for the current operation
OperationConfig	getALOperationConfig(String name) Returns the OperationConfig for the named operation in the AssemblyLine.
String[]	getALOperations() Returns a String[] with names of operations for the AssemblyLine.
Object	getALSetting(String paramname) Returns the AL Settings parameter to value.
Entry	getALSettings() Returns the Entry containing the user specified AL settings.
AssemblyLineConfig	getAssemblyLineConfig()
String	getAssemblyLineName() Returns the assemblyline name this TCB was built from
boolean	getBoolProperty(String propname, boolean defval)
Object	getConnectorParameter(String connectorName, String connectorParameter) Returns the current value for a connector parameter as a String
Object	getConnectorParameter(String connectorName, String connectorParameter, boolean string) Returns the current value for a connector parameter.
Entry	getConnectorParameters()
Entry	getConnectorParameters(String connectorName) Returns the parameters Entry for a specific connector.
Entry	getInitialWorkEntry() Returns the initial work entry provided by caller
Entry	getInputParameters() Returns the input parameter entry (from the AssemblyLine specification)
int	getIntProperty(String propname, int defval)
Entry	getOperationInitParams() Returns the operation init parameters
Entry	getOutputParameters()
Entry	getResultEntry() Returns the result entry provided by the caller
String	getRunMode() Returns the runmode
ConnectorInterface	getRuntimeConnector(String connectorName) Returns the runtime connector for a named connector
FunctionInterface	getRuntimeFunction(String name) Returns the runtime function for a named function
String	getStringProperty(String propname, String defval)
void	loadMapping() Set the Call/Return mapping
void	setAccumulator(Object accumulator) Set the accumulator object to the provided object.
void	setAccumulatorObject(Object accumulator) Set the accumulator object to the provided object.
void	setALOperation(String operation) Sets the AL Operation.
void	setALSetting(String paramname, Object value) Sets the AL Settings parameter to value.
void	setAssemblyLineName(String assemblyLine) Sets the assemblyline name this TCB applies to
void	setComponentEnabled(String name, boolean enabled) Set the named component to enabled or disabled status.
void	setComponentParameter(String componentName, String parameterName, Object parameterValue) Sets a component parameter.
void	setComponentParameter(String componentName, String parameterName, Object parameterValue, boolean protect) Sets a component parameter, with a possibility to protect the parameter.
void	setConnectorParameter(String connectorName, String parameterName, Object parameterValue) Sets a connector parameter.
void	setConnectorParameter(String connectorName, String parameterName, Object parameterValue, boolean protect) Sets a connector parameter.
void	setConnectorParameters(AssemblyLine task) Modifies connector configurations in the AssemblyLine (method is called by AssemblyLine)
void	setConnectorParameters(String connectorName, BaseConfiguration parameters) Populates the parameter Entry for a specific connector with names from the configuration.
void	setInitialWorkEntry(Entry entry) Sets the initial work entry
void	setInputParameters(Entry entry) Sets the input parameter entry (from the AssemblyLine specification)
void	setOperationInitParam(String paramName, Object paramValue) Sets an operation init parameter - this call creates the init param entry if not present and adds/replaces the param if one has already been set.
void	setOperationInitParams(Entry params) Sets the AL Operation initialize parameters.
void	setOutputParameters(Entry entry) Sets the output parameter entry (from the AssemblyLine specification)
void	setResultEntry(Entry entry)
void	setRunMode(String value) Sets the runmode.
void	setRuntimeConnector(String connectorName, ConnectorInterface runtimeConnector) Sets the runtime connector for a named connector.
void	setRuntimeFunction(String name, FunctionInterface function) Sets the runtime function for a named function.
void	setTask(TaskInterface task) Sets the logger from the given task context

Methods inherited from class com.ibm.di.entry.Entry

addAttributeValue, addAttributeValue, addAttributeValue, addAttributeValue, adoptNode, appendChild, clone, cloneNode, createAttribute, createAttributeNS, createCDATASection, createElement, createElementNS, createTextNode, enableDOM, get, getAttribute, getAttribute, getAttributeCollection, getAttributeNames, getBooleanValue, getChildNodes, getDocumentElement, getElementsByTagName, getElementsByTagNameNS, getFirstAttribute, getFirstChild, getLastChild, getNodeList, getNumberValue, getObject, getObject, getOp, getOperation, getProperty, getProperty, getPropertyNames, getString, getString, getStringValue, hasChildNodes, hasProperty, insertBefore, invalidateNamesList, isDOMEnabled, isEqualNode, merge, merge, mergeAttributeValue, mergeAttributeValue, mergeAttributeValue, newAttribute, newAttribute, removeAllAttributes, removeAttribute, removeAttribute, removeChild, renameNode, replaceChild, set, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeValues, setOp, setOperation, setProperty, setProperty, size, toDeltaString, toString, toXML

Methods inherited from class com.ibm.di.entry.DocImpl

compareDocumentPosition, createComment, createDocumentFragment, createEntityReference, createProcessingInstruction, getAttributes, getBaseURI, getDoctype, getDocumentURI, getDomConfig, getElementById, getFeature, getImplementation, getInputEncoding, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getStrictErrorChecking, getTextContent, getUserData, getXmlEncoding, getXmlStandalone, getXmlVersion, hasAttributes, importNode, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, normalizeDocument, setDocumentURI, setNodeValue, setPrefix, setStrictErrorChecking, setTextContent, setUserData, setXmlEncoding, setXmlStandalone, setXmlVersion

Methods inherited from class java.lang.Object

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

Field Detail

MAGIC_PROPERTY

public static final String MAGIC_PROPERTY

See Also:

Constant Field Values

INITIAL_WORK_ENTRY

public static final String INITIAL_WORK_ENTRY

See Also:

Constant Field Values

RESULT_ENTRY

public static final String RESULT_ENTRY

See Also:

Constant Field Values

CONNECTOR_PARAMETERS

public static final String CONNECTOR_PARAMETERS

See Also:

Constant Field Values

ACCUMULATOR_OBJECT

public static final String ACCUMULATOR_OBJECT

See Also:

Constant Field Values

RUNTIME_CONNECTOR

public static final String RUNTIME_CONNECTOR

See Also:

Constant Field Values

RUNTIME_FUNCTION

public static final String RUNTIME_FUNCTION

See Also:

Constant Field Values

RUNMODE_PROPNAME

public static final String RUNMODE_PROPNAME

See Also:

Constant Field Values

AL_SETTINGS

public static final String AL_SETTINGS

See Also:

Constant Field Values

AL_OPERATION

public static final String AL_OPERATION

See Also:

Constant Field Values

AL_OPERATION_INIT

public static final String AL_OPERATION_INIT

See Also:

Constant Field Values

INPUT_PARAMETERS

public static final String INPUT_PARAMETERS

See Also:

Constant Field Values

OUTPUT_PARAMETERS

public static final String OUTPUT_PARAMETERS

See Also:

Constant Field Values

TCB_PERMIT_EMPTY

public static final String TCB_PERMIT_EMPTY

See Also:

Constant Field Values

TCB_ATTRIBUTE_TARGET

public static final String TCB_ATTRIBUTE_TARGET

See Also:

Constant Field Values

TCB_ATTRIBUTE_REQUIRED

public static final String TCB_ATTRIBUTE_REQUIRED

See Also:

Constant Field Values

TCB_ATTRIBUTE_DEFAULT

public static final String TCB_ATTRIBUTE_DEFAULT

See Also:

Constant Field Values

TCB_ATTRIBUTE_SYNTAX

public static final String TCB_ATTRIBUTE_SYNTAX

See Also:

Constant Field Values

Constructor Detail

TaskCallBlock

public TaskCallBlock()

TaskCallBlock

public TaskCallBlock(String assemblyLine)
              throws Exception

Constructor - Populate object with assemblyline input/output parameters and connector parameters.

Throws:

Exception

TaskCallBlock

public TaskCallBlock(String assemblyLine,
                     TaskInterface task)
              throws Exception

Throws:

Exception

TaskCallBlock

public TaskCallBlock(String assemblyLine,
                     AssemblyLineConfig alc,
                     TaskInterface task)
              throws Exception

Constructor - Populate object with assemblyline input/output parameters and connector parameters, and a task context.

Throws:

Exception

TaskCallBlock

public TaskCallBlock(Entry old,
                     AssemblyLineConfig alc,
                     TaskInterface task)

Constructor - Populate object with saved data and current task context.

Method Detail

setTask

public void setTask(TaskInterface task)

Sets the logger from the given task context

loadMapping

public void loadMapping()

Set the Call/Return mapping

getAssemblyLineName

public String getAssemblyLineName()

Returns the assemblyline name this TCB was built from

setAssemblyLineName

public void setAssemblyLineName(String assemblyLine)

Sets the assemblyline name this TCB applies to

getInitialWorkEntry

public Entry getInitialWorkEntry()

Returns the initial work entry provided by caller

setInitialWorkEntry

public void setInitialWorkEntry(Entry entry)

Sets the initial work entry

buildInitialWorkEntry

public Entry buildInitialWorkEntry()
                            throws Exception

Constructs a new initial work entry if there are an input parameter specification in the assemblyline. Otherwise, uses the provided IWE asis.

Throws:

Exception

getInputParameters

public Entry getInputParameters()

Returns the input parameter entry (from the AssemblyLine specification)

setInputParameters

public void setInputParameters(Entry entry)

Sets the input parameter entry (from the AssemblyLine specification)

getOutputParameters

public Entry getOutputParameters()

setOutputParameters

public void setOutputParameters(Entry entry)

Sets the output parameter entry (from the AssemblyLine specification)

getResultEntry

public Entry getResultEntry()

Returns the result entry provided by the caller

setResultEntry

public void setResultEntry(Entry entry)

buildResultEntry

public Entry buildResultEntry()
                       throws Exception

Builds the result object based on AL's result object and the output parameter specification.

Throws:

Exception

getConnectorParameters

public Entry getConnectorParameters()

getConnectorParameters

public Entry getConnectorParameters(String connectorName)

Returns the parameters Entry for a specific connector.

getConnectorParameter

public Object getConnectorParameter(String connectorName,
                                    String connectorParameter)

Returns the current value for a connector parameter as a String

getConnectorParameter

public Object getConnectorParameter(String connectorName,
                                    String connectorParameter,
                                    boolean string)

Returns the current value for a connector parameter.

setConnectorParameters

public void setConnectorParameters(AssemblyLine task)
                            throws Exception

Modifies connector configurations in the AssemblyLine (method is called by AssemblyLine)

Throws:

Exception

setConnectorParameters

public void setConnectorParameters(String connectorName,
                                   BaseConfiguration parameters)

Populates the parameter Entry for a specific connector with names from the configuration.

setConnectorParameter

public void setConnectorParameter(String connectorName,
                                  String parameterName,
                                  Object parameterValue)

Sets a connector parameter.

Parameters:

connectorName - The Connector's name

parameterName - The name of the parameter for the Connector

parameterValue - The new value for the parameter

setComponentParameter

public void setComponentParameter(String componentName,
                                  String parameterName,
                                  Object parameterValue)

Sets a component parameter.

Parameters:

componentName - The Component's name

parameterName - The name of the parameter for the Component

parameterValue - The new value for the parameter

setConnectorParameter

public void setConnectorParameter(String connectorName,
                                  String parameterName,
                                  Object parameterValue,
                                  boolean protect)

Sets a connector parameter.

Parameters:

connectorName - The Connector's name

parameterName - The name of the parameter for the Connector

parameterValue - The new value for the parameter

protect - If true, do not print the value of this parameter in log files

setComponentParameter

public void setComponentParameter(String componentName,
                                  String parameterName,
                                  Object parameterValue,
                                  boolean protect)

Sets a component parameter, with a possibility to protect the parameter.

Parameters:

componentName - The Component's name

parameterName - The name of the parameter for the Component

parameterValue - The new value for the parameter

protect - If true, do not print the value of this parameter in log files

setRuntimeConnector

public void setRuntimeConnector(String connectorName,
                                ConnectorInterface runtimeConnector)

Sets the runtime connector for a named connector. If connectorName is null, the runtimeConnector is anonymous.

getRuntimeConnector

public ConnectorInterface getRuntimeConnector(String connectorName)

Returns the runtime connector for a named connector

setRuntimeFunction

public void setRuntimeFunction(String name,
                               FunctionInterface function)

Sets the runtime function for a named function. If name is null, the runtime function is anonymous.

getRuntimeFunction

public FunctionInterface getRuntimeFunction(String name)

Returns the runtime function for a named function

setRunMode

public void setRunMode(String value)

Sets the runmode.

Parameters:

value - The runmode to set. Legal values are "normal", "record", "playback", "manual" and "simulate".

getRunMode

public String getRunMode()

Returns the runmode

Returns:

The RunMode for this AssemblyLine, "normal" if not set

buildTCBEntry

public Entry buildTCBEntry(Entry input,
                           boolean inputMap)
                    throws Exception

Constructs a new Entry based on the parameter descriptors in params and source attributes in input entry.

Throws:

Exception

setAccumulator

public void setAccumulator(Object accumulator)

Set the accumulator object to the provided object. This must be an instance of java.util.Collection, ConnectorInterface, ParserInterface or AssemblyLineComponent.

Parameters:

accumulator - The Object to use as the accumulator object.

setAccumulatorObject

public void setAccumulatorObject(Object accumulator)

Set the accumulator object to the provided object.

See Also:

setAccumulator(Object )

accumulateEntry

public void accumulateEntry(Entry work)
                     throws Exception

Adds an entry to the accumulator object (if any configured).

Throws:

Exception

getStringProperty

public String getStringProperty(String propname,
                                String defval)

getIntProperty

public int getIntProperty(String propname,
                          int defval)
                   throws Exception

Throws:

Exception

getBoolProperty

public boolean getBoolProperty(String propname,
                               boolean defval)
                        throws Exception

Throws:

Exception

getAssemblyLineConfig

public AssemblyLineConfig getAssemblyLineConfig()

getALSettings

public Entry getALSettings()

Returns the Entry containing the user specified AL settings.

setALSetting

public void setALSetting(String paramname,
                         Object value)

Sets the AL Settings parameter to value. The settings are the AL config section where you can set things like debug level, max reads etc.

getALSetting

public Object getALSetting(String paramname)

Returns the AL Settings parameter to value. The settings are the AL config section where you can set things like debug level, max reads etc.

applyALSettings

public void applyALSettings(AssemblyLineConfig alc)

Applies the user defined AL settings to the AssemblyLineConfig. Also sets the components to enabled/disabled as specified by setComponentEnabled(). This method is used by AssemblyLine on a cloned AssemblyLineConfig.

Parameters:

alc - The AssemblyLineConfig to modify

See Also:

setComponentEnabled(String, boolean )

setALOperation

public void setALOperation(String operation)

Sets the AL Operation.

Parameters:

operation - The AL operations

getALOperation

public String getALOperation()

Returns the AL operation

Returns:

The operation for this AssemblyLine (null if not specified)

setOperationInitParams

public void setOperationInitParams(Entry params)

Sets the AL Operation initialize parameters. This call replaces all previous init params

Parameters:

params - The AL operations

setOperationInitParam

public void setOperationInitParam(String paramName,
                                  Object paramValue)

Sets an operation init parameter - this call creates the init param entry if not present and adds/replaces the param if one has already been set.

Parameters:

paramName - The name of the parameter

paramValue - The value for the parameter

getOperationInitParams

public Entry getOperationInitParams()

Returns the operation init parameters

Returns:

The operation init parameters ( an empty Entry if nothing is specified )

setComponentEnabled

public void setComponentEnabled(String name,
                                boolean enabled)

Set the named component to enabled or disabled status.

Parameters:

name - The name of the Component

enabled - True if this component should be enabled, false if it should be disabled

getALInitializationParameters

public SchemaConfig getALInitializationParameters()

Returns the SchemaConfig for the Published AssemblyLine Initialization Parameters.

Since:

7.0

getALOperations

public String[] getALOperations()

Returns a String[] with names of operations for the AssemblyLine.

Since:

7.0

getALOperationConfig

public OperationConfig getALOperationConfig()

Returns the AssemblyLine's OperationConfig for the current operation

Since:

7.0

getALOperationConfig

public OperationConfig getALOperationConfig(String name)

Returns the OperationConfig for the named operation in the AssemblyLine.

Parameters:

name - Name of the operation

Since:

7.0

clone

public TaskCallBlock clone()

Description copied from class: Entry

Creates a shallow clone of the receiver. The Hierarchical Attributes contained in the data structures however are complete clones.

Overrides:

clone in class Entry

Returns:

a clone of the receiver.