com.ibm.di.config.interfaces
Interface ConnectorConfig

All Superinterfaces:
BaseConfiguration, OperationsConfig, java.io.Serializable
All Known Subinterfaces:
ALMappingConfig, FunctionConfig
All Known Implementing Classes:
ALMappingConfigImpl, ConnectorConfigImpl, FunctionConfigImpl

public interface ConnectorConfig
extends BaseConfiguration, OperationsConfig

The configuration for a TDI Connector, e.g. used in an AssemblyLine.


Field Summary
static java.lang.String ADDONLY_MODE
          Constant for AddOnly mode.
static java.lang.String BRANCH_MODE
          Constant for Branch mode.
static java.lang.String CALL_REPLY_MODE
          Constant for Call Reply mode.
static int COMP_INIT_DEFAULT
          Component initialization option - 0
static int COMP_INIT_EVERYTIME
          Component initialization option -
static int COMP_INIT_MODIFIED
          Component initialization option - 2
static int COMP_INIT_USE
          Component initialization option - 1
static java.lang.String DELETE_MODE
          Constant for Delete mode.
static java.lang.String DELTA_MODE
          Constant for Delta mode.
static int DELTA_NO_DELETE
          Delta behavior - 1
static int DELTA_NORMAL
          Delta behavior - 0
static java.lang.String DISABLED_STATE
          Connector state -
static java.lang.String ENABLED_STATE
          Connector state -
static java.lang.String FUNCTION_MODE
          Constant for Function mode.
static java.lang.String INPUT_MAP_NAME
          Input map name
static java.lang.String ITERATOR_MODE
          Constant for Iterator mode.
static java.lang.String LOOKUP_MODE
          Constant for Lookup mode.
static java.lang.String MAPPING_MODE
          Constant for Mapping mode.
static java.lang.String OUTPUT_MAP_NAME
          Output map name
static java.lang.String PASSIVE_STATE
          Connector state -
static java.lang.String REPLY_MODE
          Constant for Reply mode.
static java.lang.String SCHEMA_INPUT
          The map name of the input schema
static java.lang.String SCHEMA_OUTPUT
          The map name of the output schema
static java.lang.String SCRIPT_MODE
          Constant for Script mode.
static java.lang.String SERVER_MODE
          Constant for Server mode.
static java.lang.String SERVER_OPTION_CONNECTOR
          Server option - "connector"
static java.lang.String SERVER_OPTION_ENTRY
          Server option - "entry"
static java.lang.String UPDATE_MODE
          Constant for Update mode.
 
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
 AttributeMapConfig getAttributeMap()
          Attribute Maps
 AttributeMapConfig getAttributeMap(boolean input)
          Gets the attributeMap attribute of the ConnectorConfig object
 AttributeMapConfig getAttributeMap(java.lang.Object name)
          Gets the attributeMap attribute of the ConnectorConfig object
 CheckpointConfig getCheckpointConfig()
          Deprecated. Checkpoint/restart is deprecated.
 boolean getComputeChanges()
          Returns the compute-changes flag for Update mode connector.
 RawConnectorConfig getConnectionConfig()
          Connection parameters
 java.lang.String getConnectorScript()
          Script connectors
 int getDeltaBehavior()
           
 DeltaConfig getDeltaConfig()
           
 boolean getDeltaStrict()
           
 boolean getEnabled()
          Enabled (typically used in the AssemblyLine)
 HooksConfig getHooks()
          Hooks
 int getInitializeOption()
           
 java.lang.String getLimitOption()
          Returns the Read Limit or Loop Limit for the Connector
 LinkCriteriaConfig getLinkCriteria()
          Link Criteria
 java.lang.String getMode()
           
 java.lang.String getOperationCarrier()
           
 boolean getOperationCarrierIsProperty()
           
 ParserConfig getParserConfig()
          Associated Parser configuration
 PoolDefConfig getPoolDefConfig()
           
 PoolInstanceConfig getPoolInstanceConfig()
           
 ReconnectConfig getReconnectConfig()
           
 boolean getReplyRequired()
           
 SandboxConfig getSandboxConfig()
           
 SchemaConfig getSchema(boolean input)
           
 SchemaConfig getSchema(java.lang.String name)
           
 java.lang.String getServerOption()
           
 boolean getSkipLookup()
          Gets the Skip Lookup option from the Connector.
 java.lang.String getState()
          State (typically used in the AssemblyLine)
 java.lang.String getSupportedModes()
          Returns the supported modes for this Connector.
 boolean isEntryFeed()
           
 void setAttributeMap(AttributeMapConfig attributeMap)
          Sets the attributeMap attribute of the ConnectorConfig object
 void setAttributeMap(AttributeMapConfig attributeMap, boolean input)
          Sets the attributeMap attribute of the ConnectorConfig object
 void setComputeChanges(boolean cc)
          Sets the compute-changes flag for Update mode connector.
 void setConnectorScript(java.lang.String script)
          Sets the connectorScript attribute of the ConnectorConfig object
 void setDeltaBehavior(int behavior)
          Sets delta behavior.
 void setDeltaStrict(boolean strict)
          Sets the delta strict flag.
 void setEnabled(boolean enabled)
          Sets the enabled attribute of the ConnectorConfig object
 void setInitializeOption(int option)
          This method sets the the initialization option for the component
 void setLimitOption(java.lang.String option)
          Sets the Read Limit or Loop Limit for the Connector
 void setLinkCriteria(LinkCriteriaConfig linkCriteria)
          Sets the linkCriteria attribute of the ConnectorConfig object
 void setMode(java.lang.String mode)
          Sets the mode attribute of the ConnectorConfig object
 void setOperationCarrier(java.lang.String name)
          This method sets the name of the operation carrier
 void setOperationCarrierIsProperty(boolean isproperty)
          This method sets whether the operation carrier is an entry attribute or entry property.
 void setParserConfig(ParserConfig parser)
          Sets the parserConfig attribute of the ConnectorConfig object
 void setSkipLookup(boolean skipLookup)
          Sets the Skip Lookup option to the Connector.
 void setState(java.lang.String state)
          Sets the state attribute of the ConnectorConfig object
 void setSupportedModes(java.lang.String modes)
          Sets the supported modes for this Connector
 boolean supportsSkipLookup()
          Checks whether the Connector supports Skip Lookup.
 
Methods inherited from interface com.ibm.di.config.interfaces.OperationsConfig
createOperation, getOperation, getOperations, getPublishedInitParams, setPublishedInitParams
 
Methods inherited from interface com.ibm.di.config.interfaces.BaseConfiguration
addListener, detachFromParent, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getClone, getData, getDataIterator, getDebug, getDebug, getDebugBreak, 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, setDebug, setDebugBreak, 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
 

Field Detail

SCHEMA_INPUT

static final java.lang.String SCHEMA_INPUT
The map name of the input schema

See Also:
Constant Field Values

SCHEMA_OUTPUT

static final java.lang.String SCHEMA_OUTPUT
The map name of the output schema

See Also:
Constant Field Values

ITERATOR_MODE

static final java.lang.String ITERATOR_MODE
Constant for Iterator mode. Used with the setMode(String) method.

See Also:
Constant Field Values

ADDONLY_MODE

static final java.lang.String ADDONLY_MODE
Constant for AddOnly mode. Used with the setMode(String) method.

See Also:
Constant Field Values

DELETE_MODE

static final java.lang.String DELETE_MODE
Constant for Delete mode. Used with the setMode(String) method.

See Also:
Constant Field Values

LOOKUP_MODE

static final java.lang.String LOOKUP_MODE
Constant for Lookup mode. Used with the setMode(String) method.

See Also:
Constant Field Values

UPDATE_MODE

static final java.lang.String UPDATE_MODE
Constant for Update mode. Used with the setMode(String) method.

See Also:
Constant Field Values

SCRIPT_MODE

static final java.lang.String SCRIPT_MODE
Constant for Script mode. Used with the setMode(String) method.

See Also:
Constant Field Values

CALL_REPLY_MODE

static final java.lang.String CALL_REPLY_MODE
Constant for Call Reply mode. Used with the setMode(String) method.

See Also:
Constant Field Values

SERVER_MODE

static final java.lang.String SERVER_MODE
Constant for Server mode. Used with the setMode(String) method.

See Also:
Constant Field Values

REPLY_MODE

static final java.lang.String REPLY_MODE
Constant for Reply mode. Used with the setMode(String) method.

See Also:
Constant Field Values

BRANCH_MODE

static final java.lang.String BRANCH_MODE
Constant for Branch mode. Used with the setMode(String) method.

See Also:
Constant Field Values

DELTA_MODE

static final java.lang.String DELTA_MODE
Constant for Delta mode. Used with the setMode(String) method.

See Also:
Constant Field Values

FUNCTION_MODE

static final java.lang.String FUNCTION_MODE
Constant for Function mode. Used with the setMode(String) method.

See Also:
Constant Field Values

MAPPING_MODE

static final java.lang.String MAPPING_MODE
Constant for Mapping mode. Used with the setMode(String) method.

See Also:
Constant Field Values

INPUT_MAP_NAME

static final java.lang.String INPUT_MAP_NAME
Input map name

See Also:
Constant Field Values

OUTPUT_MAP_NAME

static final java.lang.String OUTPUT_MAP_NAME
Output map name

See Also:
Constant Field Values

ENABLED_STATE

static final java.lang.String ENABLED_STATE
Connector state -

See Also:
Constant Field Values

PASSIVE_STATE

static final java.lang.String PASSIVE_STATE
Connector state -

See Also:
Constant Field Values

DISABLED_STATE

static final java.lang.String DISABLED_STATE
Connector state -

See Also:
Constant Field Values

DELTA_NORMAL

static final int DELTA_NORMAL
Delta behavior - 0

See Also:
Constant Field Values

DELTA_NO_DELETE

static final int DELTA_NO_DELETE
Delta behavior - 1

See Also:
Constant Field Values

SERVER_OPTION_ENTRY

static final java.lang.String SERVER_OPTION_ENTRY
Server option - "entry"

See Also:
Constant Field Values

SERVER_OPTION_CONNECTOR

static final java.lang.String SERVER_OPTION_CONNECTOR
Server option - "connector"

See Also:
Constant Field Values

COMP_INIT_DEFAULT

static final int COMP_INIT_DEFAULT
Component initialization option - 0

See Also:
Constant Field Values

COMP_INIT_USE

static final int COMP_INIT_USE
Component initialization option - 1

See Also:
Constant Field Values

COMP_INIT_MODIFIED

static final int COMP_INIT_MODIFIED
Component initialization option - 2

See Also:
Constant Field Values

COMP_INIT_EVERYTIME

static final int COMP_INIT_EVERYTIME
Component initialization option -

See Also:
Constant Field Values
Method Detail

getMode

java.lang.String getMode()
Returns:
Connector mode; if it is not set return default value of

setMode

void setMode(java.lang.String mode)
Sets the mode attribute of the ConnectorConfig object

Parameters:
mode - The new mode value

getSchema

SchemaConfig getSchema(java.lang.String name)
Parameters:
name - name of the schema
Returns:
a named Schema config

getSchema

SchemaConfig getSchema(boolean input)
Parameters:
input - input if true return Input schema else Output schema
Returns:
input or output schema config

getConnectorScript

java.lang.String getConnectorScript()
Script connectors

Returns:
The connectorScript value

setConnectorScript

void setConnectorScript(java.lang.String script)
Sets the connectorScript attribute of the ConnectorConfig object

Parameters:
script - The new connectorScript value

getAttributeMap

AttributeMapConfig getAttributeMap()
Attribute Maps

Returns:
The attributeMap value

setAttributeMap

void setAttributeMap(AttributeMapConfig attributeMap)
Sets the attributeMap attribute of the ConnectorConfig object

Parameters:
attributeMap - The new attributeMap value

getAttributeMap

AttributeMapConfig getAttributeMap(boolean input)
Gets the attributeMap attribute of the ConnectorConfig object

Parameters:
input - a boolean value specifying whether the input or output Attribute map to retrieve
Returns:
The attributeMap value

getAttributeMap

AttributeMapConfig getAttributeMap(java.lang.Object name)
Gets the attributeMap attribute of the ConnectorConfig object

Parameters:
name - the name of the Attribute map to retrieve
Returns:
The attributeMap value

setAttributeMap

void setAttributeMap(AttributeMapConfig attributeMap,
                     boolean input)
Sets the attributeMap attribute of the ConnectorConfig object

Parameters:
attributeMap - The new attributeMap value
input - The new attributeMap value

getLinkCriteria

LinkCriteriaConfig getLinkCriteria()
Link Criteria

Returns:
The linkCriteria value

setLinkCriteria

void setLinkCriteria(LinkCriteriaConfig linkCriteria)
Sets the linkCriteria attribute of the ConnectorConfig object

Parameters:
linkCriteria - The new linkCriteria value

getHooks

HooksConfig getHooks()
Hooks

Returns:
The hooks value

getConnectionConfig

RawConnectorConfig getConnectionConfig()
Connection parameters

Returns:
The connectionConfig value

getParserConfig

ParserConfig getParserConfig()
Associated Parser configuration

Returns:
The parserConfig value

setParserConfig

void setParserConfig(ParserConfig parser)
Sets the parserConfig attribute of the ConnectorConfig object

Parameters:
parser - The new parserConfig value

getState

java.lang.String getState()
State (typically used in the AssemblyLine)

Returns:
The configured state

setState

void setState(java.lang.String state)
Sets the state attribute of the ConnectorConfig object

Parameters:
state - The new state

getEnabled

boolean getEnabled()
Enabled (typically used in the AssemblyLine)

Specified by:
getEnabled in interface BaseConfiguration
Returns:
The enabled value

setEnabled

void setEnabled(boolean enabled)
Sets the enabled attribute of the ConnectorConfig object

Specified by:
setEnabled in interface BaseConfiguration
Parameters:
enabled - The new enabled value

getComputeChanges

boolean getComputeChanges()
Returns the compute-changes flag for Update mode connector.

Returns:
The enabled value

setComputeChanges

void setComputeChanges(boolean cc)
Sets the compute-changes flag for Update mode connector.

Parameters:
cc - The new enabled value

setSkipLookup

void setSkipLookup(boolean skipLookup)
Sets the Skip Lookup option to the Connector.

Parameters:
skipLookup - The new value of the Skip Lookup option.

getSkipLookup

boolean getSkipLookup()
Gets the Skip Lookup option from the Connector.

Returns:
true if Skip Lookup is enabled.

supportsSkipLookup

boolean supportsSkipLookup()
Checks whether the Connector supports Skip Lookup.

Returns:
true if the Connector supports Skip Lookup.

getDeltaConfig

DeltaConfig getDeltaConfig()
Returns:
the delta configuration

getPoolDefConfig

PoolDefConfig getPoolDefConfig()
Returns:
the Connector Pool definition configuration

getPoolInstanceConfig

PoolInstanceConfig getPoolInstanceConfig()
Returns:
the Connector Pool instance configuration

getCheckpointConfig

CheckpointConfig getCheckpointConfig()
Deprecated. Checkpoint/restart is deprecated.

Returns:
the checkpoint configuration.

getSandboxConfig

SandboxConfig getSandboxConfig()
Returns:
the checkpoint configuration.

getDeltaBehavior

int getDeltaBehavior()
Returns:
true if the connector uses delta behavior

setDeltaBehavior

void setDeltaBehavior(int behavior)
Sets delta behavior.

Parameters:
behavior -

getDeltaStrict

boolean getDeltaStrict()
Returns:
the delta strict flag

setDeltaStrict

void setDeltaStrict(boolean strict)
Sets the delta strict flag.

Parameters:
strict -

getServerOption

java.lang.String getServerOption()
Returns:
the server option (entry or connector) that determines whether the connector returns a connector instance or an entry in server mode.

getReplyRequired

boolean getReplyRequired()
Returns:
true if the connector requires a response in server or iterator mode.

isEntryFeed

boolean isEntryFeed()
Returns:
true if the connector is an entry feed connector

getOperationCarrier

java.lang.String getOperationCarrier()
Returns:
the name of the operation carrier

setOperationCarrier

void setOperationCarrier(java.lang.String name)
This method sets the name of the operation carrier

Parameters:
name -

getOperationCarrierIsProperty

boolean getOperationCarrierIsProperty()
Returns:
whether the operation carrier is an entry attribute or entry property

setOperationCarrierIsProperty

void setOperationCarrierIsProperty(boolean isproperty)
This method sets whether the operation carrier is an entry attribute or entry property.

Parameters:
isproperty -

getReconnectConfig

ReconnectConfig getReconnectConfig()
Returns:
the reconnect config

getInitializeOption

int getInitializeOption()
Returns:
the initialization option for the component

setInitializeOption

void setInitializeOption(int option)
This method sets the the initialization option for the component

Parameters:
option -

setLimitOption

void setLimitOption(java.lang.String option)
Sets the Read Limit or Loop Limit for the Connector

Parameters:
option - A string representing the number.
Since:
7.1.1

getLimitOption

java.lang.String getLimitOption()
Returns the Read Limit or Loop Limit for the Connector

Since:
7.1.1

getSupportedModes

java.lang.String getSupportedModes()
Returns the supported modes for this Connector.

Returns:
the supported modes, as a comma separated String
Since:
7.2

setSupportedModes

void setSupportedModes(java.lang.String modes)
Sets the supported modes for this Connector

Parameters:
modes - Supported modes as a comma separated String.
Since:
7.2