Package com.ibm.di.config.interfaces
Interface AssemblyLineConfig
-
- All Superinterfaces:
BaseConfiguration
,OperationsConfig
,java.io.Serializable
- All Known Implementing Classes:
AssemblyLineConfigImpl
public interface AssemblyLineConfig extends BaseConfiguration, OperationsConfig
The configuration for an AssemblyLine.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
INPUT_MAP_NAME
The name of the input mapstatic java.lang.String
OUTPUT_MAP_NAME
The name of the output map-
Fields inherited from interface com.ibm.di.config.interfaces.BaseConfiguration
CHILD_PATH_SEPARATOR, DISABLE_EXTPROPS, DISABLE_INHERITANCE, INHERIT_NONE, INHERIT_PARENT, ONE_LEVEL, RECURSIVE, RECURSIVE_ONELEVEL, RECURSIVE_SUBTREE, SEARCH_EXACTCASE, SEARCH_ONELEVEL, SEARCH_PARAMNAME, SEARCH_PARAMNAME_RE, SEARCH_PROPERTY, SEARCH_REGEX, SEARCH_SUBSTRING, SUBTREE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description ContainerConfig
addComponent(BaseConfiguration config)
This method adds a component configuration object to the correct component containerboolean
autoMapAllAttributes(java.lang.Object connectorName)
Returns the automap flag for the AssemblyLineboolean
containsComponent(java.lang.String name)
Returns true if there is component (data flow or entry feed) named nameAttributeMapConfig
getAttributeMap(boolean input)
Returns the AssemblyLine's attribute mapAttributeMapConfig
getAttributeMap(java.lang.String name)
Returns the AssemblyLine's attribute map by name ("Input"/"Output")CheckpointConfig
getCheckpointConfig()
Returns the Checkpoint info objectBaseConfiguration
getComponent(int position)
Deprecated.in TDI 7.0BaseConfiguration
getComponent(java.lang.String name)
Returns the component configurationBaseConfiguration
getComponentByName(java.lang.String name)
Deprecated.in TDI 7.0int
getComponentCount()
Deprecated.in TDI 7.0ContainerConfig
getComponents()
Deprecated.in TDI 7.0ConnectorConfig
getConnector(int position)
Returns the connector attribute of the AssemblyLineConfig objectConnectorConfig
getConnectorByName(java.lang.Object name)
Returns the connector attribute of the AssemblyLineConfig objectint
getConnectorCount()
Returns the number of connectors in the assemblylineContainerConfig
getDataFlowComponents()
Returns the data flow components containerboolean
getDebug()
Returns the debug flag for the AssemblyLine (default false)boolean
getDebug(boolean defval)
Returns the debug flag for the AssemblyLineContainerConfig
getEntryFeedComponents()
Returns the entry feed components containerHookConfig
getHook(java.lang.String name)
Returns a specific HookConfigHooksConfig
getHooks()
Returns the AssemblyLine's HooksConfigLogConfig
getLogConfig()
Returns the LogConfig objectSandboxConfig
getSandboxConfig()
Returns the Sandbox config objectSchemaConfig
getSchema(boolean input)
Returns the AssemblyLine's schemaSchemaConfig
getSchema(java.lang.String name)
Returns the AssemblyLine's schema by name ("Input"/"Output")BaseConfiguration
getSettings()
Returns the AssemblyLine SettingsSimulationConfig
getSimulationConfig()
Retrieves the Simulation Configuration which corresponds to the AssemblyLine.CallConfig
getTaskInputParameters()
Deprecated.Use getSchema(true)CallConfig
getTaskOutputParameters()
Deprecated.Use getSchema(false)PropertyConfig
getThreadOptions()
Returns the Thread options config in the AssemblyLine configurationvoid
insertComponent(BaseConfiguration connector, int position)
Deprecated.in TDI 7.0boolean
moveComponent(int position, boolean up)
Deprecated.in TDI 7.0void
removeComponent(int position)
Deprecated.in TDI 7.0void
removeComponent(BaseConfiguration component)
Removes a component from the assemblylinevoid
removeComponent(java.lang.String name)
This method removes a named component configuration objectvoid
renameComponent(java.lang.String name, java.lang.String newName)
Changes the local name of a connector (the name used in script engines etc )void
setDebug(boolean debug)
Sets the debug flag for the AssemblyLinevoid
setSettings(BaseConfiguration settings)
Sets the AssemblyLine Settings of the AssemblyLineConfig-
Methods inherited from interface com.ibm.di.config.interfaces.BaseConfiguration
addListener, detachFromParent, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getClone, getData, getDataIterator, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getMetamergeConfig, getModified, getModTS, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterRaw, getParent, getPath, getReferences, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, init, isExpression, isParameterLocal, isProtectedParameter, nameForChild, notifyChange, notifyChange, notifyChange, reattachToParent, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setModTS, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten
-
Methods inherited from interface com.ibm.di.config.interfaces.OperationsConfig
createOperation, getOperation, getOperations, getPublishedInitParams, setPublishedInitParams
-
-
-
-
Field Detail
-
INPUT_MAP_NAME
static final java.lang.String INPUT_MAP_NAME
The name of the input map- See Also:
- Constant Field Values
-
OUTPUT_MAP_NAME
static final java.lang.String OUTPUT_MAP_NAME
The name of the output map- See Also:
- Constant Field Values
-
-
Method Detail
-
getConnectorCount
int getConnectorCount()
Returns the number of connectors in the assemblyline- Returns:
- The connectorCount value
-
getConnectorByName
ConnectorConfig getConnectorByName(java.lang.Object name) throws java.lang.Exception
Returns the connector attribute of the AssemblyLineConfig object- Parameters:
name
- the name of the Connector for which to return the Connector configuration object- Returns:
- The connector configuration object.
- Throws:
java.lang.Exception
- if error occurs while retrieving the configuration object.
-
getConnector
ConnectorConfig getConnector(int position) throws java.lang.Exception
Returns the connector attribute of the AssemblyLineConfig object- Parameters:
position
- Connector position- Returns:
- The connector configuration object
- Throws:
java.lang.Exception
- if error occurs while retrieving the configuration object.
-
getComponentCount
@Deprecated int getComponentCount()
Deprecated.in TDI 7.0Returns the number of components in the assemblyline- Returns:
- The componentCount value
-
getComponents
@Deprecated ContainerConfig getComponents()
Deprecated.in TDI 7.0Returns the components container- Returns:
- The componentCount value
-
getComponentByName
@Deprecated BaseConfiguration getComponentByName(java.lang.String name) throws java.lang.Exception
Deprecated.in TDI 7.0Returns the component attribute of the AssemblyLineConfig object- Parameters:
name
- The name of the component to get.- Returns:
- The connector configuration object
- Throws:
java.lang.Exception
- never
-
getComponent
@Deprecated BaseConfiguration getComponent(int position) throws java.lang.Exception
Deprecated.in TDI 7.0Returns the component attribute of the AssemblyLineConfig object- Parameters:
position
- component position- Returns:
- The connector configuration object
- Throws:
java.lang.Exception
- never
-
removeComponent
@Deprecated void removeComponent(int position) throws java.lang.Exception
Deprecated.in TDI 7.0Removes a component from the assemblyline- Parameters:
position
- component position- Throws:
java.lang.Exception
- never
-
removeComponent
void removeComponent(BaseConfiguration component) throws java.lang.Exception
Removes a component from the assemblyline- Parameters:
component
- component config- Throws:
java.lang.Exception
- if error removing the component occurs.
-
insertComponent
@Deprecated void insertComponent(BaseConfiguration connector, int position) throws java.lang.Exception
Deprecated.in TDI 7.0Adds a connector configuration object to this assemblyline- Parameters:
connector
- The component configuration object to addposition
- The position of the connector or -1 to add the connector to the end- Throws:
java.lang.Exception
- never
-
moveComponent
@Deprecated boolean moveComponent(int position, boolean up)
Deprecated.in TDI 7.0Moves a connector one position up or down- Parameters:
position
- Current connector positionup
- Up (true) or down (false)- Returns:
- true if the operation succeeded
-
renameComponent
void renameComponent(java.lang.String name, java.lang.String newName) throws java.lang.Exception
Changes the local name of a connector (the name used in script engines etc )- Parameters:
name
- The current namenewName
- .New local name- Throws:
java.lang.Exception
- if the provided name is invalid or there is already a component with the specified name.
-
getHooks
HooksConfig getHooks()
Returns the AssemblyLine's HooksConfig- Returns:
- The hooks of this AssemblyLine
-
getHook
HookConfig getHook(java.lang.String name)
Returns a specific HookConfig- Parameters:
name
- The name of the hook- Returns:
- The HookConfig with the given name
-
getSettings
BaseConfiguration getSettings()
Returns the AssemblyLine Settings- Returns:
- The settings value
-
setSettings
void setSettings(BaseConfiguration settings)
Sets the AssemblyLine Settings of the AssemblyLineConfig- Parameters:
settings
- The new settings value
-
getTaskInputParameters
@Deprecated CallConfig getTaskInputParameters()
Deprecated.Use getSchema(true)Returns the AssemblyLine's input parameters (ref Task Call Block)- Returns:
- The taskInputParameters value
-
getTaskOutputParameters
@Deprecated CallConfig getTaskOutputParameters()
Deprecated.Use getSchema(false)Returns the AssemblyLine's output parameters (ref Task Call Block)- Returns:
- The taskOutputParameters value
-
getSchema
SchemaConfig getSchema(boolean input)
Returns the AssemblyLine's schema- Parameters:
input
- if true, returns the input schema- Returns:
- The schema object
-
getSchema
SchemaConfig getSchema(java.lang.String name)
Returns the AssemblyLine's schema by name ("Input"/"Output")- Parameters:
name
- the name of the schema config to retrieve- Returns:
- The schema config object
-
getAttributeMap
AttributeMapConfig getAttributeMap(boolean input)
Returns the AssemblyLine's attribute map- Parameters:
input
- if true, returns the input attribute map- Returns:
- The attribute map object
-
getAttributeMap
AttributeMapConfig getAttributeMap(java.lang.String name)
Returns the AssemblyLine's attribute map by name ("Input"/"Output")- Parameters:
name
- the name of the attribute map config to retrieve- Returns:
- The attribute map config object
-
getDebug
boolean getDebug()
Returns the debug flag for the AssemblyLine (default false)- Specified by:
getDebug
in interfaceBaseConfiguration
- Returns:
- The debug value
-
getDebug
boolean getDebug(boolean defval)
Returns the debug flag for the AssemblyLine- Specified by:
getDebug
in interfaceBaseConfiguration
- Parameters:
defval
- The default value- Returns:
- The debug value
-
setDebug
void setDebug(boolean debug)
Sets the debug flag for the AssemblyLine- Specified by:
setDebug
in interfaceBaseConfiguration
- Parameters:
debug
- The new debug value
-
autoMapAllAttributes
boolean autoMapAllAttributes(java.lang.Object connectorName) throws java.lang.Exception
Returns the automap flag for the AssemblyLine- Parameters:
connectorName
- The name of an AssemblyLine Component- Returns:
- true, if the AssemblyLine Component maps all the attributes
- Throws:
java.lang.Exception
- if the check does not succeed
-
getCheckpointConfig
CheckpointConfig getCheckpointConfig()
Returns the Checkpoint info object- Returns:
- The checkpointConfig value
-
getSandboxConfig
SandboxConfig getSandboxConfig()
Returns the Sandbox config object- Returns:
- the Sandbox config object
-
getLogConfig
LogConfig getLogConfig()
Returns the LogConfig object- Returns:
- The logConfig value
-
getThreadOptions
PropertyConfig getThreadOptions() throws java.lang.Exception
Returns the Thread options config in the AssemblyLine configuration- Returns:
- The threadOptions value
- Throws:
java.lang.Exception
- if the options could not be retrieved.
-
getEntryFeedComponents
ContainerConfig getEntryFeedComponents()
Returns the entry feed components container- Returns:
- The entry feed components value
-
getDataFlowComponents
ContainerConfig getDataFlowComponents()
Returns the data flow components container- Returns:
- The data flow components value
-
containsComponent
boolean containsComponent(java.lang.String name)
Returns true if there is component (data flow or entry feed) named name- Parameters:
name
- The name of the config- Returns:
- True if it exists
-
getComponent
BaseConfiguration getComponent(java.lang.String name)
Returns the component configuration- Parameters:
name
- The name of the config- Returns:
- Null if it does not exist else a BaseConfiguration subclass
-
addComponent
ContainerConfig addComponent(BaseConfiguration config)
This method adds a component configuration object to the correct component container- Parameters:
config
- The configuration object- Returns:
- The container to which it was added (either DataFlow or EntryFeed container) or NULL if the config object was invalid.
-
removeComponent
void removeComponent(java.lang.String name)
This method removes a named component configuration object- Parameters:
name
- The name of the component to remove.
-
getSimulationConfig
SimulationConfig getSimulationConfig() throws java.lang.Exception
Retrieves the Simulation Configuration which corresponds to the AssemblyLine.- Returns:
- SimulationConfig object which represents the Simulation Configuration of the current AssemblyLine.
- Throws:
java.lang.Exception
- if an error occurs while initializing the simulation config for the first time.
-
-